We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.EC2

Inherits:
AWS.Service show all
Identifier:
ec2
API Version:
2016-11-15
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information, see the Amazon EC2 Developer Guide.

Sending a Request Using EC2

var ec2 = new AWS.EC2();
ec2.applySecurityGroupsToClientVpnTargetNetwork(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the EC2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ec2 = new AWS.EC2({apiVersion: '2016-11-15'});

You can also set the API version globally in AWS.config.apiVersions using the ec2 service identifier:

AWS.config.apiVersions = {
  ec2: '2016-11-15',
  // other service API versions
};

var ec2 = new AWS.EC2();

Version:

  • 2016-11-15

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

instanceExists, bundleTaskComplete, conversionTaskCancelled, conversionTaskCompleted, conversionTaskDeleted, customerGatewayAvailable, exportTaskCancelled, exportTaskCompleted, imageExists, imageAvailable, instanceRunning, instanceStatusOk, instanceStopped, instanceTerminated, internetGatewayExists, keyPairExists, natGatewayAvailable, natGatewayDeleted, networkInterfaceAvailable, passwordDataAvailable, snapshotCompleted, snapshotImported, securityGroupExists, spotInstanceRequestFulfilled, storeImageTaskComplete, subnetAvailable, systemStatusOk, volumeAvailable, volumeDeleted, volumeInUse, vpcAvailable, vpcExists, vpnConnectionAvailable, vpnConnectionDeleted, vpcPeeringConnectionExists, vpcPeeringConnectionDeleted

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

new AWS.EC2(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a EC2 object

var ec2 = new AWS.EC2({apiVersion: '2016-11-15'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.EC2.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.EC2.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.EC2.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptAddressTransfer(params = {}, callback) ⇒ AWS.Request

Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.

Service Reference:

Examples:

Calling the acceptAddressTransfer operation

var params = {
  Address: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.acceptAddressTransfer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Address — (String)

      The Elastic IP address you are accepting for transfer.

    • TagSpecifications — (Array<map>)

      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.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AddressTransfer — (map)

        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 — (Date)

          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 — (Date)

          The timestamp when the Elastic IP address transfer was accepted.

        • AddressTransferStatus — (String)

          The Elastic IP address transfer status.

          Possible values include:
          • "pending"
          • "disabled"
          • "accepted"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptReservedInstancesExchangeQuote(params = {}, callback) ⇒ AWS.Request

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

Service Reference:

Examples:

Calling the acceptReservedInstancesExchangeQuote operation

var params = {
  ReservedInstanceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  TargetConfigurations: [
    {
      OfferingId: 'STRING_VALUE', /* required */
      InstanceCount: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
ec2.acceptReservedInstancesExchangeQuote(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.

    • TargetConfigurations — (Array<map>)

      The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.

      • 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 — required — (String)

        The Convertible Reserved Instance offering ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExchangeId — (String)

        The ID of the successful exchange.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptTransitGatewayMulticastDomainAssociations(params = {}, callback) ⇒ AWS.Request

Accepts a request to associate subnets with a transit gateway multicast domain.

Service Reference:

Examples:

Calling the acceptTransitGatewayMulticastDomainAssociations operation

var params = {
  DryRun: true || false,
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  TransitGatewayAttachmentId: 'STRING_VALUE',
  TransitGatewayMulticastDomainId: 'STRING_VALUE'
};
ec2.acceptTransitGatewayMulticastDomainAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayMulticastDomainId — (String)

      The ID of the transit gateway multicast domain.

    • TransitGatewayAttachmentId — (String)

      The ID of the transit gateway attachment.

    • SubnetIds — (Array<String>)

      The IDs of the subnets to associate with the transit gateway multicast domain.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Associations — (map)

        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.

          Possible values include:
          • "vpc"
          • "vpn"
          • "direct-connect-gateway"
          • "connect"
          • "peering"
          • "tgw-peering"
        • ResourceOwnerId — (String)

          The ID of the Amazon Web Services account that owns the resource.

        • Subnets — (Array<map>)

          The subnets associated with the multicast domain.

          • SubnetId — (String)

            The ID of the subnet.

          • State — (String)

            The state of the subnet association.

            Possible values include:
            • "pendingAcceptance"
            • "associating"
            • "associated"
            • "disassociating"
            • "disassociated"
            • "rejected"
            • "failed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptTransitGatewayPeeringAttachment(params = {}, callback) ⇒ AWS.Request

Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.

Service Reference:

Examples:

Calling the acceptTransitGatewayPeeringAttachment operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.acceptTransitGatewayPeeringAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayAttachmentId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayPeeringAttachment — (map)

        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 — (map)

          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 — (map)

          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 — (map)

          Details about the transit gateway peering attachment.

          • DynamicRouting — (String)

            Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.

            Possible values include:
            • "enable"
            • "disable"
        • Status — (map)

          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.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • CreationTime — (Date)

          The time the transit gateway peering attachment was created.

        • Tags — (Array<map>)

          The tags for the transit gateway peering attachment.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request

Accepts a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

Service Reference:

Examples:

Calling the acceptTransitGatewayVpcAttachment operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.acceptTransitGatewayVpcAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayVpcAttachment — (map)

        The 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.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • SubnetIds — (Array<String>)

          The IDs of the subnets.

        • CreationTime — (Date)

          The creation time.

        • Options — (map)

          The VPC attachment options.

          • DnsSupport — (String)

            Indicates whether DNS support is enabled.

            Possible values include:
            • "enable"
            • "disable"
          • SecurityGroupReferencingSupport — (String)
            Note: This parameter is in preview and may not be available for your account.

            Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

            Possible values include:
            • "enable"
            • "disable"
          • Ipv6Support — (String)

            Indicates whether IPv6 support is disabled.

            Possible values include:
            • "enable"
            • "disable"
          • ApplianceModeSupport — (String)

            Indicates whether appliance mode support is enabled.

            Possible values include:
            • "enable"
            • "disable"
        • Tags — (Array<map>)

          The tags for the VPC attachment.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptVpcEndpointConnections(params = {}, callback) ⇒ AWS.Request

Accepts connection requests to your VPC endpoint service.

Service Reference:

Examples:

Calling the acceptVpcEndpointConnections operation

var params = {
  ServiceId: 'STRING_VALUE', /* required */
  VpcEndpointIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.acceptVpcEndpointConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 VPC endpoint service.

    • VpcEndpointIds — (Array<String>)

      The IDs of the interface VPC endpoints.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Unsuccessful — (Array<map>)

        Information about the interface endpoints that were not accepted, if applicable.

        • Error — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

acceptVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the acceptVpcPeeringConnection operation

var params = {
  VpcPeeringConnectionId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.acceptVpcPeeringConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the VPC peering connection. You must specify this parameter in the request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcPeeringConnection — (map)

        Information about the VPC peering connection.

        • AccepterVpcInfo — (map)

          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 — (Array<map>)

            The IPv6 CIDR block for the VPC.

            • Ipv6CidrBlock — (String)

              The IPv6 CIDR block.

          • CidrBlockSet — (Array<map>)

            Information about the IPv4 CIDR blocks for the VPC.

            • CidrBlock — (String)

              The IPv4 CIDR block.

          • OwnerId — (String)

            The ID of the Amazon Web Services account that owns the VPC.

          • PeeringOptions — (map)

            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 — (Date)

          The time that an unaccepted VPC peering connection will expire.

        • RequesterVpcInfo — (map)

          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 — (Array<map>)

            The IPv6 CIDR block for the VPC.

            • Ipv6CidrBlock — (String)

              The IPv6 CIDR block.

          • CidrBlockSet — (Array<map>)

            Information about the IPv4 CIDR blocks for the VPC.

            • CidrBlock — (String)

              The IPv4 CIDR block.

          • OwnerId — (String)

            The ID of the Amazon Web Services account that owns the VPC.

          • PeeringOptions — (map)

            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 — (map)

          The status of the VPC peering connection.

          • Code — (String)

            The status of the VPC peering connection.

            Possible values include:
            • "initiating-request"
            • "pending-acceptance"
            • "active"
            • "deleted"
            • "rejected"
            • "failed"
            • "expired"
            • "provisioning"
            • "deleting"
          • Message — (String)

            A message that provides more information about the status, if applicable.

        • Tags — (Array<map>)

          Any tags assigned to the resource.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

advertiseByoipCidr(params = {}, callback) ⇒ AWS.Request

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

Service Reference:

Examples:

Calling the advertiseByoipCidr operation

var params = {
  Cidr: 'STRING_VALUE', /* required */
  Asn: 'STRING_VALUE',
  DryRun: true || false,
  NetworkBorderGroup: 'STRING_VALUE'
};
ec2.advertiseByoipCidr(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Cidr — (String)

      The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

    • Asn — (String)

      The public 2-byte or 4-byte ASN that you want to advertise.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ByoipCidr — (map)

        Information about the address range.

        • Cidr — (String)

          The address range, in CIDR notation.

        • Description — (String)

          The description of the address range.

        • AsnAssociations — (Array<map>)

          The BYOIP CIDR associations with ASNs.

          • 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.

            Possible values include:
            • "disassociated"
            • "failed-disassociation"
            • "failed-association"
            • "pending-disassociation"
            • "pending-association"
            • "associated"
        • 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.

          Possible values include:
          • "advertised"
          • "deprovisioned"
          • "failed-deprovision"
          • "failed-provision"
          • "pending-deprovision"
          • "pending-provision"
          • "provisioned"
          • "provisioned-not-publicly-advertisable"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

allocateAddress(params = {}, callback) ⇒ AWS.Request

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).

Service Reference:

Examples:

To allocate an Elastic IP address


/* This example allocates an Elastic IP address. */

 var params = {
 };
 ec2.allocateAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AllocationId: "eipalloc-64d5890a", 
    Domain: "vpc", 
    NetworkBorderGroup: "us-east-1", 
    PublicIp: "203.0.113.0", 
    PublicIpv4Pool: "amazon"
   }
   */
 });

Calling the allocateAddress operation

var params = {
  Address: 'STRING_VALUE',
  CustomerOwnedIpv4Pool: 'STRING_VALUE',
  Domain: vpc | standard,
  DryRun: true || false,
  IpamPoolId: 'STRING_VALUE',
  NetworkBorderGroup: 'STRING_VALUE',
  PublicIpv4Pool: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.allocateAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Domain — (String)

      The network (vpc).

      Possible values include:
      • "vpc"
      • "standard"
    • 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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      The tags to assign to the Elastic IP address.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PublicIp — (String)

        The Elastic IP address.

      • 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).

        Possible values include:
        • "vpc"
        • "standard"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

allocateHosts(params = {}, callback) ⇒ AWS.Request

Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.

Service Reference:

Examples:

Calling the allocateHosts operation

var params = {
  AvailabilityZone: 'STRING_VALUE', /* required */
  AssetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  AutoPlacement: on | off,
  ClientToken: 'STRING_VALUE',
  HostMaintenance: on | off,
  HostRecovery: on | off,
  InstanceFamily: 'STRING_VALUE',
  InstanceType: 'STRING_VALUE',
  OutpostArn: 'STRING_VALUE',
  Quantity: 'NUMBER_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.allocateHosts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AutoPlacement — (String)

      Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

      Default: off

      Possible values include:
      • "on"
      • "off"
    • AvailabilityZone — (String)

      The Availability Zone in which to allocate the Dedicated Host.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

    • InstanceType — (String)

      Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

      If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

    • InstanceFamily — (String)

      Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

      If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

    • Quantity — (Integer)

      The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.

    • TagSpecifications — (Array<map>)

      The tags to apply to the Dedicated Host during creation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

    • HostRecovery — (String)

      Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

      Default: off

      Possible values include:
      • "on"
      • "off"
    • OutpostArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify AssetIds.

      If you are allocating the Dedicated Host in a Region, omit this parameter.

    • 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.

      Possible values include:
      • "on"
      • "off"
    • AssetIds — (Array<String>)

      The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

      • If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.

      • If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostIds — (Array<String>)

        The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

allocateIpamPoolCidr(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the allocateIpamPoolCidr operation

var params = {
  IpamPoolId: 'STRING_VALUE', /* required */
  AllowedCidrs: [
    'STRING_VALUE',
    /* more items */
  ],
  Cidr: 'STRING_VALUE',
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DisallowedCidrs: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  NetmaskLength: 'NUMBER_VALUE',
  PreviewNextCidr: true || false
};
ec2.allocateIpamPoolCidr(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String)

      A description for the allocation.

    • PreviewNextCidr — (Boolean)

      A preview of the next available CIDR in a pool.

    • AllowedCidrs — (Array<String>)

      Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.

    • DisallowedCidrs — (Array<String>)

      Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamPoolAllocation — (map)

        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.

          Possible values include:
          • "ipam-pool"
          • "vpc"
          • "ec2-public-ipv4-pool"
          • "custom"
          • "subnet"
          • "eip"
        • ResourceRegion — (String)

          The Amazon Web Services Region of the resource.

        • ResourceOwner — (String)

          The owner of the resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

applySecurityGroupsToClientVpnTargetNetwork(params = {}, callback) ⇒ AWS.Request

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.

Service Reference:

Examples:

Calling the applySecurityGroupsToClientVpnTargetNetwork operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  SecurityGroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.applySecurityGroupsToClientVpnTargetNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint.

    • VpcId — (String)

      The ID of the VPC in which the associated target network is located.

    • SecurityGroupIds — (Array<String>)

      The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecurityGroupIds — (Array<String>)

        The IDs of the applied security groups.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

assignIpv6Addresses(params = {}, callback) ⇒ AWS.Request

Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type.

You must specify either the IPv6 addresses or the IPv6 address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the assignIpv6Addresses operation

var params = {
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  Ipv6AddressCount: 'NUMBER_VALUE',
  Ipv6Addresses: [
    'STRING_VALUE',
    /* more items */
  ],
  Ipv6PrefixCount: 'NUMBER_VALUE',
  Ipv6Prefixes: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.assignIpv6Addresses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Ipv6AddressCount — (Integer)

      The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

    • Ipv6Addresses — (Array<String>)

      The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

    • Ipv6PrefixCount — (Integer)

      The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.

    • Ipv6Prefixes — (Array<String>)

      One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

    • NetworkInterfaceId — (String)

      The ID of the network interface.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssignedIpv6Addresses — (Array<String>)

        The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses that were assigned to the network interface before the request are not included.

      • AssignedIpv6Prefixes — (Array<String>)

        The IPv6 prefixes that are assigned to the network interface.

      • NetworkInterfaceId — (String)

        The ID of the network interface.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

assignPrivateIpAddresses(params = {}, callback) ⇒ AWS.Request

Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For 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.

Service Reference:

Examples:

To assign a specific secondary private IP address to an interface


/* This example assigns the specified secondary private IP address to the specified network interface. */

 var params = {
  NetworkInterfaceId: "eni-e5aa89a3", 
  PrivateIpAddresses: [
     "10.0.0.82"
  ]
 };
 ec2.assignPrivateIpAddresses(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To assign secondary private IP addresses that Amazon EC2 selects to an interface


/* 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. */

 var params = {
  NetworkInterfaceId: "eni-e5aa89a3", 
  SecondaryPrivateIpAddressCount: 2
 };
 ec2.assignPrivateIpAddresses(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the assignPrivateIpAddresses operation

var params = {
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  AllowReassignment: true || false,
  Ipv4PrefixCount: 'NUMBER_VALUE',
  Ipv4Prefixes: [
    'STRING_VALUE',
    /* more items */
  ],
  PrivateIpAddresses: [
    'STRING_VALUE',
    /* more items */
  ],
  SecondaryPrivateIpAddressCount: 'NUMBER_VALUE'
};
ec2.assignPrivateIpAddresses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • NetworkInterfaceId — (String)

      The ID of the network interface.

    • PrivateIpAddresses — (Array<String>)

      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.

    • 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.

    • Ipv4Prefixes — (Array<String>)

      One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

    • Ipv4PrefixCount — (Integer)

      The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInterfaceId — (String)

        The ID of the network interface.

      • AssignedPrivateIpAddresses — (Array<map>)

        The private IP addresses assigned to the network interface.

        • PrivateIpAddress — (String)

          The private IP address assigned to the network interface.

      • AssignedIpv4Prefixes — (Array<map>)

        The IPv4 prefixes that are assigned to the network interface.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

assignPrivateNatGatewayAddress(params = {}, callback) ⇒ AWS.Request

Assigns private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.

Service Reference:

Examples:

Calling the assignPrivateNatGatewayAddress operation

var params = {
  NatGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  PrivateIpAddressCount: 'NUMBER_VALUE',
  PrivateIpAddresses: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.assignPrivateNatGatewayAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NatGatewayId — (String)

      The ID of the NAT gateway.

    • PrivateIpAddresses — (Array<String>)

      The private IPv4 addresses you want to assign to the private NAT gateway.

    • PrivateIpAddressCount — (Integer)

      The number of private IP addresses to assign to the NAT gateway. You can't specify this parameter when also specifying private IP addresses.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NatGatewayId — (String)

        The ID of the NAT gateway.

      • NatGatewayAddresses — (Array<map>)

        NAT gateway IP addresses.

        • 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.

          Possible values include:
          • "assigning"
          • "unassigning"
          • "associating"
          • "disassociating"
          • "succeeded"
          • "failed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateAddress(params = {}, callback) ⇒ AWS.Request

Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.

If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.

You cannot associate an Elastic IP address with an interface in a different network border group.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

Service Reference:

Examples:

To associate an Elastic IP address


/* This example associates the specified Elastic IP address with the specified instance. */

 var params = {
  AllocationId: "eipalloc-64d5890a", 
  InstanceId: "i-0b263919b6498b123"
 };
 ec2.associateAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AssociationId: "eipassoc-2bebb745"
   }
   */
 });

To associate an Elastic IP address with a network interface


/* This example associates the specified Elastic IP address with the specified network interface. */

 var params = {
  AllocationId: "eipalloc-64d5890a", 
  NetworkInterfaceId: "eni-1a2b3c4d"
 };
 ec2.associateAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AssociationId: "eipassoc-2bebb745"
   }
   */
 });

Calling the associateAddress operation

var params = {
  AllocationId: 'STRING_VALUE',
  AllowReassociation: true || false,
  DryRun: true || false,
  InstanceId: 'STRING_VALUE',
  NetworkInterfaceId: 'STRING_VALUE',
  PrivateIpAddress: 'STRING_VALUE',
  PublicIp: 'STRING_VALUE'
};
ec2.associateAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • 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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssociationId — (String)

        The ID that represents the association of the Elastic IP address with an instance.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateClientVpnTargetNetwork(params = {}, callback) ⇒ AWS.Request

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

Service Reference:

Examples:

Calling the associateClientVpnTargetNetwork operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  SubnetId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false
};
ec2.associateClientVpnTargetNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint.

    • SubnetId — (String)

      The ID of the subnet to associate with the Client VPN endpoint.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssociationId — (String)

        The unique ID of the target network association.

      • Status — (map)

        The current state of the target network association.

        • Code — (String)

          The state of the target network association.

          Possible values include:
          • "associating"
          • "associated"
          • "association-failed"
          • "disassociating"
          • "disassociated"
        • Message — (String)

          A message about the status of the target network association, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateDhcpOptions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To associate a DHCP options set with a VPC


/* This example associates the specified DHCP options set with the specified VPC. */

 var params = {
  DhcpOptionsId: "dopt-d9070ebb", 
  VpcId: "vpc-a01106c2"
 };
 ec2.associateDhcpOptions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

To associate the default DHCP options set with a VPC


/* This example associates the default DHCP options set with the specified VPC. */

 var params = {
  DhcpOptionsId: "default", 
  VpcId: "vpc-a01106c2"
 };
 ec2.associateDhcpOptions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the associateDhcpOptions operation

var params = {
  DhcpOptionsId: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.associateDhcpOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DhcpOptionsId — (String)

      The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

    • VpcId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateEnclaveCertificateIamRole(params = {}, callback) ⇒ AWS.Request

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.

Service Reference:

Examples:

Calling the associateEnclaveCertificateIamRole operation

var params = {
  CertificateArn: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.associateEnclaveCertificateIamRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      The ARN of the ACM certificate with which to associate the IAM role.

    • RoleArn — (String)

      The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CertificateS3BucketName — (String)

        The name of the Amazon S3 bucket to which the certificate was uploaded.

      • CertificateS3ObjectKey — (String)

        The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn/certificate_arn.

      • EncryptionKmsKeyId — (String)

        The ID of the KMS key used to encrypt the private key of the certificate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateIamInstanceProfile(params = {}, callback) ⇒ AWS.Request

Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.

Service Reference:

Examples:

To associate an IAM instance profile with an instance


/* This example associates an IAM instance profile named admin-role with the specified instance. */

 var params = {
  IamInstanceProfile: {
   Name: "admin-role"
  }, 
  InstanceId: "i-123456789abcde123"
 };
 ec2.associateIamInstanceProfile(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    IamInstanceProfileAssociation: {
     AssociationId: "iip-assoc-0e7736511a163c209", 
     IamInstanceProfile: {
      Arn: "arn:aws:iam::123456789012:instance-profile/admin-role", 
      Id: "AIPAJBLK7RKJKWDXVHIEC"
     }, 
     InstanceId: "i-123456789abcde123", 
     State: "associating"
    }
   }
   */
 });

Calling the associateIamInstanceProfile operation

var params = {
  IamInstanceProfile: { /* required */
    Arn: 'STRING_VALUE',
    Name: 'STRING_VALUE'
  },
  InstanceId: 'STRING_VALUE' /* required */
};
ec2.associateIamInstanceProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IamInstanceProfile — (map)

      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)

      The ID of the instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IamInstanceProfileAssociation — (map)

        Information about the IAM instance profile association.

        • AssociationId — (String)

          The ID of the association.

        • InstanceId — (String)

          The ID of the instance.

        • IamInstanceProfile — (map)

          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.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"
        • Timestamp — (Date)

          The time the IAM instance profile was associated with the instance.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateInstanceEventWindow(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the associateInstanceEventWindow operation

var params = {
  AssociationTarget: { /* required */
    DedicatedHostIds: [
      'STRING_VALUE',
      /* more items */
    ],
    InstanceIds: [
      'STRING_VALUE',
      /* more items */
    ],
    InstanceTags: [
      {
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  InstanceEventWindowId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.associateInstanceEventWindow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the event window.

    • AssociationTarget — (map)

      One or more targets associated with the specified event window.

      • InstanceIds — (Array<String>)

        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.

      • InstanceTags — (Array<map>)

        The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<String>)

        The IDs of the Dedicated Hosts to associate with the event window.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceEventWindow — (map)

        Information about the event window.

        • InstanceEventWindowId — (String)

          The ID of the event window.

        • TimeRanges — (Array<map>)

          One or more time ranges defined for the event window.

          • StartWeekDay — (String)

            The day on which the time range begins.

            Possible values include:
            • "sunday"
            • "monday"
            • "tuesday"
            • "wednesday"
            • "thursday"
            • "friday"
            • "saturday"
          • StartHour — (Integer)

            The hour when the time range begins.

          • EndWeekDay — (String)

            The day on which the time range ends.

            Possible values include:
            • "sunday"
            • "monday"
            • "tuesday"
            • "wednesday"
            • "thursday"
            • "friday"
            • "saturday"
          • 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 — (map)

          One or more targets associated with the event window.

          • InstanceIds — (Array<String>)

            The IDs of the instances associated with the event window.

          • Tags — (Array<map>)

            The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window.

            • Key — (String)

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<String>)

            The IDs of the Dedicated Hosts associated with the event window.

        • State — (String)

          The current state of the event window.

          Possible values include:
          • "creating"
          • "deleting"
          • "active"
          • "deleted"
        • Tags — (Array<map>)

          The instance tags associated with the event window.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateIpamByoasn(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the associateIpamByoasn operation

var params = {
  Asn: 'STRING_VALUE', /* required */
  Cidr: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.associateIpamByoasn(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      A public 2-byte or 4-byte ASN.

    • Cidr — (String)

      The BYOIP CIDR you want to associate with an ASN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AsnAssociation — (map)

        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.

          Possible values include:
          • "disassociated"
          • "failed-disassociation"
          • "failed-association"
          • "pending-disassociation"
          • "pending-association"
          • "associated"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateIpamResourceDiscovery(params = {}, callback) ⇒ AWS.Request

Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Service Reference:

Examples:

Calling the associateIpamResourceDiscovery operation

var params = {
  IpamId: 'STRING_VALUE', /* required */
  IpamResourceDiscoveryId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.associateIpamResourceDiscovery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      An IPAM ID.

    • IpamResourceDiscoveryId — (String)

      A resource discovery ID.

    • TagSpecifications — (Array<map>)

      Tag specifications.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 client token.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamResourceDiscoveryAssociation — (map)

        A resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM.

        • 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.

          Possible values include:
          • "active"
          • "not-found"
        • 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.

          Possible values include:
          • "associate-in-progress"
          • "associate-complete"
          • "associate-failed"
          • "disassociate-in-progress"
          • "disassociate-complete"
          • "disassociate-failed"
          • "isolate-in-progress"
          • "isolate-complete"
          • "restore-in-progress"
        • Tags — (Array<map>)

          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.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateNatGatewayAddress(params = {}, callback) ⇒ AWS.Request

Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.

By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.

When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.

Service Reference:

Examples:

Calling the associateNatGatewayAddress operation

var params = {
  AllocationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  NatGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  PrivateIpAddresses: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.associateNatGatewayAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NatGatewayId — (String)

      The ID of the NAT gateway.

    • AllocationIds — (Array<String>)

      The allocation IDs of EIPs that you want to associate with your NAT gateway.

    • PrivateIpAddresses — (Array<String>)

      The private IPv4 addresses that you want to assign to the NAT 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NatGatewayId — (String)

        The ID of the NAT gateway.

      • NatGatewayAddresses — (Array<map>)

        The IP addresses.

        • 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.

          Possible values include:
          • "assigning"
          • "unassigning"
          • "associating"
          • "disassociating"
          • "succeeded"
          • "failed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateRouteTable(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To associate a route table with a subnet


/* This example associates the specified route table with the specified subnet. */

 var params = {
  RouteTableId: "rtb-22574640", 
  SubnetId: "subnet-9d4a7b6"
 };
 ec2.associateRouteTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AssociationId: "rtbassoc-781d0d1a"
   }
   */
 });

Calling the associateRouteTable operation

var params = {
  RouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  GatewayId: 'STRING_VALUE',
  SubnetId: 'STRING_VALUE'
};
ec2.associateRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the route table.

    • SubnetId — (String)

      The ID of the subnet.

    • GatewayId — (String)

      The ID of the internet gateway or virtual private gateway.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssociationId — (String)

        The route table association ID. This ID is required for disassociating the route table.

      • AssociationState — (map)

        The state of the association.

        • State — (String)

          The state of the association.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"
          • "failed"
        • StatusMessage — (String)

          The status message, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateSubnetCidrBlock(params = {}, callback) ⇒ AWS.Request

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet.

Service Reference:

Examples:

Calling the associateSubnetCidrBlock operation

var params = {
  SubnetId: 'STRING_VALUE', /* required */
  Ipv6CidrBlock: 'STRING_VALUE',
  Ipv6IpamPoolId: 'STRING_VALUE',
  Ipv6NetmaskLength: 'NUMBER_VALUE'
};
ec2.associateSubnetCidrBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Ipv6CidrBlock — (String)

      The IPv6 CIDR block for your subnet.

    • SubnetId — (String)

      The ID of your subnet.

    • Ipv6IpamPoolId — (String)

      An IPv6 IPAM pool ID.

    • Ipv6NetmaskLength — (Integer)

      An IPv6 netmask length.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Ipv6CidrBlockAssociation — (map)

        Information about the IPv6 association.

        • AssociationId — (String)

          The ID of the association.

        • Ipv6CidrBlock — (String)

          The IPv6 CIDR block.

        • Ipv6CidrBlockState — (map)

          The state of the CIDR block.

          • State — (String)

            The state of a CIDR block.

            Possible values include:
            • "associating"
            • "associated"
            • "disassociating"
            • "disassociated"
            • "failing"
            • "failed"
          • 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.

          Possible values include:
          • "public"
          • "private"
        • 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.

          Possible values include:
          • "amazon"
          • "byoip"
          • "none"
      • SubnetId — (String)

        The ID of the subnet.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateTransitGatewayMulticastDomain(params = {}, callback) ⇒ AWS.Request

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.

Service Reference:

Examples:

Calling the associateTransitGatewayMulticastDomain operation

var params = {
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  TransitGatewayMulticastDomainId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.associateTransitGatewayMulticastDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayMulticastDomainId — (String)

      The ID of the transit gateway multicast domain.

    • TransitGatewayAttachmentId — (String)

      The ID of the transit gateway attachment to associate with the transit gateway multicast domain.

    • SubnetIds — (Array<String>)

      The IDs of the subnets to associate with the transit gateway multicast domain.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Associations — (map)

        Information about the transit gateway 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.

          Possible values include:
          • "vpc"
          • "vpn"
          • "direct-connect-gateway"
          • "connect"
          • "peering"
          • "tgw-peering"
        • ResourceOwnerId — (String)

          The ID of the Amazon Web Services account that owns the resource.

        • Subnets — (Array<map>)

          The subnets associated with the multicast domain.

          • SubnetId — (String)

            The ID of the subnet.

          • State — (String)

            The state of the subnet association.

            Possible values include:
            • "pendingAcceptance"
            • "associating"
            • "associated"
            • "disassociating"
            • "disassociated"
            • "rejected"
            • "failed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateTransitGatewayPolicyTable(params = {}, callback) ⇒ AWS.Request

Associates the specified transit gateway attachment with a transit gateway policy table.

Service Reference:

Examples:

Calling the associateTransitGatewayPolicyTable operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  TransitGatewayPolicyTableId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.associateTransitGatewayPolicyTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayPolicyTableId — (String)

      The ID of the transit gateway policy table to associate with the transit gateway attachment.

    • TransitGatewayAttachmentId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Association — (map)

        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.

          Possible values include:
          • "vpc"
          • "vpn"
          • "direct-connect-gateway"
          • "connect"
          • "peering"
          • "tgw-peering"
        • State — (String)

          The state of the transit gateway policy table association.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateTransitGatewayRouteTable(params = {}, callback) ⇒ AWS.Request

Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.

Service Reference:

Examples:

Calling the associateTransitGatewayRouteTable operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  TransitGatewayRouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.associateTransitGatewayRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayRouteTableId — (String)

      The ID of the transit gateway 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Association — (map)

        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.

          Possible values include:
          • "vpc"
          • "vpn"
          • "direct-connect-gateway"
          • "connect"
          • "peering"
          • "tgw-peering"
        • State — (String)

          The state of the association.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateTrunkInterface(params = {}, callback) ⇒ AWS.Request

Associates a branch network interface with a trunk network interface.

Before you create the association, use CreateNetworkInterface command and set the interface type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

Service Reference:

Examples:

Calling the associateTrunkInterface operation

var params = {
  BranchInterfaceId: 'STRING_VALUE', /* required */
  TrunkInterfaceId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  GreKey: 'NUMBER_VALUE',
  VlanId: 'NUMBER_VALUE'
};
ec2.associateTrunkInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BranchInterfaceId — (String)

      The ID of the branch network interface.

    • TrunkInterfaceId — (String)

      The ID of the trunk network interface.

    • VlanId — (Integer)

      The ID of the VLAN. This applies to the VLAN protocol.

    • GreKey — (Integer)

      The application key. This applies to the GRE protocol.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InterfaceAssociation — (map)

        Information about the association between the trunk network interface and branch 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.

          Possible values include:
          • "VLAN"
          • "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 — (Array<map>)

          The tags for the trunk interface association.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateVpcCidrBlock(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the associateVpcCidrBlock operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  AmazonProvidedIpv6CidrBlock: true || false,
  CidrBlock: 'STRING_VALUE',
  Ipv4IpamPoolId: 'STRING_VALUE',
  Ipv4NetmaskLength: 'NUMBER_VALUE',
  Ipv6CidrBlock: 'STRING_VALUE',
  Ipv6CidrBlockNetworkBorderGroup: 'STRING_VALUE',
  Ipv6IpamPoolId: 'STRING_VALUE',
  Ipv6NetmaskLength: 'NUMBER_VALUE',
  Ipv6Pool: 'STRING_VALUE'
};
ec2.associateVpcCidrBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • CidrBlock — (String)

      An IPv4 CIDR block to associate with the VPC.

    • VpcId — (String)

      The ID of 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Ipv6CidrBlockAssociation — (map)

        Information about the IPv6 CIDR block association.

        • AssociationId — (String)

          The association ID for the IPv6 CIDR block.

        • Ipv6CidrBlock — (String)

          The IPv6 CIDR block.

        • Ipv6CidrBlockState — (map)

          Information about the state of the CIDR block.

          • State — (String)

            The state of the CIDR block.

            Possible values include:
            • "associating"
            • "associated"
            • "disassociating"
            • "disassociated"
            • "failing"
            • "failed"
          • 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.

          Possible values include:
          • "public"
          • "private"
        • 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.

          Possible values include:
          • "amazon"
          • "byoip"
          • "none"
      • CidrBlockAssociation — (map)

        Information about the IPv4 CIDR block association.

        • AssociationId — (String)

          The association ID for the IPv4 CIDR block.

        • CidrBlock — (String)

          The IPv4 CIDR block.

        • CidrBlockState — (map)

          Information about the state of the CIDR block.

          • State — (String)

            The state of the CIDR block.

            Possible values include:
            • "associating"
            • "associated"
            • "disassociating"
            • "disassociated"
            • "failing"
            • "failed"
          • StatusMessage — (String)

            A message about the status of the CIDR block, if applicable.

      • VpcId — (String)

        The ID of the VPC.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachClassicLinkVpc(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the attachClassicLinkVpc operation

var params = {
  Groups: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.attachClassicLinkVpc(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • Groups — (Array<String>)

      The IDs of the security groups. You cannot specify security groups from a different VPC.

    • InstanceId — (String)

      The ID of the EC2-Classic instance.

    • VpcId — (String)

      The ID of the ClassicLink-enabled VPC.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds; otherwise, it returns an error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachInternetGateway(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To attach an Internet gateway to a VPC


/* This example attaches the specified Internet gateway to the specified VPC. */

 var params = {
  InternetGatewayId: "igw-c0a643a9", 
  VpcId: "vpc-a01106c2"
 };
 ec2.attachInternetGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the attachInternetGateway operation

var params = {
  InternetGatewayId: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.attachInternetGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the internet gateway.

    • VpcId — (String)

      The ID of the VPC.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachNetworkInterface(params = {}, callback) ⇒ AWS.Request

Attaches a network interface to an instance.

Service Reference:

Examples:

To attach a network interface to an instance


/* This example attaches the specified network interface to the specified instance. */

 var params = {
  DeviceIndex: 1, 
  InstanceId: "i-1234567890abcdef0", 
  NetworkInterfaceId: "eni-e5aa89a3"
 };
 ec2.attachNetworkInterface(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AttachmentId: "eni-attach-66c4350a"
   }
   */
 });

Calling the attachNetworkInterface operation

var params = {
  DeviceIndex: 'NUMBER_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  EnaSrdSpecification: {
    EnaSrdEnabled: true || false,
    EnaSrdUdpSpecification: {
      EnaSrdUdpEnabled: true || false
    }
  },
  NetworkCardIndex: 'NUMBER_VALUE'
};
ec2.attachNetworkInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceIndex — (Integer)

      The index of the device for the network interface 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.

    • InstanceId — (String)

      The ID of the instance.

    • NetworkInterfaceId — (String)

      The ID of the network interface.

    • 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 — (map)

      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 — (map)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AttachmentId — (String)

        The ID of the network interface attachment.

      • NetworkCardIndex — (Integer)

        The index of the network card.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachVerifiedAccessTrustProvider(params = {}, callback) ⇒ AWS.Request

Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.

Service Reference:

Examples:

Calling the attachVerifiedAccessTrustProvider operation

var params = {
  VerifiedAccessInstanceId: 'STRING_VALUE', /* required */
  VerifiedAccessTrustProviderId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false
};
ec2.attachVerifiedAccessTrustProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VerifiedAccessInstanceId — (String)

      The ID of the Verified Access instance.

    • VerifiedAccessTrustProviderId — (String)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedAccessTrustProvider — (map)

        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.

          Possible values include:
          • "user"
          • "device"
        • UserTrustProviderType — (String)

          The type of user-based trust provider.

          Possible values include:
          • "iam-identity-center"
          • "oidc"
        • DeviceTrustProviderType — (String)

          The type of device-based trust provider.

          Possible values include:
          • "jamf"
          • "crowdstrike"
          • "jumpcloud"
        • OidcOptions — (map)

          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 — (map)

          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 — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

      • VerifiedAccessInstance — (map)

        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 — (Array<map>)

          The IDs of the Amazon Web Services Verified Access trust providers.

          • 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).

            Possible values include:
            • "user"
            • "device"
          • UserTrustProviderType — (String)

            The type of user-based trust provider.

            Possible values include:
            • "iam-identity-center"
            • "oidc"
          • DeviceTrustProviderType — (String)

            The type of device-based trust provider.

            Possible values include:
            • "jamf"
            • "crowdstrike"
            • "jumpcloud"
        • CreationTime — (String)

          The creation time.

        • LastUpdatedTime — (String)

          The last updated time.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachVolume(params = {}, callback) ⇒ AWS.Request

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

After you attach an EBS volume, you must make it available. 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.

Service Reference:

Examples:

To attach a volume to an instance


/* This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``. */

 var params = {
  Device: "/dev/sdf", 
  InstanceId: "i-01474ef662b89480", 
  VolumeId: "vol-1234567890abcdef0"
 };
 ec2.attachVolume(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AttachTime: <Date Representation>, 
    Device: "/dev/sdf", 
    InstanceId: "i-01474ef662b89480", 
    State: "attaching", 
    VolumeId: "vol-1234567890abcdef0"
   }
   */
 });

Calling the attachVolume operation

var params = {
  Device: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  VolumeId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.attachVolume(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Device — (String)

      The device name (for example, /dev/sdh or xvdh).

    • InstanceId — (String)

      The ID of the instance.

    • VolumeId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AttachTime — (Date)

        The time stamp when the attachment initiated.

      • Device — (String)

        The device name.

        If the volume is attached to a Fargate task, this parameter returns null.

      • InstanceId — (String)

        The ID of the instance.

        If the volume is attached to a Fargate task, this parameter returns null.

      • State — (String)

        The attachment state of the volume.

        Possible values include:
        • "attaching"
        • "attached"
        • "detaching"
        • "detached"
        • "busy"
      • VolumeId — (String)

        The ID of the volume.

      • DeleteOnTermination — (Boolean)

        Indicates whether the EBS volume is deleted on instance termination.

      • AssociatedResource — (String)

        The ARN of the Amazon ECS or Fargate task to which the volume is attached.

      • InstanceOwningService — (String)

        The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.

        This parameter is returned only for volumes that are attached to Fargate tasks.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

attachVpnGateway(params = {}, callback) ⇒ AWS.Request

Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Service Reference:

Examples:

Calling the attachVpnGateway operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  VpnGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.attachVpnGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VpcId — (String)

      The ID of the VPC.

    • VpnGatewayId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcAttachment — (map)

        Information about the attachment.

        • State — (String)

          The current state of the attachment.

          Possible values include:
          • "attaching"
          • "attached"
          • "detaching"
          • "detached"
        • VpcId — (String)

          The ID of the VPC.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeClientVpnIngress(params = {}, callback) ⇒ AWS.Request

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.

Service Reference:

Examples:

Calling the authorizeClientVpnIngress operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  TargetNetworkCidr: 'STRING_VALUE', /* required */
  AccessGroupId: 'STRING_VALUE',
  AuthorizeAllGroups: true || false,
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false
};
ec2.authorizeClientVpnIngress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint.

    • TargetNetworkCidr — (String)

      The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

    • AccessGroupId — (String)

      The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.

    • AuthorizeAllGroups — (Boolean)

      Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.

    • Description — (String)

      A brief description of the authorization rule.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (map)

        The current state of the authorization rule.

        • Code — (String)

          The state of the authorization rule.

          Possible values include:
          • "authorizing"
          • "active"
          • "failed"
          • "revoking"
        • Message — (String)

          A message about the status of the authorization rule, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeSecurityGroupEgress(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To add a rule that allows outbound traffic to a specific address range


/* This example adds a rule that grants access to the specified address ranges on TCP port 80. */

 var params = {
  GroupId: "sg-1a2b3c4d", 
  IpPermissions: [
     {
    FromPort: 80, 
    IpProtocol: "tcp", 
    IpRanges: [
       {
      CidrIp: "10.0.0.0/16"
     }
    ], 
    ToPort: 80
   }
  ]
 };
 ec2.authorizeSecurityGroupEgress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To add a rule that allows outbound traffic to a specific security group


/* This example adds a rule that grants access to the specified security group on TCP port 80. */

 var params = {
  GroupId: "sg-1a2b3c4d", 
  IpPermissions: [
     {
    FromPort: 80, 
    IpProtocol: "tcp", 
    ToPort: 80, 
    UserIdGroupPairs: [
       {
      GroupId: "sg-4b51a32f"
     }
    ]
   }
  ]
 };
 ec2.authorizeSecurityGroupEgress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the authorizeSecurityGroupEgress operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  CidrIp: 'STRING_VALUE',
  DryRun: true || false,
  FromPort: 'NUMBER_VALUE',
  IpPermissions: [
    {
      FromPort: 'NUMBER_VALUE',
      IpProtocol: 'STRING_VALUE',
      IpRanges: [
        {
          CidrIp: 'STRING_VALUE',
          Description: 'STRING_VALUE'
        },
        /* more items */
      ],
      Ipv6Ranges: [
        {
          CidrIpv6: 'STRING_VALUE',
          Description: 'STRING_VALUE'
        },
        /* more items */
      ],
      PrefixListIds: [
        {
          Description: 'STRING_VALUE',
          PrefixListId: 'STRING_VALUE'
        },
        /* more items */
      ],
      ToPort: 'NUMBER_VALUE',
      UserIdGroupPairs: [
        {
          Description: 'STRING_VALUE',
          GroupId: 'STRING_VALUE',
          GroupName: 'STRING_VALUE',
          PeeringStatus: 'STRING_VALUE',
          UserId: 'STRING_VALUE',
          VpcId: 'STRING_VALUE',
          VpcPeeringConnectionId: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  IpProtocol: 'STRING_VALUE',
  SourceSecurityGroupName: 'STRING_VALUE',
  SourceSecurityGroupOwnerId: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  ToPort: 'NUMBER_VALUE'
};
ec2.authorizeSecurityGroupEgress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

    • IpPermissions — (Array<map>)

      The permissions for the security group rules.

      • 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).

      • 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.

      • IpRanges — (Array<map>)

        The IPv4 address ranges.

        • 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.

        • 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 ._-:/()#,@[]+=&;{}!$*

      • Ipv6Ranges — (Array<map>)

        The IPv6 address ranges.

        • 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.

        • 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 ._-:/()#,@[]+=&;{}!$*

      • PrefixListIds — (Array<map>)

        The prefix list IDs.

        • 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.

      • 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 — (Array<map>)

        The security group and Amazon Web Services account ID pairs.

        • 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 ._-:/()#,@[]+=;{}!$*

        • GroupId — (String)

          The ID of the security group.

        • 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.

        • PeeringStatus — (String)

          The status of a VPC peering connection, if applicable.

        • 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.

        • 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.

    • TagSpecifications — (Array<map>)

      The tags applied to the security group rule.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

    • CidrIp — (String)

      Not supported. Use IP permissions instead.

    • FromPort — (Integer)

      Not supported. Use IP permissions instead.

    • IpProtocol — (String)

      Not supported. Use IP permissions instead.

    • ToPort — (Integer)

      Not supported. Use IP permissions instead.

    • SourceSecurityGroupName — (String)

      Not supported. Use IP permissions instead.

    • SourceSecurityGroupOwnerId — (String)

      Not supported. Use IP permissions instead.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds; otherwise, returns an error.

      • SecurityGroupRules — (Array<map>)

        Information about the outbound (egress) security group rules that were added.

        • 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 — (map)

          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 — (Array<map>)

          The tags applied to the security group rule.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To add a rule that allows inbound SSH traffic from an IPv4 address range


/* This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later. */

 var params = {
  GroupId: "sg-903004f8", 
  IpPermissions: [
     {
    FromPort: 22, 
    IpProtocol: "tcp", 
    IpRanges: [
       {
      CidrIp: "203.0.113.0/24", 
      Description: "SSH access from the LA office"
     }
    ], 
    ToPort: 22
   }
  ]
 };
 ec2.authorizeSecurityGroupIngress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To add a rule that allows inbound HTTP traffic from another security group


/* This example enables inbound traffic on TCP port 80 from the specified security group. The group must be in the same VPC or a peer VPC. Incoming traffic is allowed based on the private IP addresses of instances that are associated with the specified security group. */

 var params = {
  GroupId: "sg-111aaa22", 
  IpPermissions: [
     {
    FromPort: 80, 
    IpProtocol: "tcp", 
    ToPort: 80, 
    UserIdGroupPairs: [
       {
      Description: "HTTP access from other instances", 
      GroupId: "sg-1a2b3c4d"
     }
    ]
   }
  ]
 };
 ec2.authorizeSecurityGroupIngress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To add a rule that allows inbound RDP traffic from an IPv6 address range


/* This example adds an inbound rule that allows RDP traffic from the specified IPv6 address range. The rule includes a description to help you identify it later. */

 var params = {
  GroupId: "sg-123abc12 ", 
  IpPermissions: [
     {
    FromPort: 3389, 
    IpProtocol: "tcp", 
    Ipv6Ranges: [
       {
      CidrIpv6: "2001:db8:1234:1a00::/64", 
      Description: "RDP access from the NY office"
     }
    ], 
    ToPort: 3389
   }
  ]
 };
 ec2.authorizeSecurityGroupIngress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the authorizeSecurityGroupIngress operation

var params = {
  CidrIp: 'STRING_VALUE',
  DryRun: true || false,
  FromPort: 'NUMBER_VALUE',
  GroupId: 'STRING_VALUE',
  GroupName: 'STRING_VALUE',
  IpPermissions: [
    {
      FromPort: 'NUMBER_VALUE',
      IpProtocol: 'STRING_VALUE',
      IpRanges: [
        {
          CidrIp: 'STRING_VALUE',
          Description: 'STRING_VALUE'
        },
        /* more items */
      ],
      Ipv6Ranges: [
        {
          CidrIpv6: 'STRING_VALUE',
          Description: 'STRING_VALUE'
        },
        /* more items */
      ],
      PrefixListIds: [
        {
          Description: 'STRING_VALUE',
          PrefixListId: 'STRING_VALUE'
        },
        /* more items */
      ],
      ToPort: 'NUMBER_VALUE',
      UserIdGroupPairs: [
        {
          Description: 'STRING_VALUE',
          GroupId: 'STRING_VALUE',
          GroupName: 'STRING_VALUE',
          PeeringStatus: 'STRING_VALUE',
          UserId: 'STRING_VALUE',
          VpcId: 'STRING_VALUE',
          VpcPeeringConnectionId: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  IpProtocol: 'STRING_VALUE',
  SourceSecurityGroupName: 'STRING_VALUE',
  SourceSecurityGroupOwnerId: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  ToPort: 'NUMBER_VALUE'
};
ec2.authorizeSecurityGroupIngress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CidrIp — (String)

      The IPv4 address range, in CIDR format.

      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.

    • GroupId — (String)

      The ID of the security group.

    • 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 — (Array<map>)

      The permissions for the security group rules.

      • 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).

      • 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.

      • IpRanges — (Array<map>)

        The IPv4 address ranges.

        • 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.

        • 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 ._-:/()#,@[]+=&;{}!$*

      • Ipv6Ranges — (Array<map>)

        The IPv6 address ranges.

        • 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.

        • 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 ._-:/()#,@[]+=&;{}!$*

      • PrefixListIds — (Array<map>)

        The prefix list IDs.

        • 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.

      • 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 — (Array<map>)

        The security group and Amazon Web Services account ID pairs.

        • 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 ._-:/()#,@[]+=;{}!$*

        • GroupId — (String)

          The ID of the security group.

        • 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.

        • PeeringStatus — (String)

          The status of a VPC peering connection, if applicable.

        • 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.

        • 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.

    • 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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      The tags applied to the security group rule.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds; otherwise, returns an error.

      • SecurityGroupRules — (Array<map>)

        Information about the inbound (ingress) security group rules that were added.

        • 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 — (map)

          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 — (Array<map>)

          The tags applied to the security group rule.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

bundleInstance(params = {}, callback) ⇒ AWS.Request

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:) is bundled. Data on other instance store volumes is not preserved.

Note: This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

Service Reference:

Examples:

Calling the bundleInstance operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Storage: { /* required */
    S3: {
      AWSAccessKeyId: 'STRING_VALUE',
      Bucket: 'STRING_VALUE',
      Prefix: 'STRING_VALUE',
      UploadPolicy: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      UploadPolicySignature: 'STRING_VALUE'
    }
  },
  DryRun: true || false
};
ec2.bundleInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InstanceId — (String)

      The ID of the instance to bundle.

      Default: None

    • Storage — (map)

      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.

      • S3 — (map)

        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 — (Buffer, Typed Array, Blob, String)

          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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BundleTask — (map)

        Information about the bundle task.

        • BundleId — (String)

          The ID of the bundle task.

        • BundleTaskError — (map)

          If the task fails, a description of the error.

          • Code — (String)

            The error code.

          • Message — (String)

            The error message.

        • InstanceId — (String)

          The ID of the instance associated with this bundle task.

        • Progress — (String)

          The level of task completion, as a percent (for example, 20%).

        • StartTime — (Date)

          The time this task started.

        • State — (String)

          The state of the task.

          Possible values include:
          • "pending"
          • "waiting-for-shutdown"
          • "bundling"
          • "storing"
          • "cancelling"
          • "complete"
          • "failed"
        • Storage — (map)

          The Amazon S3 storage locations.

          • S3 — (map)

            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 — (Buffer, Typed Array, Blob, String)

              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.

        • UpdateTime — (Date)

          The time of the most recent update for the task.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelBundleTask(params = {}, callback) ⇒ AWS.Request

Cancels a bundling operation for an instance store-backed Windows instance.

Service Reference:

Examples:

Calling the cancelBundleTask operation

var params = {
  BundleId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.cancelBundleTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BundleId — (String)

      The ID of the bundle 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BundleTask — (map)

        Information about the bundle task.

        • BundleId — (String)

          The ID of the bundle task.

        • BundleTaskError — (map)

          If the task fails, a description of the error.

          • Code — (String)

            The error code.

          • Message — (String)

            The error message.

        • InstanceId — (String)

          The ID of the instance associated with this bundle task.

        • Progress — (String)

          The level of task completion, as a percent (for example, 20%).

        • StartTime — (Date)

          The time this task started.

        • State — (String)

          The state of the task.

          Possible values include:
          • "pending"
          • "waiting-for-shutdown"
          • "bundling"
          • "storing"
          • "cancelling"
          • "complete"
          • "failed"
        • Storage — (map)

          The Amazon S3 storage locations.

          • S3 — (map)

            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 — (Buffer, Typed Array, Blob, String)

              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.

        • UpdateTime — (Date)

          The time of the most recent update for the task.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelCapacityReservation(params = {}, callback) ⇒ AWS.Request

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled.

Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.

Service Reference:

Examples:

Calling the cancelCapacityReservation operation

var params = {
  CapacityReservationId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.cancelCapacityReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CapacityReservationId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds; otherwise, it returns an error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelCapacityReservationFleets(params = {}, callback) ⇒ AWS.Request

Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:

  • The Capacity Reservation Fleet's status changes to cancelled.

  • The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.

  • The Fleet stops creating new Capacity Reservations.

Service Reference:

Examples:

Calling the cancelCapacityReservationFleets operation

var params = {
  CapacityReservationFleetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.cancelCapacityReservationFleets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • CapacityReservationFleetIds — (Array<String>)

      The IDs of the Capacity Reservation Fleets to cancel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SuccessfulFleetCancellations — (Array<map>)

        Information about the Capacity Reservation Fleets that were successfully cancelled.

        • CurrentFleetState — (String)

          The current state of the Capacity Reservation Fleet.

          Possible values include:
          • "submitted"
          • "modifying"
          • "active"
          • "partially_fulfilled"
          • "expiring"
          • "expired"
          • "cancelling"
          • "cancelled"
          • "failed"
        • PreviousFleetState — (String)

          The previous state of the Capacity Reservation Fleet.

          Possible values include:
          • "submitted"
          • "modifying"
          • "active"
          • "partially_fulfilled"
          • "expiring"
          • "expired"
          • "cancelling"
          • "cancelled"
          • "failed"
        • CapacityReservationFleetId — (String)

          The ID of the Capacity Reservation Fleet that was successfully cancelled.

      • FailedFleetCancellations — (Array<map>)

        Information about the Capacity Reservation Fleets that could not be cancelled.

        • CapacityReservationFleetId — (String)

          The ID of the Capacity Reservation Fleet that could not be cancelled.

        • CancelCapacityReservationFleetError — (map)

          Information about the Capacity Reservation Fleet cancellation error.

          • Code — (String)

            The error code.

          • Message — (String)

            The error message.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelConversionTask(params = {}, callback) ⇒ AWS.Request

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

Service Reference:

Examples:

Calling the cancelConversionTask operation

var params = {
  ConversionTaskId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  ReasonMessage: 'STRING_VALUE'
};
ec2.cancelConversionTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConversionTaskId — (String)

      The ID of the conversion 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.

    • ReasonMessage — (String)

      The reason for canceling the conversion task.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelExportTask(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the cancelExportTask operation

var params = {
  ExportTaskId: 'STRING_VALUE' /* required */
};
ec2.cancelExportTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ExportTaskId — (String)

      The ID of the export task. This is the ID returned by the CreateInstanceExportTask and ExportImage operations.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelImageLaunchPermission(params = {}, callback) ⇒ AWS.Request

Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the cancelImageLaunchPermission operation

var params = {
  ImageId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.cancelImageLaunchPermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ImageId — (String)

      The ID of the AMI that was shared with your Amazon Web Services 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds; otherwise, it returns an error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelImportTask(params = {}, callback) ⇒ AWS.Request

Cancels an in-process import virtual machine or import snapshot task.

Service Reference:

Examples:

Calling the cancelImportTask operation

var params = {
  CancelReason: 'STRING_VALUE',
  DryRun: true || false,
  ImportTaskId: 'STRING_VALUE'
};
ec2.cancelImportTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelReservedInstancesListing(params = {}, callback) ⇒ AWS.Request

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the cancelReservedInstancesListing operation

var params = {
  ReservedInstancesListingId: 'STRING_VALUE' /* required */
};
ec2.cancelReservedInstancesListing(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservedInstancesListingId — (String)

      The ID of the Reserved Instance listing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReservedInstancesListings — (Array<map>)

        The 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 — (Date)

          The time the listing was created.

        • InstanceCounts — (Array<map>)

          The number of instances in this 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.

            Possible values include:
            • "available"
            • "sold"
            • "cancelled"
            • "pending"
        • PriceSchedules — (Array<map>)

          The price of the Reserved Instance listing.

          • 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.

            Possible values include:
            • "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.

          Possible values include:
          • "active"
          • "pending"
          • "cancelled"
          • "closed"
        • StatusMessage — (String)

          The reason for the current status of the Reserved Instance listing. The response can be blank.

        • Tags — (Array<map>)

          Any tags assigned to the resource.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Date)

          The last modified timestamp of the listing.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelSpotFleetRequests(params = {}, callback) ⇒ AWS.Request

Cancels the specified Spot Fleet requests.

After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.

You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

Restrictions

  • You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.

Service Reference:

Examples:

To cancel a Spot fleet request


/* This example cancels the specified Spot fleet request and terminates its associated Spot Instances. */

 var params = {
  SpotFleetRequestIds: [
     "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
  ], 
  TerminateInstances: true
 };
 ec2.cancelSpotFleetRequests(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SuccessfulFleetRequests: [
       {
      CurrentSpotFleetRequestState: "cancelled_running", 
      PreviousSpotFleetRequestState: "active", 
      SpotFleetRequestId: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
     }
    ]
   }
   */
 });

To cancel a Spot fleet request without terminating its Spot Instances


/* This example cancels the specified Spot fleet request without terminating its associated Spot Instances. */

 var params = {
  SpotFleetRequestIds: [
     "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
  ], 
  TerminateInstances: false
 };
 ec2.cancelSpotFleetRequests(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SuccessfulFleetRequests: [
       {
      CurrentSpotFleetRequestState: "cancelled_terminating", 
      PreviousSpotFleetRequestState: "active", 
      SpotFleetRequestId: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
     }
    ]
   }
   */
 });

Calling the cancelSpotFleetRequests operation

var params = {
  SpotFleetRequestIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TerminateInstances: true || false, /* required */
  DryRun: true || false
};
ec2.cancelSpotFleetRequests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the Spot Fleet requests.

      Constraint: You can specify up to 100 IDs in a single request.

    • TerminateInstances — (Boolean)

      Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. The default is to terminate the instances.

      To let the instances continue to run after the Spot Fleet request is canceled, specify no-terminate-instances.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SuccessfulFleetRequests — (Array<map>)

        Information about the Spot Fleet requests that are successfully canceled.

        • CurrentSpotFleetRequestState — (String)

          The current state of the Spot Fleet request.

          Possible values include:
          • "submitted"
          • "active"
          • "cancelled"
          • "failed"
          • "cancelled_running"
          • "cancelled_terminating"
          • "modifying"
        • PreviousSpotFleetRequestState — (String)

          The previous state of the Spot Fleet request.

          Possible values include:
          • "submitted"
          • "active"
          • "cancelled"
          • "failed"
          • "cancelled_running"
          • "cancelled_terminating"
          • "modifying"
        • SpotFleetRequestId — (String)

          The ID of the Spot Fleet request.

      • UnsuccessfulFleetRequests — (Array<map>)

        Information about the Spot Fleet requests that are not successfully canceled.

        • Error — (map)

          The error.

          • Code — (String)

            The error code.

            Possible values include:
            • "fleetRequestIdDoesNotExist"
            • "fleetRequestIdMalformed"
            • "fleetRequestNotInCancellableState"
            • "unexpectedError"
          • Message — (String)

            The description for the error code.

        • SpotFleetRequestId — (String)

          The ID of the Spot Fleet request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelSpotInstanceRequests(params = {}, callback) ⇒ AWS.Request

Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

Service Reference:

Examples:

To cancel Spot Instance requests


/* This example cancels a Spot Instance request. */

 var params = {
  SpotInstanceRequestIds: [
     "sir-08b93456"
  ]
 };
 ec2.cancelSpotInstanceRequests(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CancelledSpotInstanceRequests: [
       {
      SpotInstanceRequestId: "sir-08b93456", 
      State: "cancelled"
     }
    ]
   }
   */
 });

Calling the cancelSpotInstanceRequests operation

var params = {
  SpotInstanceRequestIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.cancelSpotInstanceRequests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the Spot Instance requests.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CancelledSpotInstanceRequests — (Array<map>)

        The Spot Instance requests.

        • SpotInstanceRequestId — (String)

          The ID of the Spot Instance request.

        • State — (String)

          The state of the Spot Instance request.

          Possible values include:
          • "active"
          • "open"
          • "closed"
          • "cancelled"
          • "completed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

confirmProductInstance(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To confirm the product instance


/* This example determines whether the specified product code is associated with the specified instance. */

 var params = {
  InstanceId: "i-1234567890abcdef0", 
  ProductCode: "774F4FF8"
 };
 ec2.confirmProductInstance(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    OwnerId: "123456789012"
   }
   */
 });

Calling the confirmProductInstance operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ProductCode: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.confirmProductInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InstanceId — (String)

      The ID of the instance.

    • ProductCode — (String)

      The product code. This must be a product code 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

copyFpgaImage(params = {}, callback) ⇒ AWS.Request

Copies the specified Amazon FPGA Image (AFI) to the current Region.

Service Reference:

Examples:

Calling the copyFpgaImage operation

var params = {
  SourceFpgaImageId: 'STRING_VALUE', /* required */
  SourceRegion: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  Name: 'STRING_VALUE'
};
ec2.copyFpgaImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • SourceFpgaImageId — (String)

      The ID of the source AFI.

    • Description — (String)

      The description for the new AFI.

    • Name — (String)

      The name for the new AFI. The default is the name of the source AFI.

    • SourceRegion — (String)

      The Region that contains the source AFI.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FpgaImageId — (String)

        The ID of the new AFI.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

copyImage(params = {}, callback) ⇒ AWS.Request

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 AMI in the Amazon EC2 User Guide.

Service Reference:

Examples:

To copy an AMI to another region


/* This example copies the specified AMI from the us-east-1 region to the current region. */

 var params = {
  Description: "", 
  Name: "My server", 
  SourceImageId: "ami-5731123e", 
  SourceRegion: "us-east-1"
 };
 ec2.copyImage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ImageId: "ami-438bea42"
   }
   */
 });

Calling the copyImage operation

var params = {
  Name: 'STRING_VALUE', /* required */
  SourceImageId: 'STRING_VALUE', /* required */
  SourceRegion: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  CopyImageTags: true || false,
  Description: 'STRING_VALUE',
  DestinationOutpostArn: 'STRING_VALUE',
  DryRun: true || false,
  Encrypted: true || false,
  KmsKeyId: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.copyImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

    • Description — (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)

      The name of the new AMI in the destination Region.

    • SourceImageId — (String)

      The ID of the AMI to copy.

    • SourceRegion — (String)

      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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • 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 — (Array<map>)

      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.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageId — (String)

        The ID of the new AMI.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

copySnapshot(params = {}, callback) ⇒ AWS.Request

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, 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.

Service Reference:

Examples:

To copy a snapshot


/* This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot. */

 var params = {
  Description: "This is my copied snapshot.", 
  DestinationRegion: "us-east-1", 
  SourceRegion: "us-west-2", 
  SourceSnapshotId: "snap-066877671789bd71b"
 };
 ec2.copySnapshot(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SnapshotId: "snap-066877671789bd71b"
   }
   */
 });

Calling the copySnapshot operation

var params = {
  SourceRegion: 'STRING_VALUE', /* required */
  SourceSnapshotId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DestinationOutpostArn: 'STRING_VALUE',
  DestinationRegion: 'STRING_VALUE',
  DryRun: true || false,
  Encrypted: true || false,
  KmsKeyId: 'STRING_VALUE',
  PresignedUrl: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.copySnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • 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.

    • SourceRegion — (String)

      The ID of the Region that contains the snapshot to be copied.

    • SourceSnapshotId — (String)

      The ID of the EBS snapshot to copy.

    • TagSpecifications — (Array<map>)

      The tags to apply to the new snapshot.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotId — (String)

        The ID of the new snapshot.

      • Tags — (Array<map>)

        Any tags applied to the new snapshot.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCapacityReservation(params = {}, callback) ⇒ AWS.Request

Creates a new Capacity Reservation with the specified attributes.

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.

Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the createCapacityReservation operation

var params = {
  InstanceCount: 'NUMBER_VALUE', /* required */
  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, /* required */
  InstanceType: 'STRING_VALUE', /* required */
  AvailabilityZone: 'STRING_VALUE',
  AvailabilityZoneId: 'STRING_VALUE',
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  EbsOptimized: true || false,
  EndDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  EndDateType: unlimited | limited,
  EphemeralStorage: true || false,
  InstanceMatchCriteria: open | targeted,
  OutpostArn: 'STRING_VALUE',
  PlacementGroupArn: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Tenancy: default | dedicated
};
ec2.createCapacityReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

    • InstanceType — (String)

      The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

    • InstancePlatform — (String)

      The type of operating system for which to reserve capacity.

      Possible values include:
      • "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)

      The Availability Zone in which to create the Capacity Reservation.

    • AvailabilityZoneId — (String)

      The ID of the Availability Zone in which to create the Capacity Reservation.

    • 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.

      Possible values include:
      • "default"
      • "dedicated"
    • InstanceCount — (Integer)

      The number of instances for which to reserve capacity.

      Valid range: 1 - 1000

    • 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.

    • EndDate — (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.

      You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

      If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

    • EndDateType — (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 if the EndDateType is unlimited.

      • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

      Possible values include:
      • "unlimited"
      • "limited"
    • InstanceMatchCriteria — (String)

      Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

      • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

      • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

      Default: open

      Possible values include:
      • "open"
      • "targeted"
    • TagSpecifications — (Array<map>)

      The tags to apply to the Capacity Reservation during launch.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

    • OutpostArn — (String)

      The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

    • PlacementGroupArn — (String)

      The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CapacityReservation — (map)

        Information about 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.

          Possible values include:
          • "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)

          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.

          Possible values include:
          • "default"
          • "dedicated"
        • 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 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.

          Possible values include:
          • "active"
          • "expired"
          • "cancelled"
          • "pending"
          • "failed"
          • "scheduled"
          • "payment-pending"
          • "payment-failed"
        • StartDate — (Date)

          The date and time at which the Capacity Reservation was started.

        • EndDate — (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.

        • 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.

          Possible values include:
          • "unlimited"
          • "limited"
        • 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.

          Possible values include:
          • "open"
          • "targeted"
        • CreateDate — (Date)

          The date and time at which the Capacity Reservation was created.

        • Tags — (Array<map>)

          Any tags assigned to the Capacity Reservation.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

          Information about instance capacity usage.

          • AllocationType — (String)

            The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.

            Possible values include:
            • "used"
          • 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.

          Possible values include:
          • "default"
          • "capacity-block"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCapacityReservationBySplitting(params = {}, callback) ⇒ AWS.Request

Create a new Capacity Reservation by splitting the available 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.

Service Reference:

Examples:

Calling the createCapacityReservationBySplitting operation

var params = {
  InstanceCount: 'NUMBER_VALUE', /* required */
  SourceCapacityReservationId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createCapacityReservationBySplitting(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • SourceCapacityReservationId — (String)

      The ID of the Capacity Reservation from which you want to split the available capacity.

    • InstanceCount — (Integer)

      The number of instances to split from the source Capacity Reservation.

    • TagSpecifications — (Array<map>)

      The tags to apply to the new Capacity Reservation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SourceCapacityReservation — (map)

        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.

          Possible values include:
          • "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)

          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.

          Possible values include:
          • "default"
          • "dedicated"
        • 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 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.

          Possible values include:
          • "active"
          • "expired"
          • "cancelled"
          • "pending"
          • "failed"
          • "scheduled"
          • "payment-pending"
          • "payment-failed"
        • StartDate — (Date)

          The date and time at which the Capacity Reservation was started.

        • EndDate — (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.

        • 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.

          Possible values include:
          • "unlimited"
          • "limited"
        • 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.

          Possible values include:
          • "open"
          • "targeted"
        • CreateDate — (Date)

          The date and time at which the Capacity Reservation was created.

        • Tags — (Array<map>)

          Any tags assigned to the Capacity Reservation.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

          Information about instance capacity usage.

          • AllocationType — (String)

            The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.

            Possible values include:
            • "used"
          • 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.

          Possible values include:
          • "default"
          • "capacity-block"
      • DestinationCapacityReservation — (map)

        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.

          Possible values include:
          • "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)

          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.

          Possible values include:
          • "default"
          • "dedicated"
        • 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 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.

          Possible values include:
          • "active"
          • "expired"
          • "cancelled"
          • "pending"
          • "failed"
          • "scheduled"
          • "payment-pending"
          • "payment-failed"
        • StartDate — (Date)

          The date and time at which the Capacity Reservation was started.

        • EndDate — (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.

        • 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.

          Possible values include:
          • "unlimited"
          • "limited"
        • 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.

          Possible values include:
          • "open"
          • "targeted"
        • CreateDate — (Date)

          The date and time at which the Capacity Reservation was created.

        • Tags — (Array<map>)

          Any tags assigned to the Capacity Reservation.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

          Information about instance capacity usage.

          • AllocationType — (String)

            The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.

            Possible values include:
            • "used"
          • 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.

          Possible values include:
          • "default"
          • "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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCapacityReservationFleet(params = {}, callback) ⇒ AWS.Request

Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the createCapacityReservationFleet operation

var params = {
  InstanceTypeSpecifications: [ /* required */
    {
      AvailabilityZone: 'STRING_VALUE',
      AvailabilityZoneId: 'STRING_VALUE',
      EbsOptimized: true || false,
      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,
      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,
      Priority: 'NUMBER_VALUE',
      Weight: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  TotalTargetCapacity: 'NUMBER_VALUE', /* required */
  AllocationStrategy: 'STRING_VALUE',
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  EndDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  InstanceMatchCriteria: open,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Tenancy: default
};
ec2.createCapacityReservationFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • InstanceTypeSpecifications — (Array<map>)

      Information about the instance types for which to reserve the capacity.

      • InstanceType — (String)

        The instance type for which the Capacity Reservation Fleet reserves capacity.

        Possible values include:
        • "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"
      • InstancePlatform — (String)

        The type of operating system for which the Capacity Reservation Fleet reserves capacity.

        Possible values include:
        • "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 — (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.

      Possible values include:
      • "default"
    • 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 — (Date)

      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.

      Possible values include:
      • "open"
    • TagSpecifications — (Array<map>)

      The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CapacityReservationFleetId — (String)

        The ID of the Capacity Reservation Fleet.

      • State — (String)

        The status of the Capacity Reservation Fleet.

        Possible values include:
        • "submitted"
        • "modifying"
        • "active"
        • "partially_fulfilled"
        • "expiring"
        • "expired"
        • "cancelling"
        • "cancelled"
        • "failed"
      • 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.

        Possible values include:
        • "open"
      • AllocationStrategy — (String)

        The allocation strategy used by the Capacity Reservation Fleet.

      • CreateTime — (Date)

        The date and time at which the Capacity Reservation Fleet was created.

      • EndDate — (Date)

        The date and time at which the Capacity Reservation Fleet expires.

      • Tenancy — (String)

        Indicates the tenancy of Capacity Reservation Fleet.

        Possible values include:
        • "default"
      • FleetCapacityReservations — (Array<map>)

        Information about the individual Capacity Reservations in the 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.

          Possible values include:
          • "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"
        • InstancePlatform — (String)

          The type of operating system for which the Capacity Reservation reserves capacity.

          Possible values include:
          • "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)

          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 — (Date)

          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 — (Array<map>)

        The tags assigned to the Capacity Reservation Fleet.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCarrierGateway(params = {}, callback) ⇒ AWS.Request

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.

Service Reference:

Examples:

Calling the createCarrierGateway operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createCarrierGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VpcId — (String)

      The ID of the VPC to associate with the carrier gateway.

    • TagSpecifications — (Array<map>)

      The tags to associate with the carrier gateway.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CarrierGateway — (map)

        Information about the 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.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • OwnerId — (String)

          The Amazon Web Services account ID of the owner of the carrier gateway.

        • Tags — (Array<map>)

          The tags assigned to the carrier gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createClientVpnEndpoint(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createClientVpnEndpoint operation

var params = {
  AuthenticationOptions: [ /* required */
    {
      ActiveDirectory: {
        DirectoryId: 'STRING_VALUE'
      },
      FederatedAuthentication: {
        SAMLProviderArn: 'STRING_VALUE',
        SelfServiceSAMLProviderArn: 'STRING_VALUE'
      },
      MutualAuthentication: {
        ClientRootCertificateChainArn: 'STRING_VALUE'
      },
      Type: certificate-authentication | directory-service-authentication | federated-authentication
    },
    /* more items */
  ],
  ClientCidrBlock: 'STRING_VALUE', /* required */
  ConnectionLogOptions: { /* required */
    CloudwatchLogGroup: 'STRING_VALUE',
    CloudwatchLogStream: 'STRING_VALUE',
    Enabled: true || false
  },
  ServerCertificateArn: 'STRING_VALUE', /* required */
  ClientConnectOptions: {
    Enabled: true || false,
    LambdaFunctionArn: 'STRING_VALUE'
  },
  ClientLoginBannerOptions: {
    BannerText: 'STRING_VALUE',
    Enabled: true || false
  },
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DnsServers: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SelfServicePortal: enabled | disabled,
  SessionTimeoutHours: 'NUMBER_VALUE',
  SplitTunnel: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TransportProtocol: tcp | udp,
  VpcId: 'STRING_VALUE',
  VpnPort: 'NUMBER_VALUE'
};
ec2.createClientVpnEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientCidrBlock — (String)

      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)

      The ARN of the server certificate. For more information, see the Certificate Manager User Guide.

    • AuthenticationOptions — (Array<map>)

      Information about the authentication method to be used to authenticate clients.

      • Type — (String)

        The type of client authentication to be used.

        Possible values include:
        • "certificate-authentication"
        • "directory-service-authentication"
        • "federated-authentication"
      • ActiveDirectory — (map)

        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 — (map)

        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 — (map)

        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 — (map)

      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 — (Array<String>)

      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.

    • TransportProtocol — (String)

      The transport protocol to be used by the VPN session.

      Default value: udp

      Possible values include:
      • "tcp"
      • "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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • TagSpecifications — (Array<map>)

      The tags to apply to the Client VPN endpoint during creation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<String>)

      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.

    • 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

      Possible values include:
      • "enabled"
      • "disabled"
    • ClientConnectOptions — (map)

      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 — (map)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientVpnEndpointId — (String)

        The ID of the Client VPN endpoint.

      • Status — (map)

        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.

          Possible values include:
          • "pending-associate"
          • "available"
          • "deleting"
          • "deleted"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createClientVpnRoute(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createClientVpnRoute operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  DestinationCidrBlock: 'STRING_VALUE', /* required */
  TargetVpcSubnetId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false
};
ec2.createClientVpnRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint to which to add the route.

    • DestinationCidrBlock — (String)

      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)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (map)

        The current state of the route.

        • Code — (String)

          The state of the Client VPN endpoint route.

          Possible values include:
          • "creating"
          • "active"
          • "failed"
          • "deleting"
        • Message — (String)

          A message about the status of the Client VPN endpoint route, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCoipCidr(params = {}, callback) ⇒ AWS.Request

Creates a range of customer-owned IP addresses.

Service Reference:

Examples:

Calling the createCoipCidr operation

var params = {
  Cidr: 'STRING_VALUE', /* required */
  CoipPoolId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.createCoipCidr(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Cidr — (String)

      A customer-owned IP address range to create.

    • CoipPoolId — (String)

      The ID of the 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CoipCidr — (map)

        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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCoipPool(params = {}, callback) ⇒ AWS.Request

Creates a pool of customer-owned IP (CoIP) addresses.

Service Reference:

Examples:

Calling the createCoipPool operation

var params = {
  LocalGatewayRouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createCoipPool(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableId — (String)

      The ID of the local gateway route table.

    • TagSpecifications — (Array<map>)

      The tags to assign to the CoIP address pool.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CoipPool — (map)

        Information about the CoIP address pool.

        • PoolId — (String)

          The ID of the address pool.

        • PoolCidrs — (Array<String>)

          The address ranges of the address pool.

        • LocalGatewayRouteTableId — (String)

          The ID of the local gateway route table.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCustomerGateway(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a customer gateway


/* This example creates a customer gateway with the specified IP address for its outside interface. */

 var params = {
  BgpAsn: 65534, 
  PublicIp: "12.1.2.3", 
  Type: "ipsec.1"
 };
 ec2.createCustomerGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomerGateway: {
     BgpAsn: "65534", 
     CustomerGatewayId: "cgw-0e11f167", 
     IpAddress: "12.1.2.3", 
     State: "available", 
     Type: "ipsec.1"
    }
   }
   */
 });

Calling the createCustomerGateway operation

var params = {
  Type: ipsec.1, /* required */
  BgpAsn: 'NUMBER_VALUE',
  BgpAsnExtended: 'NUMBER_VALUE',
  CertificateArn: 'STRING_VALUE',
  DeviceName: 'STRING_VALUE',
  DryRun: true || false,
  IpAddress: 'STRING_VALUE',
  PublicIp: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createCustomerGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      The type of VPN connection that this customer gateway supports (ipsec.1).

      Possible values include:
      • "ipsec.1"
    • TagSpecifications — (Array<map>)

      The tags to apply to the customer gateway.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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)

      IPv4 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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • 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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CustomerGateway — (map)

        Information about the customer gateway.

        • BgpAsn — (String)

          The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

          Valid values: 1 to 2,147,483,647

        • CustomerGatewayId — (String)

          The ID of the customer gateway.

        • IpAddress — (String)

          IPv4 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.

        • CertificateArn — (String)

          The Amazon Resource Name (ARN) for the customer gateway certificate.

        • 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).

        • DeviceName — (String)

          The name of customer gateway device.

        • Tags — (Array<map>)

          Any tags assigned to the customer gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDefaultSubnet(params = {}, callback) ⇒ AWS.Request

Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Create a default subnet in the Amazon VPC User Guide.

Service Reference:

Examples:

Calling the createDefaultSubnet operation

var params = {
  AvailabilityZone: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Ipv6Native: true || false
};
ec2.createDefaultSubnet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AvailabilityZone — (String)

      The Availability Zone in which to create the default 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.

    • Ipv6Native — (Boolean)

      Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Subnet — (map)

        Information about the subnet.

        • AvailabilityZone — (String)

          The Availability Zone of the subnet.

        • AvailabilityZoneId — (String)

          The AZ ID of the subnet.

        • AvailableIpAddressCount — (Integer)

          The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

        • CidrBlock — (String)

          The IPv4 CIDR block assigned to the subnet.

        • DefaultForAz — (Boolean)

          Indicates whether this is the default subnet for the Availability Zone.

        • 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).

        • 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.

        • 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.

        • State — (String)

          The current state of the subnet.

          Possible values include:
          • "pending"
          • "available"
          • "unavailable"
        • SubnetId — (String)

          The ID of the subnet.

        • VpcId — (String)

          The ID of the VPC the subnet is in.

        • 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 — (Array<map>)

          Information about the IPv6 CIDR blocks associated with the subnet.

          • AssociationId — (String)

            The ID of the association.

          • Ipv6CidrBlock — (String)

            The IPv6 CIDR block.

          • Ipv6CidrBlockState — (map)

            The state of the CIDR block.

            • State — (String)

              The state of a CIDR block.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failing"
              • "failed"
            • 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.

            Possible values include:
            • "public"
            • "private"
          • 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.

            Possible values include:
            • "amazon"
            • "byoip"
            • "none"
        • Tags — (Array<map>)

          Any tags assigned to the subnet.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

            Possible values include:
            • "ip-name"
            • "resource-name"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDefaultVpc(params = {}, callback) ⇒ AWS.Request

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPCs in the Amazon VPC User Guide. You cannot specify the components of the default VPC yourself.

If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.

Service Reference:

Examples:

Calling the createDefaultVpc operation

var params = {
  DryRun: true || false
};
ec2.createDefaultVpc(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Vpc — (map)

        Information about 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.

        • State — (String)

          The current state of the VPC.

          Possible values include:
          • "pending"
          • "available"
        • VpcId — (String)

          The ID of 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.

          Possible values include:
          • "default"
          • "dedicated"
          • "host"
        • Ipv6CidrBlockAssociationSet — (Array<map>)

          Information about the IPv6 CIDR blocks associated with the VPC.

          • AssociationId — (String)

            The association ID for the IPv6 CIDR block.

          • Ipv6CidrBlock — (String)

            The IPv6 CIDR block.

          • Ipv6CidrBlockState — (map)

            Information about the state of the CIDR block.

            • State — (String)

              The state of the CIDR block.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failing"
              • "failed"
            • 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.

            Possible values include:
            • "public"
            • "private"
          • 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.

            Possible values include:
            • "amazon"
            • "byoip"
            • "none"
        • CidrBlockAssociationSet — (Array<map>)

          Information about the IPv4 CIDR blocks associated with the VPC.

          • AssociationId — (String)

            The association ID for the IPv4 CIDR block.

          • CidrBlock — (String)

            The IPv4 CIDR block.

          • CidrBlockState — (map)

            Information about the state of the CIDR block.

            • State — (String)

              The state of the CIDR block.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failing"
              • "failed"
            • StatusMessage — (String)

              A message about the status of the CIDR block, if applicable.

        • IsDefault — (Boolean)

          Indicates whether the VPC is the default VPC.

        • Tags — (Array<map>)

          Any tags assigned to the VPC.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDhcpOptions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a DHCP options set


/* This example creates a DHCP options set. */

 var params = {
  DhcpConfigurations: [
     {
    Key: "domain-name-servers", 
    Values: [
       "10.2.5.1", 
       "10.2.5.2"
    ]
   }
  ]
 };
 ec2.createDhcpOptions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DhcpOptions: {
     DhcpConfigurations: [
        {
       Key: "domain-name-servers", 
       Values: [
          {
         Value: "10.2.5.2"
        }, 
          {
         Value: "10.2.5.1"
        }
       ]
      }
     ], 
     DhcpOptionsId: "dopt-d9070ebb"
    }
   }
   */
 });

Calling the createDhcpOptions operation

var params = {
  DhcpConfigurations: [ /* required */
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createDhcpOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DhcpConfigurations — (Array<map>)

      A DHCP configuration option.

      • Key — (String)

        The name of a DHCP option.

      • Values — (Array<String>)

        The values for the DHCP option.

    • TagSpecifications — (Array<map>)

      The tags to assign to the DHCP option.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DhcpOptions — (map)

        A set of DHCP options.

        • DhcpConfigurations — (Array<map>)

          The DHCP options in the set.

          • Key — (String)

            The name of a DHCP option.

          • Values — (Array<map>)

            The values for the DHCP option.

            • Value — (String)

              The attribute value. The value is case-sensitive.

        • DhcpOptionsId — (String)

          The ID of the set of DHCP options.

        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the DHCP options set.

        • Tags — (Array<map>)

          Any tags assigned to the DHCP options set.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createEgressOnlyInternetGateway(params = {}, callback) ⇒ AWS.Request

[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.

Service Reference:

Examples:

Calling the createEgressOnlyInternetGateway operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createEgressOnlyInternetGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      The ID of the VPC for which to create the egress-only internet gateway.

    • TagSpecifications — (Array<map>)

      The tags to assign to the egress-only internet gateway.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientToken — (String)

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      • EgressOnlyInternetGateway — (map)

        Information about the egress-only internet gateway.

        • Attachments — (Array<map>)

          Information about the attachment of the 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.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • VpcId — (String)

            The ID of the VPC.

        • EgressOnlyInternetGatewayId — (String)

          The ID of the egress-only internet gateway.

        • Tags — (Array<map>)

          The tags assigned to the egress-only internet gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFleet(params = {}, callback) ⇒ AWS.Request

Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances. Instances are launched immediately if there is available capacity.

A single EC2 Fleet can include multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

For more information, see EC2 Fleet in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the createFleet operation

var params = {
  LaunchTemplateConfigs: [ /* required */
    {
      LaunchTemplateSpecification: {
        LaunchTemplateId: 'STRING_VALUE',
        LaunchTemplateName: 'STRING_VALUE',
        Version: 'STRING_VALUE'
      },
      Overrides: [
        {
          AvailabilityZone: 'STRING_VALUE',
          ImageId: 'STRING_VALUE',
          InstanceRequirements: {
            MemoryMiB: { /* required */
              Min: 'NUMBER_VALUE', /* required */
              Max: 'NUMBER_VALUE'
            },
            VCpuCount: { /* required */
              Min: 'NUMBER_VALUE', /* required */
              Max: 'NUMBER_VALUE'
            },
            AcceleratorCount: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            AcceleratorManufacturers: [
              amazon-web-services | amd | nvidia | xilinx | habana,
              /* more items */
            ],
            AcceleratorNames: [
              a100 | inferentia | k520 | k80 | m60 | radeon-pro-v520 | t4 | vu9p | v100 | a10g | h100 | t4g,
              /* more items */
            ],
            AcceleratorTotalMemoryMiB: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            AcceleratorTypes: [
              gpu | fpga | inference,
              /* more items */
            ],
            AllowedInstanceTypes: [
              'STRING_VALUE',
              /* more items */
            ],
            BareMetal: included | required | excluded,
            BaselineEbsBandwidthMbps: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            BurstablePerformance: included | required | excluded,
            CpuManufacturers: [
              intel | amd | amazon-web-services,
              /* more items */
            ],
            ExcludedInstanceTypes: [
              'STRING_VALUE',
              /* more items */
            ],
            InstanceGenerations: [
              current | previous,
              /* more items */
            ],
            LocalStorage: included | required | excluded,
            LocalStorageTypes: [
              hdd | ssd,
              /* more items */
            ],
            MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: 'NUMBER_VALUE',
            MemoryGiBPerVCpu: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            NetworkBandwidthGbps: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            NetworkInterfaceCount: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            },
            OnDemandMaxPricePercentageOverLowestPrice: 'NUMBER_VALUE',
            RequireHibernateSupport: true || false,
            SpotMaxPricePercentageOverLowestPrice: 'NUMBER_VALUE',
            TotalLocalStorageGB: {
              Max: 'NUMBER_VALUE',
              Min: 'NUMBER_VALUE'
            }
          },
          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,
          MaxPrice: 'STRING_VALUE',
          Placement: {
            Affinity: 'STRING_VALUE',
            AvailabilityZone: 'STRING_VALUE',
            GroupId: 'STRING_VALUE',
            GroupName: 'STRING_VALUE',
            HostId: 'STRING_VALUE',
            HostResourceGroupArn: 'STRING_VALUE',
            PartitionNumber: 'NUMBER_VALUE',
            SpreadDomain: 'STRING_VALUE',
            Tenancy: default | dedicated | host
          },
          Priority: 'NUMBER_VALUE',
          SubnetId: 'STRING_VALUE',
          WeightedCapacity: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TargetCapacitySpecification: { /* required */
    TotalTargetCapacity: 'NUMBER_VALUE', /* required */
    DefaultTargetCapacityType: spot | on-demand | capacity-block,
    OnDemandTargetCapacity: 'NUMBER_VALUE',
    SpotTargetCapacity: 'NUMBER_VALUE',
    TargetCapacityUnitType: vcpu | memory-mib | units
  },
  ClientToken: 'STRING_VALUE',
  Context: 'STRING_VALUE',
  DryRun: true || false,
  ExcessCapacityTerminationPolicy: no-termination | termination,
  OnDemandOptions: {
    AllocationStrategy: lowest-price | prioritized,
    CapacityReservationOptions: {
      UsageStrategy: use-capacity-reservations-first
    },
    MaxTotalPrice: 'STRING_VALUE',
    MinTargetCapacity: 'NUMBER_VALUE',
    SingleAvailabilityZone: true || false,
    SingleInstanceType: true || false
  },
  ReplaceUnhealthyInstances: true || false,
  SpotOptions: {
    AllocationStrategy: lowest-price | diversified | capacity-optimized | capacity-optimized-prioritized | price-capacity-optimized,
    InstanceInterruptionBehavior: hibernate | stop | terminate,
    InstancePoolsToUseCount: 'NUMBER_VALUE',
    MaintenanceStrategies: {
      CapacityRebalance: {
        ReplacementStrategy: launch | launch-before-terminate,
        TerminationDelay: 'NUMBER_VALUE'
      }
    },
    MaxTotalPrice: 'STRING_VALUE',
    MinTargetCapacity: 'NUMBER_VALUE',
    SingleAvailabilityZone: true || false,
    SingleInstanceType: true || false
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TerminateInstancesWithExpiration: true || false,
  Type: request | maintain | instant,
  ValidFrom: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ValidUntil: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
ec2.createFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

    • SpotOptions — (map)

      Describes the configuration of Spot Instances in an EC2 Fleet.

      • AllocationStrategy — (String)

        The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.

        price-capacity-optimized (recommended)

        EC2 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. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

        capacity-optimized

        EC2 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 capacity-optimized-prioritized. 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. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

        diversified

        EC2 Fleet requests instances from all of the Spot Instance pools that you specify.

        lowest-price (not recommended)

        We don't recommend the lowest-price allocation strategy because it has the highest risk of interruption for your Spot Instances.

        EC2 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, EC2 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: lowest-price

        Possible values include:
        • "lowest-price"
        • "diversified"
        • "capacity-optimized"
        • "capacity-optimized-prioritized"
        • "price-capacity-optimized"
      • MaintenanceStrategies — (map)

        The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

        • CapacityRebalance — (map)

          The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.

          • ReplacementStrategy — (String)

            The replacement strategy to use. Only available for fleets of type maintain.

            launch - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 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 - EC2 Fleet launches a 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.

            Possible values include:
            • "launch"
            • "launch-before-terminate"
          • 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.

      • InstanceInterruptionBehavior — (String)

        The behavior when a Spot Instance is interrupted.

        Default: terminate

        Possible values include:
        • "hibernate"
        • "stop"
        • "terminate"
      • InstancePoolsToUseCount — (Integer)

        The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

        Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

      • SingleInstanceType — (Boolean)

        Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

        Supported only for fleets of type instant.

      • SingleAvailabilityZone — (Boolean)

        Indicates that the fleet launches all Spot Instances into a single Availability Zone.

        Supported only for fleets of type instant.

      • MinTargetCapacity — (Integer)

        The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.

        Constraints: Maximum value of 1000. Supported only for fleets of type instant.

        At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

      • MaxTotalPrice — (String)

        The maximum amount per hour for Spot Instances that you're willing to pay. 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 specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
        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 MaxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for MaxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
    • OnDemandOptions — (map)

      Describes the configuration of On-Demand Instances in an EC2 Fleet.

      • AllocationStrategy — (String)

        The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.

        lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.

        prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.

        Default: lowest-price

        Possible values include:
        • "lowest-price"
        • "prioritized"
      • CapacityReservationOptions — (map)

        The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

        Supported only for fleets of type instant.

        • UsageStrategy — (String)

          Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

          If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).

          If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

          Possible values include:
          • "use-capacity-reservations-first"
      • SingleInstanceType — (Boolean)

        Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.

        Supported only for fleets of type instant.

      • SingleAvailabilityZone — (Boolean)

        Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

        Supported only for fleets of type instant.

      • MinTargetCapacity — (Integer)

        The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.

        Constraints: Maximum value of 1000. Supported only for fleets of type instant.

        At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

      • MaxTotalPrice — (String)

        The maximum amount per hour for On-Demand Instances that you're willing to pay.

        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 MaxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for MaxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
    • 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.

      Possible values include:
      • "no-termination"
      • "termination"
    • LaunchTemplateConfigs — (Array<map>)

      The configuration for the EC2 Fleet.

      • LaunchTemplateSpecification — (map)

        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 — (Array<map>)

        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.

        • 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.
          Possible values include:
          • "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"
        • 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.

          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. 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 — (map)

          The location where the instance launched, if applicable.

          • 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.

          • 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.

            Possible values include:
            • "default"
            • "dedicated"
            • "host"
          • 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.

        • InstanceRequirements — (map)

          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 — required — (map)

            The minimum and maximum number of vCPUs.

            • Min — required — (Integer)

              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 — required — (map)

            The minimum and maximum amount of memory, in MiB.

            • Min — required — (Integer)

              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 — (Array<String>)

            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.

            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

          • MemoryGiBPerVCpu — (map)

            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 — (Array<String>)

            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

          • InstanceGenerations — (Array<String>)

            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

          • 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

            Possible values include:
            • "included"
            • "required"
            • "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

            Possible values include:
            • "included"
            • "required"
            • "excluded"
          • RequireHibernateSupport — (Boolean)

            Indicates whether instance types must support hibernation for On-Demand Instances.

            This parameter is not supported for GetSpotPlacementScores.

            Default: false

          • NetworkInterfaceCount — (map)

            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

            Possible values include:
            • "included"
            • "required"
            • "excluded"
          • LocalStorageTypes — (Array<String>)

            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

          • TotalLocalStorageGB — (map)

            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 — (map)

            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 — (Array<String>)

            The accelerator types that must be on the instance type.

            • To include instance types with GPU hardware, specify gpu.

            • To include instance types with FPGA hardware, specify fpga.

            • To include instance types with inference hardware, specify inference.

            Default: Any accelerator type

          • AcceleratorCount — (map)

            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 — (Array<String>)

            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

          • AcceleratorNames — (Array<String>)

            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

          • AcceleratorTotalMemoryMiB — (map)

            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 — (map)

            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 — (Array<String>)

            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

          • 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.
        • 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.
    • TargetCapacitySpecification — (map)

      The number of units to request.

      • TotalTargetCapacity — required — (Integer)

        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.

        Possible values include:
        • "spot"
        • "on-demand"
        • "capacity-block"
      • 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)

        Possible values include:
        • "vcpu"
        • "memory-mib"
        • "units"
    • TerminateInstancesWithExpiration — (Boolean)

      Indicates whether running instances should be terminated when the EC2 Fleet expires.

    • Type — (String)

      The fleet type. The default value is maintain.

      • maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.

      • request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.

      • instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.

      For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.

      Possible values include:
      • "request"
      • "maintain"
      • "instant"
    • ValidFrom — (Date)

      The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

    • ValidUntil — (Date)

      The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

    • ReplaceUnhealthyInstances — (Boolean)

      Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.

    • TagSpecifications — (Array<map>)

      The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tag your resources.

      If the fleet type is instant, specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.

      If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance. To tag instances at launch, specify the tags in a launch template.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

    • Context — (String)

      Reserved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        The ID of the EC2 Fleet.

      • Errors — (Array<map>)

        Information about the instances that could not be launched by the fleet. Supported only for fleets of type instant.

        • LaunchTemplateAndOverrides — (map)

          The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

          • LaunchTemplateSpecification — (map)

            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 — (map)

            Any parameters that you specify override the same parameters in the 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.
              Possible values include:
              • "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"
            • 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.

              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 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 — (map)

              The location where the instance launched, if applicable.

              • GroupName — (String)

                The name of the placement group that the instance is in.

            • InstanceRequirements — (map)

              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 — (map)

                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 — (map)

                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 — (Array<String>)

                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.

                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

              • MemoryGiBPerVCpu — (map)

                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 — (Array<String>)

                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

              • InstanceGenerations — (Array<String>)

                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

              • 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

                Possible values include:
                • "included"
                • "required"
                • "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

                Possible values include:
                • "included"
                • "required"
                • "excluded"
              • RequireHibernateSupport — (Boolean)

                Indicates whether instance types must support hibernation for On-Demand Instances.

                This parameter is not supported for GetSpotPlacementScores.

                Default: false

              • NetworkInterfaceCount — (map)

                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

                Possible values include:
                • "included"
                • "required"
                • "excluded"
              • LocalStorageTypes — (Array<String>)

                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

              • TotalLocalStorageGB — (map)

                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 — (map)

                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 — (Array<String>)

                The accelerator types that must be on the instance type.

                • For instance types with GPU accelerators, specify gpu.

                • For instance types with FPGA accelerators, specify fpga.

                • For instance types with inference accelerators, specify inference.

                Default: Any accelerator type

              • AcceleratorCount — (map)

                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 — (Array<String>)

                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

              • AcceleratorNames — (Array<String>)

                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

              • AcceleratorTotalMemoryMiB — (map)

                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 — (map)

                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 — (Array<String>)

                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

              • 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.
            • 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.
        • Lifecycle — (String)

          Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

          Possible values include:
          • "spot"
          • "on-demand"
        • ErrorCode — (String)

          The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.

        • ErrorMessage — (String)

          The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.

      • Instances — (Array<map>)

        Information about the instances that were launched by the fleet. Supported only for fleets of type instant.

        • LaunchTemplateAndOverrides — (map)

          The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

          • LaunchTemplateSpecification — (map)

            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 — (map)

            Any parameters that you specify override the same parameters in the 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.
              Possible values include:
              • "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"
            • 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.

              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 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 — (map)

              The location where the instance launched, if applicable.

              • GroupName — (String)

                The name of the placement group that the instance is in.

            • InstanceRequirements — (map)

              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 — (map)

                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 — (map)

                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 — (Array<String>)

                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.

                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

              • MemoryGiBPerVCpu — (map)

                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 — (Array<String>)

                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

              • InstanceGenerations — (Array<String>)

                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

              • 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

                Possible values include:
                • "included"
                • "required"
                • "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

                Possible values include:
                • "included"
                • "required"
                • "excluded"
              • RequireHibernateSupport — (Boolean)

                Indicates whether instance types must support hibernation for On-Demand Instances.

                This parameter is not supported for GetSpotPlacementScores.

                Default: false

              • NetworkInterfaceCount — (map)

                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

                Possible values include:
                • "included"
                • "required"
                • "excluded"
              • LocalStorageTypes — (Array<String>)

                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

              • TotalLocalStorageGB — (map)

                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 — (map)

                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 — (Array<String>)

                The accelerator types that must be on the instance type.

                • For instance types with GPU accelerators, specify gpu.

                • For instance types with FPGA accelerators, specify fpga.

                • For instance types with inference accelerators, specify inference.

                Default: Any accelerator type

              • AcceleratorCount — (map)

                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 — (Array<String>)

                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

              • AcceleratorNames — (Array<String>)

                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

              • AcceleratorTotalMemoryMiB — (map)

                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 — (map)

                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 — (Array<String>)

                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

              • 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.
            • 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.
        • Lifecycle — (String)

          Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

          Possible values include:
          • "spot"
          • "on-demand"
        • InstanceIds — (Array<String>)

          The IDs of the instances.

        • InstanceType — (String)

          The instance type.

          Possible values include:
          • "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"
        • Platform — (String)

          The value is Windows for Windows instances. Otherwise, the value is blank.

          Possible values include:
          • "Windows"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFlowLogs(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createFlowLogs operation

var params = {
  ResourceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ResourceType: VPC | Subnet | NetworkInterface | TransitGateway | TransitGatewayAttachment, /* required */
  ClientToken: 'STRING_VALUE',
  DeliverCrossAccountRole: 'STRING_VALUE',
  DeliverLogsPermissionArn: 'STRING_VALUE',
  DestinationOptions: {
    FileFormat: plain-text | parquet,
    HiveCompatiblePartitions: true || false,
    PerHourPartition: true || false
  },
  DryRun: true || false,
  LogDestination: 'STRING_VALUE',
  LogDestinationType: cloud-watch-logs | s3 | kinesis-data-firehose,
  LogFormat: 'STRING_VALUE',
  LogGroupName: 'STRING_VALUE',
  MaxAggregationInterval: 'NUMBER_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TrafficType: ACCEPT | REJECT | ALL
};
ec2.createFlowLogs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      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.

    • ResourceType — (String)

      The type of resource to monitor.

      Possible values include:
      • "VPC"
      • "Subnet"
      • "NetworkInterface"
      • "TransitGateway"
      • "TransitGatewayAttachment"
    • 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.

      Possible values include:
      • "ACCEPT"
      • "REJECT"
      • "ALL"
    • LogDestinationType — (String)

      The type of destination for the flow log data.

      Default: cloud-watch-logs

      Possible values include:
      • "cloud-watch-logs"
      • "s3"
      • "kinesis-data-firehose"
    • 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:deliverystream: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 — (Array<map>)

      The tags to apply to the flow logs.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

      The destination options.

      • FileFormat — (String)

        The format for the flow log. The default is plain-text.

        Possible values include:
        • "plain-text"
        • "parquet"
      • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientToken — (String)

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      • FlowLogIds — (Array<String>)

        The IDs of the flow logs.

      • Unsuccessful — (Array<map>)

        Information about the flow logs that could not be created successfully.

        • Error — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFpgaImage(params = {}, callback) ⇒ AWS.Request

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.

An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.

Service Reference:

Examples:

Calling the createFpgaImage operation

var params = {
  InputStorageLocation: { /* required */
    Bucket: 'STRING_VALUE',
    Key: 'STRING_VALUE'
  },
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  LogsStorageLocation: {
    Bucket: 'STRING_VALUE',
    Key: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createFpgaImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • InputStorageLocation — (map)

      The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

      • Bucket — (String)

        The name of the S3 bucket.

      • Key — (String)

        The key.

    • LogsStorageLocation — (map)

      The location in Amazon S3 for the output logs.

      • Bucket — (String)

        The name of the S3 bucket.

      • Key — (String)

        The key.

    • Description — (String)

      A description for the AFI.

    • Name — (String)

      A name for the AFI.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

    • TagSpecifications — (Array<map>)

      The tags to apply to the FPGA image during creation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FpgaImageId — (String)

        The FPGA image identifier (AFI ID).

      • FpgaImageGlobalId — (String)

        The global FPGA image identifier (AGFI ID).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createImage(params = {}, callback) ⇒ AWS.Request

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.

For more information, see Create an Amazon EBS-backed Linux AMI in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To create an AMI from an Amazon EBS-backed instance


/* This example creates an AMI from the specified instance and adds an EBS volume with the device name /dev/sdh and an instance store volume with the device name /dev/sdc. */

 var params = {
  BlockDeviceMappings: [
     {
    DeviceName: "/dev/sdh", 
    Ebs: {
     VolumeSize: 100
    }
   }, 
     {
    DeviceName: "/dev/sdc", 
    VirtualName: "ephemeral1"
   }
  ], 
  Description: "An AMI for my server", 
  InstanceId: "i-1234567890abcdef0", 
  Name: "My server", 
  NoReboot: true
 };
 ec2.createImage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ImageId: "ami-1a2b3c4d"
   }
   */
 });

Calling the createImage operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  BlockDeviceMappings: [
    {
      DeviceName: 'STRING_VALUE',
      Ebs: {
        DeleteOnTermination: true || false,
        Encrypted: true || false,
        Iops: 'NUMBER_VALUE',
        KmsKeyId: 'STRING_VALUE',
        OutpostArn: 'STRING_VALUE',
        SnapshotId: 'STRING_VALUE',
        Throughput: 'NUMBER_VALUE',
        VolumeSize: 'NUMBER_VALUE',
        VolumeType: standard | io1 | io2 | gp2 | sc1 | st1 | gp3
      },
      NoDevice: 'STRING_VALUE',
      VirtualName: 'STRING_VALUE'
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  DryRun: true || false,
  NoReboot: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BlockDeviceMappings — (Array<map>)

      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), use the CopyImage action.

      • The only option that can be changed for existing mappings or snapshots is DeleteOnTermination.

      • 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 — (map)

        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.

          Possible values include:
          • "standard"
          • "io1"
          • "io2"
          • "gp2"
          • "sc1"
          • "st1"
          • "gp3"
        • KmsKeyId — (String)

          Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

          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.

        • 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.

      • 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.

    • Description — (String)

      A description for the new image.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the instance.

    • Name — (String)

      A name for the new image.

      Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

    • 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

    • TagSpecifications — (Array<map>)

      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.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageId — (String)

        The ID of the new AMI.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createInstanceConnectEndpoint(params = {}, callback) ⇒ AWS.Request

Creates an EC2 Instance Connect Endpoint.

An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 address. For more information, see Connect to your instances without requiring a public IPv4 address using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the createInstanceConnectEndpoint operation

var params = {
  SubnetId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  PreserveClientIp: true || false,
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createInstanceConnectEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 in which to create the EC2 Instance Connect Endpoint.

    • SecurityGroupIds — (Array<String>)

      One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be associated with the endpoint.

    • PreserveClientIp — (Boolean)

      Indicates whether the client IP address is preserved as the source. The following are the possible values.

      • true - Use the client IP address as the source.

      • false - Use the network interface IP address as the source.

      Default: false

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • TagSpecifications — (Array<map>)

      The tags to apply to the EC2 Instance Connect Endpoint during creation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceConnectEndpoint — (map)

        Information about 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.

          Possible values include:
          • "create-in-progress"
          • "create-complete"
          • "create-failed"
          • "delete-in-progress"
          • "delete-complete"
          • "delete-failed"
        • 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)

        • NetworkInterfaceIds — (Array<String>)

          The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.

        • 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 — (Date)

          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 — (Array<String>)

          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.

        • Tags — (Array<map>)

          The tags assigned to the EC2 Instance Connect Endpoint.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 idempotency token provided by the client in the the request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createInstanceEventWindow(params = {}, callback) ⇒ AWS.Request

Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.

You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.

You can create up to 200 event windows per Amazon Web Services Region.

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.

Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.

Event windows are not applicable for:

  • Expedited scheduled events and network maintenance events.

  • Unscheduled maintenance such as AutoRecovery and unplanned reboots.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the createInstanceEventWindow operation

var params = {
  CronExpression: 'STRING_VALUE',
  DryRun: true || false,
  Name: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TimeRanges: [
    {
      EndHour: 'NUMBER_VALUE',
      EndWeekDay: sunday | monday | tuesday | wednesday | thursday | friday | saturday,
      StartHour: 'NUMBER_VALUE',
      StartWeekDay: sunday | monday | tuesday | wednesday | thursday | friday | saturday
    },
    /* more items */
  ]
};
ec2.createInstanceEventWindow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      The time range for the event window. If you specify a time range, you can't specify a cron expression.

      • StartWeekDay — (String)

        The day on which the time range begins.

        Possible values include:
        • "sunday"
        • "monday"
        • "tuesday"
        • "wednesday"
        • "thursday"
        • "friday"
        • "saturday"
      • StartHour — (Integer)

        The hour when the time range begins.

      • EndWeekDay — (String)

        The day on which the time range ends.

        Possible values include:
        • "sunday"
        • "monday"
        • "tuesday"
        • "wednesday"
        • "thursday"
        • "friday"
        • "saturday"
      • 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 — (Array<map>)

      The tags to apply to the event window.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceEventWindow — (map)

        Information about the event window.

        • InstanceEventWindowId — (String)

          The ID of the event window.

        • TimeRanges — (Array<map>)

          One or more time ranges defined for the event window.

          • StartWeekDay — (String)

            The day on which the time range begins.

            Possible values include:
            • "sunday"
            • "monday"
            • "tuesday"
            • "wednesday"
            • "thursday"
            • "friday"
            • "saturday"
          • StartHour — (Integer)

            The hour when the time range begins.

          • EndWeekDay — (String)

            The day on which the time range ends.

            Possible values include:
            • "sunday"
            • "monday"
            • "tuesday"
            • "wednesday"
            • "thursday"
            • "friday"
            • "saturday"
          • 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 — (map)

          One or more targets associated with the event window.

          • InstanceIds — (Array<String>)

            The IDs of the instances associated with the event window.

          • Tags — (Array<map>)

            The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window.

            • Key — (String)

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<String>)

            The IDs of the Dedicated Hosts associated with the event window.

        • State — (String)

          The current state of the event window.

          Possible values include:
          • "creating"
          • "deleting"
          • "active"
          • "deleted"
        • Tags — (Array<map>)

          The instance tags associated with the event window.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createInstanceExportTask(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createInstanceExportTask operation

var params = {
  ExportToS3Task: { /* required */
    ContainerFormat: ova,
    DiskImageFormat: VMDK | RAW | VHD,
    S3Bucket: 'STRING_VALUE',
    S3Prefix: 'STRING_VALUE'
  },
  InstanceId: 'STRING_VALUE', /* required */
  TargetEnvironment: citrix | vmware | microsoft, /* required */
  Description: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createInstanceExportTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A description for the conversion task or the resource being exported. The maximum length is 255 characters.

    • ExportToS3Task — (map)

      The format and location for an export instance task.

      • ContainerFormat — (String)

        The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

        Possible values include:
        • "ova"
      • DiskImageFormat — (String)

        The format for the exported image.

        Possible values include:
        • "VMDK"
        • "RAW"
        • "VHD"
      • 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.

    • InstanceId — (String)

      The ID of the instance.

    • TargetEnvironment — (String)

      The target virtualization environment.

      Possible values include:
      • "citrix"
      • "vmware"
      • "microsoft"
    • TagSpecifications — (Array<map>)

      The tags to apply to the export instance task during creation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExportTask — (map)

        Information about the export instance task.

        • Description — (String)

          A description of the resource being exported.

        • ExportTaskId — (String)

          The ID of the export task.

        • ExportToS3Task — (map)

          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.

            Possible values include:
            • "ova"
          • DiskImageFormat — (String)

            The format for the exported image.

            Possible values include:
            • "VMDK"
            • "RAW"
            • "VHD"
          • 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 — (map)

          Information about the instance to export.

          • InstanceId — (String)

            The ID of the resource being exported.

          • TargetEnvironment — (String)

            The target virtualization environment.

            Possible values include:
            • "citrix"
            • "vmware"
            • "microsoft"
        • State — (String)

          The state of the export task.

          Possible values include:
          • "active"
          • "cancelling"
          • "cancelled"
          • "completed"
        • StatusMessage — (String)

          The status message related to the export task.

        • Tags — (Array<map>)

          The tags for the export task.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createInternetGateway(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create an Internet gateway


/* This example creates an Internet gateway. */

 var params = {
 };
 ec2.createInternetGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InternetGateway: {
     Attachments: [
     ], 
     InternetGatewayId: "igw-c0a643a9", 
     Tags: [
     ]
    }
   }
   */
 });

Calling the createInternetGateway operation

var params = {
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createInternetGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TagSpecifications — (Array<map>)

      The tags to assign to the internet gateway.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InternetGateway — (map)

        Information about the internet gateway.

        • Attachments — (Array<map>)

          Any VPCs attached to the 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.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • VpcId — (String)

            The ID of the VPC.

        • InternetGatewayId — (String)

          The ID of the internet gateway.

        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the internet gateway.

        • Tags — (Array<map>)

          Any tags assigned to the internet gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createIpam(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createIpam operation

var params = {
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  EnablePrivateGua: true || false,
  OperatingRegions: [
    {
      RegionName: 'STRING_VALUE'
    },
    /* more items */
  ],
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Tier: free | advanced
};
ec2.createIpam(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 — (Array<map>)

      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.

      • RegionName — (String)

        The name of the operating Region.

    • TagSpecifications — (Array<map>)

      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.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • 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.

      Possible values include:
      • "free"
      • "advanced"
    • EnablePrivateGua — (Boolean)

      Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Ipam — (map)

        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 — (Array<map>)

          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.

          Possible values include:
          • "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 — (Array<map>)

          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 the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "free"
          • "advanced"
        • EnablePrivateGua — (Boolean)

          Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createIpamExternalResourceVerificationToken(params = {}, callback) ⇒ AWS.Request

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).

Service Reference:

Examples:

Calling the createIpamExternalResourceVerificationToken operation

var params = {
  IpamId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createIpamExternalResourceVerificationToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      The ID of the IPAM that will create the token.

    • TagSpecifications — (Array<map>)

      Token tags.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamExternalResourceVerificationToken — (map)

        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 — (Date)

          Token expiration.

        • Status — (String)

          Token status.

          Possible values include:
          • "valid"
          • "expired"
        • Tags — (Array<map>)

          Token tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "create-in-progress"
          • "create-complete"
          • "create-failed"
          • "delete-in-progress"
          • "delete-complete"
          • "delete-failed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createIpamPool(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createIpamPool operation

var params = {
  AddressFamily: ipv4 | ipv6, /* required */
  IpamScopeId: 'STRING_VALUE', /* required */
  AllocationDefaultNetmaskLength: 'NUMBER_VALUE',
  AllocationMaxNetmaskLength: 'NUMBER_VALUE',
  AllocationMinNetmaskLength: 'NUMBER_VALUE',
  AllocationResourceTags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  AutoImport: true || false,
  AwsService: ec2,
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  Locale: 'STRING_VALUE',
  PublicIpSource: amazon | byoip,
  PubliclyAdvertisable: true || false,
  SourceIpamPoolId: 'STRING_VALUE',
  SourceResource: {
    ResourceId: 'STRING_VALUE',
    ResourceOwner: 'STRING_VALUE',
    ResourceRegion: 'STRING_VALUE',
    ResourceType: vpc
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createIpamPool(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      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.

      If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

      Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.

    • 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)

      The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

      Possible values include:
      • "ipv4"
      • "ipv6"
    • 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. This option is not available for pools with AddressFamily set to ipv4.

    • 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 — (Array<map>)

      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.

      • 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 — (Array<map>)

      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.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • 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.

      Possible values include:
      • "ec2"
    • 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.

      Possible values include:
      • "amazon"
      • "byoip"
    • SourceResource — (map)

      The resource used to provision CIDRs to a resource planning pool.

      • ResourceId — (String)

        The source resource ID.

      • ResourceType — (String)

        The source resource type.

        Possible values include:
        • "vpc"
      • ResourceRegion — (String)

        The source resource Region.

      • ResourceOwner — (String)

        The source resource owner.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamPool — (map)

        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.

          Possible values include:
          • "public"
          • "private"
        • 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.

          Possible values include:
          • "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)

          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.

          Possible values include:
          • "ipv4"
          • "ipv6"
        • 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 — (Array<map>)

          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.

          • 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 — (Array<map>)

          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 the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "ec2"
        • 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.

          Possible values include:
          • "amazon"
          • "byoip"
        • SourceResource — (map)

          The resource used to provision CIDRs to a resource planning pool.

          • ResourceId — (String)

            The source resource ID.

          • ResourceType — (String)

            The source resource type.

            Possible values include:
            • "vpc"
          • ResourceRegion — (String)

            The source resource Region.

          • ResourceOwner — (String)

            The source resource owner.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createIpamResourceDiscovery(params = {}, callback) ⇒ AWS.Request

Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Service Reference:

Examples:

Calling the createIpamResourceDiscovery operation

var params = {
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  OperatingRegions: [
    {
      RegionName: 'STRING_VALUE'
    },
    /* more items */
  ],
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createIpamResourceDiscovery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 resource discovery.

    • OperatingRegions — (Array<map>)

      Operating Regions for the IPAM 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.

      • RegionName — (String)

        The name of the operating Region.

    • TagSpecifications — (Array<map>)

      Tag specifications for the IPAM resource discovery.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 client token for the IPAM resource discovery.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamResourceDiscovery — (map)

        An 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 — (Array<map>)

          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.

          • 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.

          Possible values include:
          • "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 — (Array<map>)

          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.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createIpamScope(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createIpamScope operation

var params = {
  IpamId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createIpamScope(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      The ID of the IPAM for which you're creating this scope.

    • Description — (String)

      A description for the scope you're creating.

    • TagSpecifications — (Array<map>)

      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.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamScope — (map)

        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.

          Possible values include:
          • "public"
          • "private"
        • 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.

          Possible values include:
          • "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 — (Array<map>)

          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 the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createKeyPair(params = {}, callback) ⇒ AWS.Request

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK 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 Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To create a key pair


/* This example creates a key pair named my-key-pair. */

 var params = {
  KeyName: "my-key-pair"
 };
 ec2.createKeyPair(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createKeyPair operation

var params = {
  KeyName: 'STRING_VALUE', /* required */
  DryRun: true || false,
  KeyFormat: pem | ppk,
  KeyType: rsa | ed25519,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createKeyPair(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • KeyName — (String)

      A unique name for the key pair.

      Constraints: Up to 255 ASCII 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.

    • KeyType — (String)

      The type of key pair. Note that ED25519 keys are not supported for Windows instances.

      Default: rsa

      Possible values include:
      • "rsa"
      • "ed25519"
    • TagSpecifications — (Array<map>)

      The tags to apply to the new key pair.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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

      Possible values include:
      • "pem"
      • "ppk"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

      • KeyName — (String)

        The name of the key pair.

      • KeyPairId — (String)

        The ID of the key pair.

      • Tags — (Array<map>)

        Any tags applied to the key pair.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLaunchTemplate(params = {}, callback) ⇒ AWS.Request

Creates a launch template.

A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon EC2 User Guide.

To clone an existing launch template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon EC2 User Guide.

Service Reference:

Examples:

To create a launch template


/* This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance. */

 var params = {
  LaunchTemplateData: {
   ImageId: "ami-8c1be5f6", 
   InstanceType: "t2.small", 
   NetworkInterfaces: [
      {
     AssociatePublicIpAddress: true, 
     DeviceIndex: 0, 
     Ipv6AddressCount: 1, 
     SubnetId: "subnet-7b16de0c"
    }
   ], 
   TagSpecifications: [
      {
     ResourceType: "instance", 
     Tags: [
        {
       Key: "Name", 
       Value: "webserver"
      }
     ]
    }
   ]
  }, 
  LaunchTemplateName: "my-template", 
  VersionDescription: "WebVersion1"
 };
 ec2.createLaunchTemplate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LaunchTemplate: {
     CreateTime: <Date Representation>, 
     CreatedBy: "arn:aws:iam::123456789012:root", 
     DefaultVersionNumber: 1, 
     LatestVersionNumber: 1, 
     LaunchTemplateId: "lt-01238c059e3466abc", 
     LaunchTemplateName: "my-template"
    }
   }
   */
 });

Calling the createLaunchTemplate operation

var params = {
  LaunchTemplateData: { /* required */
    BlockDeviceMappings: [
      {
        DeviceName: 'STRING_VALUE',
        Ebs: {
          DeleteOnTermination: true || false,
          Encrypted: true || false,
          Iops: 'NUMBER_VALUE',
          KmsKeyId: 'STRING_VALUE',
          SnapshotId: 'STRING_VALUE',
          Throughput: 'NUMBER_VALUE',
          VolumeSize: 'NUMBER_VALUE',
          VolumeType: standard | io1 | io2 | gp2 | sc1 | st1 | gp3
        },
        NoDevice: 'STRING_VALUE',
        VirtualName: 'STRING_VALUE'
      },
      /* more items */
    ],
    CapacityReservationSpecification: {
      CapacityReservationPreference: open | none,
      CapacityReservationTarget: {
        CapacityReservationId: 'STRING_VALUE',
        CapacityReservationResourceGroupArn: 'STRING_VALUE'
      }
    },
    CpuOptions: {
      AmdSevSnp: enabled | disabled,
      CoreCount: 'NUMBER_VALUE',
      ThreadsPerCore: 'NUMBER_VALUE'
    },
    CreditSpecification: {
      CpuCredits: 'STRING_VALUE' /* required */
    },
    DisableApiStop: true || false,
    DisableApiTermination: true || false,
    EbsOptimized: true || false,
    ElasticGpuSpecifications: [
      {
        Type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ElasticInferenceAccelerators: [
      {
        Type: 'STRING_VALUE', /* required */
        Count: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    EnclaveOptions: {
      Enabled: true || false
    },
    HibernationOptions: {
      Configured: true || false
    },
    IamInstanceProfile: {
      Arn: 'STRING_VALUE',
      Name: 'STRING_VALUE'
    },
    ImageId: 'STRING_VALUE',
    InstanceInitiatedShutdownBehavior: stop | terminate,
    InstanceMarketOptions: {
      MarketType: spot | capacity-block,
      SpotOptions: {
        BlockDurationMinutes: 'NUMBER_VALUE',
        InstanceInterruptionBehavior: hibernate | stop | terminate,
        MaxPrice: 'STRING_VALUE',
        SpotInstanceType: one-time | persistent,
        ValidUntil: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      }
    },
    InstanceRequirements: {
      MemoryMiB: { /* required */
        Min: 'NUMBER_VALUE', /* required */
        Max: 'NUMBER_VALUE'
      },
      VCpuCount: { /* required */
        Min: 'NUMBER_VALUE', /* required */
        Max: 'NUMBER_VALUE'
      },
      AcceleratorCount: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      AcceleratorManufacturers: [
        amazon-web-services | amd | nvidia | xilinx | habana,
        /* more items */
      ],
      AcceleratorNames: [
        a100 | inferentia | k520 | k80 | m60 | radeon-pro-v520 | t4 | vu9p | v100 | a10g | h100 | t4g,
        /* more items */
      ],
      AcceleratorTotalMemoryMiB: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      AcceleratorTypes: [
        gpu | fpga | inference,
        /* more items */
      ],
      AllowedInstanceTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      BareMetal: included | required | excluded,
      BaselineEbsBandwidthMbps: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      BurstablePerformance: included | required | excluded,
      CpuManufacturers: [
        intel | amd | amazon-web-services,
        /* more items */
      ],
      ExcludedInstanceTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      InstanceGenerations: [
        current | previous,
        /* more items */
      ],
      LocalStorage: included | required | excluded,
      LocalStorageTypes: [
        hdd | ssd,
        /* more items */
      ],
      MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: 'NUMBER_VALUE',
      MemoryGiBPerVCpu: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      NetworkBandwidthGbps: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      NetworkInterfaceCount: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      OnDemandMaxPricePercentageOverLowestPrice: 'NUMBER_VALUE',
      RequireHibernateSupport: true || false,
      SpotMaxPricePercentageOverLowestPrice: 'NUMBER_VALUE',
      TotalLocalStorageGB: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      }
    },
    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,
    KernelId: 'STRING_VALUE',
    KeyName: 'STRING_VALUE',
    LicenseSpecifications: [
      {
        LicenseConfigurationArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    MaintenanceOptions: {
      AutoRecovery: default | disabled
    },
    MetadataOptions: {
      HttpEndpoint: disabled | enabled,
      HttpProtocolIpv6: disabled | enabled,
      HttpPutResponseHopLimit: 'NUMBER_VALUE',
      HttpTokens: optional | required,
      InstanceMetadataTags: disabled | enabled
    },
    Monitoring: {
      Enabled: true || false
    },
    NetworkInterfaces: [
      {
        AssociateCarrierIpAddress: true || false,
        AssociatePublicIpAddress: true || false,
        ConnectionTrackingSpecification: {
          TcpEstablishedTimeout: 'NUMBER_VALUE',
          UdpStreamTimeout: 'NUMBER_VALUE',
          UdpTimeout: 'NUMBER_VALUE'
        },
        DeleteOnTermination: true || false,
        Description: 'STRING_VALUE',
        DeviceIndex: 'NUMBER_VALUE',
        EnaSrdSpecification: {
          EnaSrdEnabled: true || false,
          EnaSrdUdpSpecification: {
            EnaSrdUdpEnabled: true || false
          }
        },
        Groups: [
          'STRING_VALUE',
          /* more items */
        ],
        InterfaceType: 'STRING_VALUE',
        Ipv4PrefixCount: 'NUMBER_VALUE',
        Ipv4Prefixes: [
          {
            Ipv4Prefix: 'STRING_VALUE'
          },
          /* more items */
        ],
        Ipv6AddressCount: 'NUMBER_VALUE',
        Ipv6Addresses: [
          {
            Ipv6Address: 'STRING_VALUE'
          },
          /* more items */
        ],
        Ipv6PrefixCount: 'NUMBER_VALUE',
        Ipv6Prefixes: [
          {
            Ipv6Prefix: 'STRING_VALUE'
          },
          /* more items */
        ],
        NetworkCardIndex: 'NUMBER_VALUE',
        NetworkInterfaceId: 'STRING_VALUE',
        PrimaryIpv6: true || false,
        PrivateIpAddress: 'STRING_VALUE',
        PrivateIpAddresses: [
          {
            Primary: true || false,
            PrivateIpAddress: 'STRING_VALUE'
          },
          /* more items */
        ],
        SecondaryPrivateIpAddressCount: 'NUMBER_VALUE',
        SubnetId: 'STRING_VALUE'
      },
      /* more items */
    ],
    Placement: {
      Affinity: 'STRING_VALUE',
      AvailabilityZone: 'STRING_VALUE',
      GroupId: 'STRING_VALUE',
      GroupName: 'STRING_VALUE',
      HostId: 'STRING_VALUE',
      HostResourceGroupArn: 'STRING_VALUE',
      PartitionNumber: 'NUMBER_VALUE',
      SpreadDomain: 'STRING_VALUE',
      Tenancy: default | dedicated | host
    },
    PrivateDnsNameOptions: {
      EnableResourceNameDnsAAAARecord: true || false,
      EnableResourceNameDnsARecord: true || false,
      HostnameType: ip-name | resource-name
    },
    RamDiskId: 'STRING_VALUE',
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SecurityGroups: [
      'STRING_VALUE',
      /* more items */
    ],
    TagSpecifications: [
      {
        ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
        Tags: [
          {
            Key: 'STRING_VALUE',
            Value: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    UserData: 'STRING_VALUE'
  },
  LaunchTemplateName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  VersionDescription: 'STRING_VALUE'
};
ec2.createLaunchTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

      Constraint: Maximum 128 ASCII characters.

    • LaunchTemplateName — (String)

      A name for the launch template.

    • VersionDescription — (String)

      A description for the first version of the launch template.

    • LaunchTemplateData — (map)

      The information for the launch template.

      • KernelId — (String)

        The ID of the kernel.

        We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide.

      • 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 Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

      • IamInstanceProfile — (map)

        The name or Amazon Resource Name (ARN) of an IAM instance profile.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the instance profile.

        • Name — (String)

          The name of the instance profile.

      • BlockDeviceMappings — (Array<map>)

        The block device mapping.

        • 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.

        • Ebs — (map)

          Parameters used to automatically set up EBS volumes when the instance is launched.

          • Encrypted — (Boolean)

            Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

          • DeleteOnTermination — (Boolean)

            Indicates whether the EBS 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.

            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 supported for io1, io2, and gp3 volumes only.

          • KmsKeyId — (String)

            The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

          • 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. 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

          • VolumeType — (String)

            The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

            Possible values include:
            • "standard"
            • "io1"
            • "io2"
            • "gp2"
            • "sc1"
            • "st1"
            • "gp3"
          • Throughput — (Integer)

            The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

            Valid Range: Minimum value of 125. Maximum value of 1000.

        • NoDevice — (String)

          To omit the device from the block device mapping, specify an empty string.

      • NetworkInterfaces — (Array<map>)

        The network interfaces for the instance.

        • AssociateCarrierIpAddress — (Boolean)

          Associates 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 addresses in the Wavelength Developer Guide.

        • AssociatePublicIpAddress — (Boolean)

          Associates 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. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.

        • Groups — (Array<String>)

          The IDs of one or more security groups.

        • InterfaceType — (String)

          The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon EC2 User Guide.

          If you are not creating an EFA, specify interface or omit this parameter.

          Valid values: interface | efa

        • 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 use this option if specifying specific IPv6 addresses.

        • Ipv6Addresses — (Array<map>)

          One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

          • Ipv6Address — (String)

            The IPv6 address.

        • NetworkInterfaceId — (String)

          The ID of the network interface.

        • PrivateIpAddress — (String)

          The primary private IPv4 address of the network interface.

        • PrivateIpAddresses — (Array<map>)

          One or more private IPv4 addresses.

          • 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.

        • SubnetId — (String)

          The ID of the subnet for the network interface.

        • 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.

        • Ipv4Prefixes — (Array<map>)

          One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

        • Ipv4PrefixCount — (Integer)

          The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.

        • Ipv6Prefixes — (Array<map>)

          One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

          • Ipv6Prefix — (String)

            The IPv6 prefix.

        • Ipv6PrefixCount — (Integer)

          The number of IPv6 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 — (map)

          Configure ENA Express settings for your launch template.

          • EnaSrdEnabled — (Boolean)

            Specifies whether ENA Express is enabled for the network interface when you launch an instance from your launch template.

          • EnaSrdUdpSpecification — (map)

            Contains ENA Express settings for UDP network traffic in your launch template.

            • 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 in your launch template.

        • ConnectionTrackingSpecification — (map)

          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.

          • 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.

      • ImageId — (String)

        The ID of the AMI in the format ami-0ac394d6a3example.

        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: If the launch template will be used for an EC2 Fleet or Spot Fleet, note the following:
        • Only EC2 Fleets of type instant support specifying a Systems Manager parameter.
        • For EC2 Fleets of type maintain or request, or for Spot Fleets, you must specify the AMI ID.
      • InstanceType — (String)

        The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.

        If you specify InstanceType, you can't specify InstanceRequirements.

        Possible values include:
        • "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"
      • KeyName — (String)

        The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

        If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

      • Monitoring — (map)

        The monitoring for the instance.

        • Enabled — (Boolean)

          Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.

      • Placement — (map)

        The placement for the instance.

        • AvailabilityZone — (String)

          The Availability Zone for the instance.

        • Affinity — (String)

          The affinity setting for an instance on a 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.

          Possible values include:
          • "default"
          • "dedicated"
          • "host"
        • SpreadDomain — (String)

          Reserved for future use.

        • HostResourceGroupArn — (String)

          The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

        • 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 a 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.

        We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide.

      • DisableApiTermination — (Boolean)

        If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

      • InstanceInitiatedShutdownBehavior — (String)

        Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

        Default: stop

        Possible values include:
        • "stop"
        • "terminate"
      • UserData — (String)

        The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Amazon EC2 instance at launch in the Amazon EC2 User Guide.

        If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

      • TagSpecifications — (Array<map>)

        The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.

        • ResourceType — (String)

          The type of resource to tag.

          Valid Values lists all resource types for Amazon EC2 that can be tagged. When you create a launch template, you can specify tags for the following resource types only: instance | volume | network-interface | spot-instances-request. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.

          To tag a resource after it has been created, see CreateTags.

          Possible values include:
          • "capacity-reservation"
          • "client-vpn-endpoint"
          • "customer-gateway"
          • "carrier-gateway"
          • "coip-pool"
          • "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"
          • "placement-group"
          • "prefix-list"
          • "replace-root-volume-task"
          • "reserved-instances"
          • "route-table"
          • "security-group"
          • "security-group-rule"
          • "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"
          • "ipam-resource-discovery"
          • "ipam-resource-discovery-association"
          • "instance-connect-endpoint"
          • "ipam-external-resource-verification-token"
        • Tags — (Array<map>)

          The tags to apply to the resource.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

        Deprecated.

        Note: Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
        • Type — required — (String)

          The type of Elastic Graphics accelerator.

      • ElasticInferenceAccelerators — (Array<map>)

        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.

        Note: Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
        • Type — required — (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 — (Array<String>)

        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.

      • SecurityGroups — (Array<String>)

        The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

        If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

      • InstanceMarketOptions — (map)

        The market (purchasing) option for the instances.

        • MarketType — (String)

          The market type.

          Possible values include:
          • "spot"
          • "capacity-block"
        • SpotOptions — (map)

          The options for Spot Instances.

          • MaxPrice — (String)

            The maximum hourly price you're willing to pay for the Spot Instances. 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 specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

          • SpotInstanceType — (String)

            The Spot Instance request type.

            Possible values include:
            • "one-time"
            • "persistent"
          • BlockDurationMinutes — (Integer)

            Deprecated.

          • ValidUntil — (Date)

            The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.

            • For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.

            • For a one-time request, ValidUntil is not supported. The request remains active until all instances launch or you cancel the request.

            Default: 7 days from the current date

          • InstanceInterruptionBehavior — (String)

            The behavior when a Spot Instance is interrupted. The default is terminate.

            Possible values include:
            • "hibernate"
            • "stop"
            • "terminate"
      • CreditSpecification — (map)

        The credit option for CPU usage of the instance. Valid only for T instances.

        • CpuCredits — required — (String)

          The credit option for CPU usage of a T instance.

          Valid values: standard | unlimited

      • CpuOptions — (map)

        The CPU options for the instance. For more information, see Optimize CPU options 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. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.

        • AmdSevSnp — (String)

          Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see AMD SEV-SNP.

          Possible values include:
          • "enabled"
          • "disabled"
      • CapacityReservationSpecification — (map)

        The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

        • 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.

          Possible values include:
          • "open"
          • "none"
        • CapacityReservationTarget — (map)

          Information about the target Capacity Reservation or Capacity Reservation group.

          • CapacityReservationId — (String)

            The ID of the Capacity Reservation in which to run the instance.

          • CapacityReservationResourceGroupArn — (String)

            The ARN of the Capacity Reservation resource group in which to run the instance.

      • LicenseSpecifications — (Array<map>)

        The license configurations.

        • LicenseConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the license configuration.

      • HibernationOptions — (map)

        Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.

        • Configured — (Boolean)

          If you set this parameter to true, the instance is enabled for hibernation.

          Default: false

      • MetadataOptions — (map)

        The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

        • 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, the default is required.

          Possible values include:
          • "optional"
          • "required"
        • 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.
          Possible values include:
          • "disabled"
          • "enabled"
        • HttpProtocolIpv6 — (String)

          Enables or disables the IPv6 endpoint for the instance metadata service.

          Default: disabled

          Possible values include:
          • "disabled"
          • "enabled"
        • 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.

          Default: disabled

          Possible values include:
          • "disabled"
          • "enabled"
      • EnclaveOptions — (map)

        Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

        You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

        • Enabled — (Boolean)

          To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.

      • InstanceRequirements — (map)

        The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

        You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

        When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.

        To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:

        • AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.

        • ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.

        Note: If you specify InstanceRequirements, you can't specify InstanceType. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements.

        For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.

        • VCpuCount — required — (map)

          The minimum and maximum number of vCPUs.

          • Min — required — (Integer)

            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 — required — (map)

          The minimum and maximum amount of memory, in MiB.

          • Min — required — (Integer)

            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 — (Array<String>)

          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.

          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

        • MemoryGiBPerVCpu — (map)

          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 — (Array<String>)

          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

        • InstanceGenerations — (Array<String>)

          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

        • 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

          Possible values include:
          • "included"
          • "required"
          • "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

          Possible values include:
          • "included"
          • "required"
          • "excluded"
        • RequireHibernateSupport — (Boolean)

          Indicates whether instance types must support hibernation for On-Demand Instances.

          This parameter is not supported for GetSpotPlacementScores.

          Default: false

        • NetworkInterfaceCount — (map)

          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

          Possible values include:
          • "included"
          • "required"
          • "excluded"
        • LocalStorageTypes — (Array<String>)

          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

        • TotalLocalStorageGB — (map)

          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 — (map)

          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 — (Array<String>)

          The accelerator types that must be on the instance type.

          • To include instance types with GPU hardware, specify gpu.

          • To include instance types with FPGA hardware, specify fpga.

          • To include instance types with inference hardware, specify inference.

          Default: Any accelerator type

        • AcceleratorCount — (map)

          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 — (Array<String>)

          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

        • AcceleratorNames — (Array<String>)

          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

        • AcceleratorTotalMemoryMiB — (map)

          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 — (map)

          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 — (Array<String>)

          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

        • 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.
      • PrivateDnsNameOptions — (map)

        The options for the instance hostname. The default values are inherited from the subnet.

        • HostnameType — (String)

          The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native 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.

          Possible values include:
          • "ip-name"
          • "resource-name"
        • 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 — (map)

        The maintenance options for the instance.

        • AutoRecovery — (String)

          Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.

          Possible values include:
          • "default"
          • "disabled"
      • DisableApiStop — (Boolean)

        Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.

    • TagSpecifications — (Array<map>)

      The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.

      To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the launch template data structure.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LaunchTemplate — (map)

        Information about the launch template.

        • LaunchTemplateId — (String)

          The ID of the launch template.

        • LaunchTemplateName — (String)

          The name of the launch template.

        • CreateTime — (Date)

          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 — (Array<map>)

          The tags for the launch template.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value — (String)

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • Warning — (map)

        If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.

        • Errors — (Array<map>)

          The error codes and error messages.

          • Code — (String)

            The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error codes.

          • Message — (String)

            The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error codes.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLaunchTemplateVersion(params = {}, callback) ⇒ AWS.Request

Creates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed.

Launch template versions are numbered in the order in which they are created. You can't specify, change, or replace the numbering of launch template versions.

Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes the changes that you require.

For more information, see Modify a launch template (manage launch template versions) in the Amazon EC2 User Guide.

Service Reference:

Examples:

To create a launch template version


/* This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID. */

 var params = {
  LaunchTemplateData: {
   ImageId: "ami-c998b6b2"
  }, 
  LaunchTemplateId: "lt-0abcd290751193123", 
  SourceVersion: "1", 
  VersionDescription: "WebVersion2"
 };
 ec2.createLaunchTemplateVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LaunchTemplateVersion: {
     CreateTime: <Date Representation>, 
     CreatedBy: "arn:aws:iam::123456789012:root", 
     DefaultVersion: false, 
     LaunchTemplateData: {
      ImageId: "ami-c998b6b2", 
      InstanceType: "t2.micro", 
      NetworkInterfaces: [
         {
        AssociatePublicIpAddress: true, 
        DeviceIndex: 0, 
        Ipv6Addresses: [
           {
          Ipv6Address: "2001:db8:1234:1a00::123"
         }
        ], 
        SubnetId: "subnet-7b16de0c"
       }
      ]
     }, 
     LaunchTemplateId: "lt-0abcd290751193123", 
     LaunchTemplateName: "my-template", 
     VersionDescription: "WebVersion2", 
     VersionNumber: 2
    }
   }
   */
 });

Calling the createLaunchTemplateVersion operation

var params = {
  LaunchTemplateData: { /* required */
    BlockDeviceMappings: [
      {
        DeviceName: 'STRING_VALUE',
        Ebs: {
          DeleteOnTermination: true || false,
          Encrypted: true || false,
          Iops: 'NUMBER_VALUE',
          KmsKeyId: 'STRING_VALUE',
          SnapshotId: 'STRING_VALUE',
          Throughput: 'NUMBER_VALUE',
          VolumeSize: 'NUMBER_VALUE',
          VolumeType: standard | io1 | io2 | gp2 | sc1 | st1 | gp3
        },
        NoDevice: 'STRING_VALUE',
        VirtualName: 'STRING_VALUE'
      },
      /* more items */
    ],
    CapacityReservationSpecification: {
      CapacityReservationPreference: open | none,
      CapacityReservationTarget: {
        CapacityReservationId: 'STRING_VALUE',
        CapacityReservationResourceGroupArn: 'STRING_VALUE'
      }
    },
    CpuOptions: {
      AmdSevSnp: enabled | disabled,
      CoreCount: 'NUMBER_VALUE',
      ThreadsPerCore: 'NUMBER_VALUE'
    },
    CreditSpecification: {
      CpuCredits: 'STRING_VALUE' /* required */
    },
    DisableApiStop: true || false,
    DisableApiTermination: true || false,
    EbsOptimized: true || false,
    ElasticGpuSpecifications: [
      {
        Type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ElasticInferenceAccelerators: [
      {
        Type: 'STRING_VALUE', /* required */
        Count: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    EnclaveOptions: {
      Enabled: true || false
    },
    HibernationOptions: {
      Configured: true || false
    },
    IamInstanceProfile: {
      Arn: 'STRING_VALUE',
      Name: 'STRING_VALUE'
    },
    ImageId: 'STRING_VALUE',
    InstanceInitiatedShutdownBehavior: stop | terminate,
    InstanceMarketOptions: {
      MarketType: spot | capacity-block,
      SpotOptions: {
        BlockDurationMinutes: 'NUMBER_VALUE',
        InstanceInterruptionBehavior: hibernate | stop | terminate,
        MaxPrice: 'STRING_VALUE',
        SpotInstanceType: one-time | persistent,
        ValidUntil: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      }
    },
    InstanceRequirements: {
      MemoryMiB: { /* required */
        Min: 'NUMBER_VALUE', /* required */
        Max: 'NUMBER_VALUE'
      },
      VCpuCount: { /* required */
        Min: 'NUMBER_VALUE', /* required */
        Max: 'NUMBER_VALUE'
      },
      AcceleratorCount: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      AcceleratorManufacturers: [
        amazon-web-services | amd | nvidia | xilinx | habana,
        /* more items */
      ],
      AcceleratorNames: [
        a100 | inferentia | k520 | k80 | m60 | radeon-pro-v520 | t4 | vu9p | v100 | a10g | h100 | t4g,
        /* more items */
      ],
      AcceleratorTotalMemoryMiB: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      AcceleratorTypes: [
        gpu | fpga | inference,
        /* more items */
      ],
      AllowedInstanceTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      BareMetal: included | required | excluded,
      BaselineEbsBandwidthMbps: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      BurstablePerformance: included | required | excluded,
      CpuManufacturers: [
        intel | amd | amazon-web-services,
        /* more items */
      ],
      ExcludedInstanceTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      InstanceGenerations: [
        current | previous,
        /* more items */
      ],
      LocalStorage: included | required | excluded,
      LocalStorageTypes: [
        hdd | ssd,
        /* more items */
      ],
      MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: 'NUMBER_VALUE',
      MemoryGiBPerVCpu: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      NetworkBandwidthGbps: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      NetworkInterfaceCount: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      },
      OnDemandMaxPricePercentageOverLowestPrice: 'NUMBER_VALUE',
      RequireHibernateSupport: true || false,
      SpotMaxPricePercentageOverLowestPrice: 'NUMBER_VALUE',
      TotalLocalStorageGB: {
        Max: 'NUMBER_VALUE',
        Min: 'NUMBER_VALUE'
      }
    },
    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,
    KernelId: 'STRING_VALUE',
    KeyName: 'STRING_VALUE',
    LicenseSpecifications: [
      {
        LicenseConfigurationArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    MaintenanceOptions: {
      AutoRecovery: default | disabled
    },
    MetadataOptions: {
      HttpEndpoint: disabled | enabled,
      HttpProtocolIpv6: disabled | enabled,
      HttpPutResponseHopLimit: 'NUMBER_VALUE',
      HttpTokens: optional | required,
      InstanceMetadataTags: disabled | enabled
    },
    Monitoring: {
      Enabled: true || false
    },
    NetworkInterfaces: [
      {
        AssociateCarrierIpAddress: true || false,
        AssociatePublicIpAddress: true || false,
        ConnectionTrackingSpecification: {
          TcpEstablishedTimeout: 'NUMBER_VALUE',
          UdpStreamTimeout: 'NUMBER_VALUE',
          UdpTimeout: 'NUMBER_VALUE'
        },
        DeleteOnTermination: true || false,
        Description: 'STRING_VALUE',
        DeviceIndex: 'NUMBER_VALUE',
        EnaSrdSpecification: {
          EnaSrdEnabled: true || false,
          EnaSrdUdpSpecification: {
            EnaSrdUdpEnabled: true || false
          }
        },
        Groups: [
          'STRING_VALUE',
          /* more items */
        ],
        InterfaceType: 'STRING_VALUE',
        Ipv4PrefixCount: 'NUMBER_VALUE',
        Ipv4Prefixes: [
          {
            Ipv4Prefix: 'STRING_VALUE'
          },
          /* more items */
        ],
        Ipv6AddressCount: 'NUMBER_VALUE',
        Ipv6Addresses: [
          {
            Ipv6Address: 'STRING_VALUE'
          },
          /* more items */
        ],
        Ipv6PrefixCount: 'NUMBER_VALUE',
        Ipv6Prefixes: [
          {
            Ipv6Prefix: 'STRING_VALUE'
          },
          /* more items */
        ],
        NetworkCardIndex: 'NUMBER_VALUE',
        NetworkInterfaceId: 'STRING_VALUE',
        PrimaryIpv6: true || false,
        PrivateIpAddress: 'STRING_VALUE',
        PrivateIpAddresses: [
          {
            Primary: true || false,
            PrivateIpAddress: 'STRING_VALUE'
          },
          /* more items */
        ],
        SecondaryPrivateIpAddressCount: 'NUMBER_VALUE',
        SubnetId: 'STRING_VALUE'
      },
      /* more items */
    ],
    Placement: {
      Affinity: 'STRING_VALUE',
      AvailabilityZone: 'STRING_VALUE',
      GroupId: 'STRING_VALUE',
      GroupName: 'STRING_VALUE',
      HostId: 'STRING_VALUE',
      HostResourceGroupArn: 'STRING_VALUE',
      PartitionNumber: 'NUMBER_VALUE',
      SpreadDomain: 'STRING_VALUE',
      Tenancy: default | dedicated | host
    },
    PrivateDnsNameOptions: {
      EnableResourceNameDnsAAAARecord: true || false,
      EnableResourceNameDnsARecord: true || false,
      HostnameType: ip-name | resource-name
    },
    RamDiskId: 'STRING_VALUE',
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SecurityGroups: [
      'STRING_VALUE',
      /* more items */
    ],
    TagSpecifications: [
      {
        ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
        Tags: [
          {
            Key: 'STRING_VALUE',
            Value: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    UserData: 'STRING_VALUE'
  },
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  LaunchTemplateId: 'STRING_VALUE',
  LaunchTemplateName: 'STRING_VALUE',
  ResolveAlias: true || false,
  SourceVersion: 'STRING_VALUE',
  VersionDescription: 'STRING_VALUE'
};
ec2.createLaunchTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

      Constraint: Maximum 128 ASCII characters.

    • 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.

    • SourceVersion — (String)

      The version of the launch template on which to base the new version. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.

      If you specify this parameter, the new version inherits the launch parameters from the source version. If you specify additional launch parameters for the new version, they overwrite any corresponding launch parameters inherited from the source version.

      If you omit this parameter, the new version contains only the launch parameters that you specify for the new version.

    • VersionDescription — (String)

      A description for the version of the launch template.

    • LaunchTemplateData — (map)

      The information for the launch template.

      • KernelId — (String)

        The ID of the kernel.

        We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide.

      • 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 Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

      • IamInstanceProfile — (map)

        The name or Amazon Resource Name (ARN) of an IAM instance profile.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the instance profile.

        • Name — (String)

          The name of the instance profile.

      • BlockDeviceMappings — (Array<map>)

        The block device mapping.

        • 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.

        • Ebs — (map)

          Parameters used to automatically set up EBS volumes when the instance is launched.

          • Encrypted — (Boolean)

            Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

          • DeleteOnTermination — (Boolean)

            Indicates whether the EBS 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.

            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 supported for io1, io2, and gp3 volumes only.

          • KmsKeyId — (String)

            The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

          • 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. 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

          • VolumeType — (String)

            The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

            Possible values include:
            • "standard"
            • "io1"
            • "io2"
            • "gp2"
            • "sc1"
            • "st1"
            • "gp3"
          • Throughput — (Integer)

            The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

            Valid Range: Minimum value of 125. Maximum value of 1000.

        • NoDevice — (String)

          To omit the device from the block device mapping, specify an empty string.

      • NetworkInterfaces — (Array<map>)

        The network interfaces for the instance.

        • AssociateCarrierIpAddress — (Boolean)

          Associates 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 addresses in the Wavelength Developer Guide.

        • AssociatePublicIpAddress — (Boolean)

          Associates 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. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.

        • Groups — (Array<String>)

          The IDs of one or more security groups.

        • InterfaceType — (String)

          The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon EC2 User Guide.

          If you are not creating an EFA, specify interface or omit this parameter.

          Valid values: interface | efa

        • 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 use this option if specifying specific IPv6 addresses.

        • Ipv6Addresses — (Array<map>)

          One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

          • Ipv6Address — (String)

            The IPv6 address.

        • NetworkInterfaceId — (String)

          The ID of the network interface.

        • PrivateIpAddress — (String)

          The primary private IPv4 address of the network interface.

        • PrivateIpAddresses — (Array<map>)

          One or more private IPv4 addresses.

          • 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.

        • SubnetId — (String)

          The ID of the subnet for the network interface.

        • 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.

        • Ipv4Prefixes — (Array<map>)

          One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

        • Ipv4PrefixCount — (Integer)

          The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.

        • Ipv6Prefixes — (Array<map>)

          One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

          • Ipv6Prefix — (String)

            The IPv6 prefix.

        • Ipv6PrefixCount — (Integer)

          The number of IPv6 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 — (map)

          Configure ENA Express settings for your launch template.

          • EnaSrdEnabled — (Boolean)

            Specifies whether ENA Express is enabled for the network interface when you launch an instance from your launch template.

          • EnaSrdUdpSpecification — (map)

            Contains ENA Express settings for UDP network traffic in your launch template.

            • 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 in your launch template.

        • ConnectionTrackingSpecification — (map)

          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.

          • 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.

      • ImageId — (String)

        The ID of the AMI in the format ami-0ac394d6a3example.

        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: If the launch template will be used for an EC2 Fleet or Spot Fleet, note the following:
        • Only EC2 Fleets of type instant support specifying a Systems Manager parameter.
        • For EC2 Fleets of type maintain or request, or for Spot Fleets, you must specify the AMI ID.
      • InstanceType — (String)

        The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.

        If you specify InstanceType, you can't specify InstanceRequirements.

        Possible values include:
        • "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"
      • KeyName — (String)

        The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

        If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

      • Monitoring — (map)

        The monitoring for the instance.

        • Enabled — (Boolean)

          Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.

      • Placement — (map)

        The placement for the instance.

        • AvailabilityZone — (String)

          The Availability Zone for the instance.

        • Affinity — (String)

          The affinity setting for an instance on a 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.

          Possible values include:
          • "default"
          • "dedicated"
          • "host"
        • SpreadDomain — (String)

          Reserved for future use.

        • HostResourceGroupArn — (String)

          The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

        • 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 a 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.

        We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide.

      • DisableApiTermination — (Boolean)

        If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

      • InstanceInitiatedShutdownBehavior — (String)

        Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

        Default: stop

        Possible values include:
        • "stop"
        • "terminate"
      • UserData — (String)

        The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Amazon EC2 instance at launch in the Amazon EC2 User Guide.

        If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

      • TagSpecifications — (Array<map>)

        The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.

        • ResourceType — (String)

          The type of resource to tag.

          Valid Values lists all resource types for Amazon EC2 that can be tagged. When you create a launch template, you can specify tags for the following resource types only: instance | volume | network-interface | spot-instances-request. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.

          To tag a resource after it has been created, see CreateTags.

          Possible values include:
          • "capacity-reservation"
          • "client-vpn-endpoint"
          • "customer-gateway"
          • "carrier-gateway"
          • "coip-pool"
          • "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"
          • "placement-group"
          • "prefix-list"
          • "replace-root-volume-task"
          • "reserved-instances"
          • "route-table"
          • "security-group"
          • "security-group-rule"
          • "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"
          • "ipam-resource-discovery"
          • "ipam-resource-discovery-association"
          • "instance-connect-endpoint"
          • "ipam-external-resource-verification-token"
        • Tags — (Array<map>)

          The tags to apply to the resource.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

        Deprecated.

        Note: Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
        • Type — required — (String)

          The type of Elastic Graphics accelerator.

      • ElasticInferenceAccelerators — (Array<map>)

        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.

        Note: Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
        • Type — required — (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 — (Array<String>)

        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.

      • SecurityGroups — (Array<String>)

        The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

        If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

      • InstanceMarketOptions — (map)

        The market (purchasing) option for the instances.

        • MarketType — (String)

          The market type.

          Possible values include:
          • "spot"
          • "capacity-block"
        • SpotOptions — (map)

          The options for Spot Instances.

          • MaxPrice — (String)

            The maximum hourly price you're willing to pay for the Spot Instances. 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 specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

          • SpotInstanceType — (String)

            The Spot Instance request type.

            Possible values include:
            • "one-time"
            • "persistent"
          • BlockDurationMinutes — (Integer)

            Deprecated.

          • ValidUntil — (Date)

            The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.

            • For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.

            • For a one-time request, ValidUntil is not supported. The request remains active until all instances launch or you cancel the request.

            Default: 7 days from the current date

          • InstanceInterruptionBehavior — (String)

            The behavior when a Spot Instance is interrupted. The default is terminate.

            Possible values include:
            • "hibernate"
            • "stop"
            • "terminate"
      • CreditSpecification — (map)

        The credit option for CPU usage of the instance. Valid only for T instances.

        • CpuCredits — required — (String)

          The credit option for CPU usage of a T instance.

          Valid values: standard | unlimited

      • CpuOptions — (map)

        The CPU options for the instance. For more information, see Optimize CPU options 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. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.

        • AmdSevSnp — (String)

          Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see AMD SEV-SNP.

          Possible values include:
          • "enabled"
          • "disabled"
      • CapacityReservationSpecification — (map)

        The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

        • 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.

          Possible values include:
          • "open"
          • "none"
        • CapacityReservationTarget — (map)

          Information about the target Capacity Reservation or Capacity Reservation group.

          • CapacityReservationId — (String)

            The ID of the Capacity Reservation in which to run the instance.

          • CapacityReservationResourceGroupArn — (String)

            The ARN of the Capacity Reservation resource group in which to run the instance.

      • LicenseSpecifications — (Array<map>)

        The license configurations.

        • LicenseConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the license configuration.

      • HibernationOptions — (map)

        Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.

        • Configured — (Boolean)

          If you set this parameter to true, the instance is enabled for hibernation.

          Default: false

      • MetadataOptions — (map)

        The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

        • 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, the default is required.

          Possible values include:
          • "optional"
          • "required"
        • 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.
          Possible values include:
          • "disabled"
          • "enabled"
        • HttpProtocolIpv6 — (String)

          Enables or disables the IPv6 endpoint for the instance metadata service.

          Default: disabled

          Possible values include:
          • "disabled"
          • "enabled"
        • 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.

          Default: disabled

          Possible values include:
          • "disabled"
          • "enabled"
      • EnclaveOptions — (map)

        Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

        You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

        • Enabled — (Boolean)

          To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.

      • InstanceRequirements — (map)

        The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

        You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

        When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.

        To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:

        • AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.

        • ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.

        Note: If you specify InstanceRequirements, you can't specify InstanceType. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements.

        For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.

        • VCpuCount — required — (map)

          The minimum and maximum number of vCPUs.

          • Min — required — (Integer)

            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 — required — (map)

          The minimum and maximum amount of memory, in MiB.

          • Min — required — (Integer)

            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 — (Array<String>)

          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.

          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

        • MemoryGiBPerVCpu — (map)

          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 — (Array<String>)

          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

        • InstanceGenerations — (Array<String>)

          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

        • 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

          Possible values include:
          • "included"
          • "required"
          • "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

          Possible values include:
          • "included"
          • "required"
          • "excluded"
        • RequireHibernateSupport — (Boolean)

          Indicates whether instance types must support hibernation for On-Demand Instances.

          This parameter is not supported for GetSpotPlacementScores.

          Default: false

        • NetworkInterfaceCount — (map)

          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

          Possible values include:
          • "included"
          • "required"
          • "excluded"
        • LocalStorageTypes — (Array<String>)

          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

        • TotalLocalStorageGB — (map)

          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 — (map)

          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 — (Array<String>)

          The accelerator types that must be on the instance type.

          • To include instance types with GPU hardware, specify gpu.

          • To include instance types with FPGA hardware, specify fpga.

          • To include instance types with inference hardware, specify inference.

          Default: Any accelerator type

        • AcceleratorCount — (map)

          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 — (Array<String>)

          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

        • AcceleratorNames — (Array<String>)

          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

        • AcceleratorTotalMemoryMiB — (map)

          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 — (map)

          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 — (Array<String>)

          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

        • 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.
      • PrivateDnsNameOptions — (map)

        The options for the instance hostname. The default values are inherited from the subnet.

        • HostnameType — (String)

          The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native 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.

          Possible values include:
          • "ip-name"
          • "resource-name"
        • 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 — (map)

        The maintenance options for the instance.

        • AutoRecovery — (String)

          Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.

          Possible values include:
          • "default"
          • "disabled"
      • DisableApiStop — (Boolean)

        Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.

    • ResolveAlias — (Boolean)

      If true, and if a Systems Manager parameter is specified for ImageId, the AMI ID 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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LaunchTemplateVersion — (map)

        Information about the 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 — (Date)

          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 — (map)

          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 — (map)

            The IAM instance profile.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the instance profile.

            • Name — (String)

              The name of the instance profile.

          • BlockDeviceMappings — (Array<map>)

            The block device mappings.

            • DeviceName — (String)

              The device name.

            • VirtualName — (String)

              The virtual device name (ephemeralN).

            • Ebs — (map)

              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)

                The ARN of the Key Management Service (KMS) CMK used for encryption.

              • SnapshotId — (String)

                The ID of the snapshot.

              • VolumeSize — (Integer)

                The size of the volume, in GiB.

              • VolumeType — (String)

                The volume type.

                Possible values include:
                • "standard"
                • "io1"
                • "io2"
                • "gp2"
                • "sc1"
                • "st1"
                • "gp3"
              • Throughput — (Integer)

                The throughput that the volume supports, in MiB/s.

            • NoDevice — (String)

              To omit the device from the block device mapping, specify an empty string.

          • NetworkInterfaces — (Array<map>)

            The network interfaces.

            • 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 addresses 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 — (Array<String>)

              The IDs of one or more security groups.

            • InterfaceType — (String)

              The type of network interface.

            • Ipv6AddressCount — (Integer)

              The number of IPv6 addresses for the network interface.

            • Ipv6Addresses — (Array<map>)

              The IPv6 addresses for the network interface.

              • 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 — (Array<map>)

              One or more private IPv4 addresses.

              • 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 — (Array<map>)

              One or more IPv4 prefixes assigned to the 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 — (Array<map>)

              One or more IPv6 prefixes assigned to the 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 — (map)

              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 — (map)

                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 — (map)

              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.

          • 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.

            Possible values include:
            • "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"
          • KeyName — (String)

            The name of the key pair.

          • Monitoring — (map)

            The monitoring for the instance.

            • Enabled — (Boolean)

              Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

          • Placement — (map)

            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.

              Possible values include:
              • "default"
              • "dedicated"
              • "host"
            • 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).

            Possible values include:
            • "stop"
            • "terminate"
          • UserData — (String)

            The user data for the instance.

          • TagSpecifications — (Array<map>)

            The tags that are applied to the resources that are created during instance launch.

            • ResourceType — (String)

              The type of resource to tag.

              Possible values include:
              • "capacity-reservation"
              • "client-vpn-endpoint"
              • "customer-gateway"
              • "carrier-gateway"
              • "coip-pool"
              • "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"
              • "placement-group"
              • "prefix-list"
              • "replace-root-volume-task"
              • "reserved-instances"
              • "route-table"
              • "security-group"
              • "security-group-rule"
              • "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"
              • "ipam-resource-discovery"
              • "ipam-resource-discovery-association"
              • "instance-connect-endpoint"
              • "ipam-external-resource-verification-token"
            • Tags — (Array<map>)

              The tags for the resource.

              • Key — (String)

                The key of the tag.

                Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

            Deprecated.

            Note: Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
            • Type — (String)

              Deprecated.

              Note: Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
          • ElasticInferenceAccelerators — (Array<map>)

            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.

            Note: Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
            • 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 — (Array<String>)

            The security group IDs.

          • SecurityGroups — (Array<String>)

            The security group names.

          • InstanceMarketOptions — (map)

            The market (purchasing) option for the instances.

            • MarketType — (String)

              The market type.

              Possible values include:
              • "spot"
              • "capacity-block"
            • SpotOptions — (map)

              The options for Spot Instances.

              • MaxPrice — (String)

                The maximum hourly price you're willing to pay for the Spot Instances. 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 specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

              • SpotInstanceType — (String)

                The Spot Instance request type.

                Possible values include:
                • "one-time"
                • "persistent"
              • 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 — (Date)

                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.

                Possible values include:
                • "hibernate"
                • "stop"
                • "terminate"
          • CreditSpecification — (map)

            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 — (map)

            The CPU options for the instance. For more information, see Optimize CPU options 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.

              Possible values include:
              • "enabled"
              • "disabled"
          • CapacityReservationSpecification — (map)

            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.

              Possible values include:
              • "open"
              • "none"
            • CapacityReservationTarget — (map)

              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 — (Array<map>)

            The license configurations.

            • LicenseConfigurationArn — (String)

              The Amazon Resource Name (ARN) of the license configuration.

          • HibernationOptions — (map)

            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 — (map)

            The metadata options for the instance. For more information, see Instance metadata and user data 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.

              Possible values include:
              • "pending"
              • "applied"
            • 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.

              Possible values include:
              • "optional"
              • "required"
            • 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.
              Possible values include:
              • "disabled"
              • "enabled"
            • HttpProtocolIpv6 — (String)

              Enables or disables the IPv6 endpoint for the instance metadata service.

              Default: disabled

              Possible values include:
              • "disabled"
              • "enabled"
            • 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.

              Default: disabled

              Possible values include:
              • "disabled"
              • "enabled"
          • EnclaveOptions — (map)

            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 — (map)

            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 — (map)

              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 — (map)

              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 — (Array<String>)

              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.

              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

            • MemoryGiBPerVCpu — (map)

              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 — (Array<String>)

              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

            • InstanceGenerations — (Array<String>)

              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

            • 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

              Possible values include:
              • "included"
              • "required"
              • "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

              Possible values include:
              • "included"
              • "required"
              • "excluded"
            • RequireHibernateSupport — (Boolean)

              Indicates whether instance types must support hibernation for On-Demand Instances.

              This parameter is not supported for GetSpotPlacementScores.

              Default: false

            • NetworkInterfaceCount — (map)

              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

              Possible values include:
              • "included"
              • "required"
              • "excluded"
            • LocalStorageTypes — (Array<String>)

              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

            • TotalLocalStorageGB — (map)

              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 — (map)

              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 — (Array<String>)

              The accelerator types that must be on the instance type.

              • For instance types with GPU accelerators, specify gpu.

              • For instance types with FPGA accelerators, specify fpga.

              • For instance types with inference accelerators, specify inference.

              Default: Any accelerator type

            • AcceleratorCount — (map)

              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 — (Array<String>)

              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

            • AcceleratorNames — (Array<String>)

              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

            • AcceleratorTotalMemoryMiB — (map)

              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 — (map)

              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 — (Array<String>)

              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

            • 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.
          • PrivateDnsNameOptions — (map)

            The options for the instance hostname.

            • HostnameType — (String)

              The type of hostname to assign to an instance.

              Possible values include:
              • "ip-name"
              • "resource-name"
            • 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 — (map)

            The maintenance options for your instance.

            • AutoRecovery — (String)

              Disables the automatic recovery behavior of your instance or sets it to default.

              Possible values include:
              • "default"
              • "disabled"
          • DisableApiStop — (Boolean)

            Indicates whether the instance is enabled for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.

      • Warning — (map)

        If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.

        • Errors — (Array<map>)

          The error codes and error messages.

          • Code — (String)

            The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error codes.

          • Message — (String)

            The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error codes.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLocalGatewayRoute(params = {}, callback) ⇒ AWS.Request

Creates a static route for the specified local gateway route table. You must specify one of the following targets:

  • LocalGatewayVirtualInterfaceGroupId

  • NetworkInterfaceId

Service Reference:

Examples:

Calling the createLocalGatewayRoute operation

var params = {
  LocalGatewayRouteTableId: 'STRING_VALUE', /* required */
  DestinationCidrBlock: 'STRING_VALUE',
  DestinationPrefixListId: 'STRING_VALUE',
  DryRun: true || false,
  LocalGatewayVirtualInterfaceGroupId: 'STRING_VALUE',
  NetworkInterfaceId: 'STRING_VALUE'
};
ec2.createLocalGatewayRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DestinationCidrBlock — (String)

      The CIDR range used for destination matches. Routing decisions are based on the most specific match.

    • LocalGatewayRouteTableId — (String)

      The ID of the local gateway route table.

    • LocalGatewayVirtualInterfaceGroupId — (String)

      The ID of the virtual interface group.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Route — (map)

        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.

          Possible values include:
          • "static"
          • "propagated"
        • State — (String)

          The state of the route.

          Possible values include:
          • "pending"
          • "active"
          • "blackhole"
          • "deleting"
          • "deleted"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLocalGatewayRouteTable(params = {}, callback) ⇒ AWS.Request

Creates a local gateway route table.

Service Reference:

Examples:

Calling the createLocalGatewayRouteTable operation

var params = {
  LocalGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Mode: direct-vpc-routing | coip,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createLocalGatewayRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayId — (String)

      The ID of the local gateway.

    • Mode — (String)

      The mode of the local gateway route table.

      Possible values include:
      • "direct-vpc-routing"
      • "coip"
    • TagSpecifications — (Array<map>)

      The tags assigned to the local gateway route table.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTable — (map)

        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 — (Array<map>)

          The tags assigned to the local gateway route table.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "direct-vpc-routing"
          • "coip"
        • StateReason — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLocalGatewayRouteTableVirtualInterfaceGroupAssociation(params = {}, callback) ⇒ AWS.Request

Creates a local gateway route table virtual interface group association.

Service Reference:

Examples:

Calling the createLocalGatewayRouteTableVirtualInterfaceGroupAssociation operation

var params = {
  LocalGatewayRouteTableId: 'STRING_VALUE', /* required */
  LocalGatewayVirtualInterfaceGroupId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createLocalGatewayRouteTableVirtualInterfaceGroupAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableId — (String)

      The ID of the local gateway route table.

    • LocalGatewayVirtualInterfaceGroupId — (String)

      The ID of the local gateway route table virtual interface group association.

    • TagSpecifications — (Array<map>)

      The tags assigned to the local gateway route table virtual interface group association.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTableVirtualInterfaceGroupAssociation — (map)

        Information about the local gateway route table virtual interface group association.

        • LocalGatewayRouteTableVirtualInterfaceGroupAssociationId — (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 — (Array<map>)

          The tags assigned to the association.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLocalGatewayRouteTableVpcAssociation(params = {}, callback) ⇒ AWS.Request

Associates the specified VPC with the specified local gateway route table.

Service Reference:

Examples:

Calling the createLocalGatewayRouteTableVpcAssociation operation

var params = {
  LocalGatewayRouteTableId: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createLocalGatewayRouteTableVpcAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableId — (String)

      The ID of the local gateway route table.

    • VpcId — (String)

      The ID of the VPC.

    • TagSpecifications — (Array<map>)

      The tags to assign to the local gateway route table VPC association.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTableVpcAssociation — (map)

        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 — (Array<map>)

          The tags assigned to the association.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createManagedPrefixList(params = {}, callback) ⇒ AWS.Request

Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.

Service Reference:

Examples:

Calling the createManagedPrefixList operation

var params = {
  AddressFamily: 'STRING_VALUE', /* required */
  MaxEntries: 'NUMBER_VALUE', /* required */
  PrefixListName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  Entries: [
    {
      Cidr: 'STRING_VALUE', /* required */
      Description: 'STRING_VALUE'
    },
    /* more items */
  ],
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createManagedPrefixList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      A name for the prefix list.

      Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

    • Entries — (Array<map>)

      One or more entries for the prefix list.

      • Cidr — required — (String)

        The CIDR block.

      • Description — (String)

        A description for the entry.

        Constraints: Up to 255 characters in length.

    • MaxEntries — (Integer)

      The maximum number of entries for the prefix list.

    • TagSpecifications — (Array<map>)

      The tags to apply to the prefix list during creation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PrefixList — (map)

        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.

          Possible values include:
          • "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)

          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 — (Array<map>)

          The tags for the prefix list.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNatGateway(params = {}, callback) ⇒ AWS.Request

Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.

With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.

With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.

For more information, see NAT gateways in the Amazon VPC User Guide.

When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.

Service Reference:

Examples:

To create a NAT gateway


/* 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. */

 var params = {
  AllocationId: "eipalloc-37fc1a52", 
  SubnetId: "subnet-1a2b3c4d"
 };
 ec2.createNatGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NatGateway: {
     CreateTime: <Date Representation>, 
     NatGatewayAddresses: [
        {
       AllocationId: "eipalloc-37fc1a52"
      }
     ], 
     NatGatewayId: "nat-08d48af2a8e83edfd", 
     State: "pending", 
     SubnetId: "subnet-1a2b3c4d", 
     VpcId: "vpc-1122aabb"
    }
   }
   */
 });

Calling the createNatGateway operation

var params = {
  SubnetId: 'STRING_VALUE', /* required */
  AllocationId: 'STRING_VALUE',
  ClientToken: 'STRING_VALUE',
  ConnectivityType: private | public,
  DryRun: true || false,
  PrivateIpAddress: 'STRING_VALUE',
  SecondaryAllocationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SecondaryPrivateIpAddressCount: 'NUMBER_VALUE',
  SecondaryPrivateIpAddresses: [
    'STRING_VALUE',
    /* more items */
  ],
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createNatGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 in which to create the NAT gateway.

    • TagSpecifications — (Array<map>)

      The tags to assign to the NAT gateway.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      Possible values include:
      • "private"
      • "public"
    • 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 — (Array<String>)

      Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.

    • SecondaryPrivateIpAddresses — (Array<String>)

      Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (map)

        Information about the NAT gateway.

        • CreateTime — (Date)

          The date and time the NAT gateway was created.

        • DeleteTime — (Date)

          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 — (Array<map>)

          Information about the IP addresses and network interface associated with the 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.

            Possible values include:
            • "assigning"
            • "unassigning"
            • "associating"
            • "disassociating"
            • "succeeded"
            • "failed"
        • NatGatewayId — (String)

          The ID of the NAT gateway.

        • ProvisionedBandwidth — (map)

          Reserved. If you need to sustain traffic greater than the documented limits, contact Amazon Web Services Support.

          • ProvisionTime — (Date)

            Reserved.

          • Provisioned — (String)

            Reserved.

          • RequestTime — (Date)

            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.

          Possible values include:
          • "pending"
          • "failed"
          • "available"
          • "deleting"
          • "deleted"
        • 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 — (Array<map>)

          The tags for the NAT gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "private"
          • "public"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNetworkAcl(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a network ACL


/* This example creates a network ACL for the specified VPC. */

 var params = {
  VpcId: "vpc-a01106c2"
 };
 ec2.createNetworkAcl(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NetworkAcl: {
     Associations: [
     ], 
     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"
    }
   }
   */
 });

Calling the createNetworkAcl operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createNetworkAcl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the VPC.

    • TagSpecifications — (Array<map>)

      The tags to assign to the network ACL.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkAcl — (map)

        Information about the network ACL.

        • Associations — (Array<map>)

          Any associations between the network ACL and your subnets

          • 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 — (Array<map>)

          The entries (rules) in the 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 — (map)

            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 — (map)

            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.

            Possible values include:
            • "allow"
            • "deny"
          • 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 — (Array<map>)

          Any tags assigned to the network ACL.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      • ClientToken — (String)

        Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNetworkAclEntry(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a network ACL entry


/* This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet. */

 var params = {
  CidrBlock: "0.0.0.0/0", 
  Egress: false, 
  NetworkAclId: "acl-5fb85d36", 
  PortRange: {
   From: 53, 
   To: 53
  }, 
  Protocol: "17", 
  RuleAction: "allow", 
  RuleNumber: 100
 };
 ec2.createNetworkAclEntry(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the createNetworkAclEntry operation

var params = {
  Egress: true || false, /* required */
  NetworkAclId: 'STRING_VALUE', /* required */
  Protocol: 'STRING_VALUE', /* required */
  RuleAction: allow | deny, /* required */
  RuleNumber: 'NUMBER_VALUE', /* required */
  CidrBlock: 'STRING_VALUE',
  DryRun: true || false,
  IcmpTypeCode: {
    Code: 'NUMBER_VALUE',
    Type: 'NUMBER_VALUE'
  },
  Ipv6CidrBlock: 'STRING_VALUE',
  PortRange: {
    From: 'NUMBER_VALUE',
    To: 'NUMBER_VALUE'
  }
};
ec2.createNetworkAclEntry(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • Egress — (Boolean)

      Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

    • IcmpTypeCode — (map)

      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.

    • Ipv6CidrBlock — (String)

      The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).

    • NetworkAclId — (String)

      The ID of the network ACL.

    • PortRange — (map)

      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.

    • Protocol — (String)

      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)

      Indicates whether to allow or deny the traffic that matches the rule.

      Possible values include:
      • "allow"
      • "deny"
    • RuleNumber — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNetworkInsightsAccessScope(params = {}, callback) ⇒ AWS.Request

Creates a Network Access Scope.

Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.

Service Reference:

Examples:

Calling the createNetworkInsightsAccessScope operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DryRun: true || false,
  ExcludePaths: [
    {
      Destination: {
        PacketHeaderStatement: {
          DestinationAddresses: [
            'STRING_VALUE',
            /* more items */
          ],
          DestinationPorts: [
            'STRING_VALUE',
            /* more items */
          ],
          DestinationPrefixLists: [
            'STRING_VALUE',
            /* more items */
          ],
          Protocols: [
            tcp | udp,
            /* more items */
          ],
          SourceAddresses: [
            'STRING_VALUE',
            /* more items */
          ],
          SourcePorts: [
            'STRING_VALUE',
            /* more items */
          ],
          SourcePrefixLists: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        ResourceStatement: {
          ResourceTypes: [
            'STRING_VALUE',
            /* more items */
          ],
          Resources: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      Source: {
        PacketHeaderStatement: {
          DestinationAddresses: [
            'STRING_VALUE',
            /* more items */
          ],
          DestinationPorts: [
            'STRING_VALUE',
            /* more items */
          ],
          DestinationPrefixLists: [
            'STRING_VALUE',
            /* more items */
          ],
          Protocols: [
            tcp | udp,
            /* more items */
          ],
          SourceAddresses: [
            'STRING_VALUE',
            /* more items */
          ],
          SourcePorts: [
            'STRING_VALUE',
            /* more items */
          ],
          SourcePrefixLists: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        ResourceStatement: {
          ResourceTypes: [
            'STRING_VALUE',
            /* more items */
          ],
          Resources: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      ThroughResources: [
        {
          ResourceStatement: {
            ResourceTypes: [
              'STRING_VALUE',
              /* more items */
            ],
            Resources: [
              'STRING_VALUE',
              /* more items */
            ]
          }
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  MatchPaths: [
    {
      Destination: {
        PacketHeaderStatement: {
          DestinationAddresses: [
            'STRING_VALUE',
            /* more items */
          ],
          DestinationPorts: [
            'STRING_VALUE',
            /* more items */
          ],
          DestinationPrefixLists: [
            'STRING_VALUE',
            /* more items */
          ],
          Protocols: [
            tcp | udp,
            /* more items */
          ],
          SourceAddresses: [
            'STRING_VALUE',
            /* more items */
          ],
          SourcePorts: [
            'STRING_VALUE',
            /* more items */
          ],
          SourcePrefixLists: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        ResourceStatement: {
          ResourceTypes: [
            'STRING_VALUE',
            /* more items */
          ],
          Resources: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      Source: {
        PacketHeaderStatement: {
          DestinationAddresses: [
            'STRING_VALUE',
            /* more items */
          ],
          DestinationPorts: [
            'STRING_VALUE',
            /* more items */
          ],
          DestinationPrefixLists: [
            'STRING_VALUE',
            /* more items */
          ],
          Protocols: [
            tcp | udp,
            /* more items */
          ],
          SourceAddresses: [
            'STRING_VALUE',
            /* more items */
          ],
          SourcePorts: [
            'STRING_VALUE',
            /* more items */
          ],
          SourcePrefixLists: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        ResourceStatement: {
          ResourceTypes: [
            'STRING_VALUE',
            /* more items */
          ],
          Resources: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      ThroughResources: [
        {
          ResourceStatement: {
            ResourceTypes: [
              'STRING_VALUE',
              /* more items */
            ],
            Resources: [
              'STRING_VALUE',
              /* more items */
            ]
          }
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createNetworkInsightsAccessScope(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MatchPaths — (Array<map>)

      The paths to match.

      • Source — (map)

        The source.

        • PacketHeaderStatement — (map)

          The packet header statement.

          • SourceAddresses — (Array<String>)

            The source addresses.

          • DestinationAddresses — (Array<String>)

            The destination addresses.

          • SourcePorts — (Array<String>)

            The source ports.

          • DestinationPorts — (Array<String>)

            The destination ports.

          • SourcePrefixLists — (Array<String>)

            The source prefix lists.

          • DestinationPrefixLists — (Array<String>)

            The destination prefix lists.

          • Protocols — (Array<String>)

            The protocols.

        • ResourceStatement — (map)

          The resource statement.

          • Resources — (Array<String>)

            The resources.

          • ResourceTypes — (Array<String>)

            The resource types.

      • Destination — (map)

        The destination.

        • PacketHeaderStatement — (map)

          The packet header statement.

          • SourceAddresses — (Array<String>)

            The source addresses.

          • DestinationAddresses — (Array<String>)

            The destination addresses.

          • SourcePorts — (Array<String>)

            The source ports.

          • DestinationPorts — (Array<String>)

            The destination ports.

          • SourcePrefixLists — (Array<String>)

            The source prefix lists.

          • DestinationPrefixLists — (Array<String>)

            The destination prefix lists.

          • Protocols — (Array<String>)

            The protocols.

        • ResourceStatement — (map)

          The resource statement.

          • Resources — (Array<String>)

            The resources.

          • ResourceTypes — (Array<String>)

            The resource types.

      • ThroughResources — (Array<map>)

        The through resources.

        • ResourceStatement — (map)

          The resource statement.

          • Resources — (Array<String>)

            The resources.

          • ResourceTypes — (Array<String>)

            The resource types.

    • ExcludePaths — (Array<map>)

      The paths to exclude.

      • Source — (map)

        The source.

        • PacketHeaderStatement — (map)

          The packet header statement.

          • SourceAddresses — (Array<String>)

            The source addresses.

          • DestinationAddresses — (Array<String>)

            The destination addresses.

          • SourcePorts — (Array<String>)

            The source ports.

          • DestinationPorts — (Array<String>)

            The destination ports.

          • SourcePrefixLists — (Array<String>)

            The source prefix lists.

          • DestinationPrefixLists — (Array<String>)

            The destination prefix lists.

          • Protocols — (Array<String>)

            The protocols.

        • ResourceStatement — (map)

          The resource statement.

          • Resources — (Array<String>)

            The resources.

          • ResourceTypes — (Array<String>)

            The resource types.

      • Destination — (map)

        The destination.

        • PacketHeaderStatement — (map)

          The packet header statement.

          • SourceAddresses — (Array<String>)

            The source addresses.

          • DestinationAddresses — (Array<String>)

            The destination addresses.

          • SourcePorts — (Array<String>)

            The source ports.

          • DestinationPorts — (Array<String>)

            The destination ports.

          • SourcePrefixLists — (Array<String>)

            The source prefix lists.

          • DestinationPrefixLists — (Array<String>)

            The destination prefix lists.

          • Protocols — (Array<String>)

            The protocols.

        • ResourceStatement — (map)

          The resource statement.

          • Resources — (Array<String>)

            The resources.

          • ResourceTypes — (Array<String>)

            The resource types.

      • ThroughResources — (Array<map>)

        The through resources.

        • ResourceStatement — (map)

          The resource statement.

          • Resources — (Array<String>)

            The resources.

          • ResourceTypes — (Array<String>)

            The resource types.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • TagSpecifications — (Array<map>)

      The tags to apply.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsAccessScope — (map)

        The 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 — (Date)

          The creation date.

        • UpdatedDate — (Date)

          The last updated date.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value — (String)

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • NetworkInsightsAccessScopeContent — (map)

        The Network Access Scope content.

        • NetworkInsightsAccessScopeId — (String)

          The ID of the Network Access Scope.

        • MatchPaths — (Array<map>)

          The paths to match.

          • Source — (map)

            The source.

            • PacketHeaderStatement — (map)

              The packet header statement.

              • SourceAddresses — (Array<String>)

                The source addresses.

              • DestinationAddresses — (Array<String>)

                The destination addresses.

              • SourcePorts — (Array<String>)

                The source ports.

              • DestinationPorts — (Array<String>)

                The destination ports.

              • SourcePrefixLists — (Array<String>)

                The source prefix lists.

              • DestinationPrefixLists — (Array<String>)

                The destination prefix lists.

              • Protocols — (Array<String>)

                The protocols.

            • ResourceStatement — (map)

              The resource statement.

              • Resources — (Array<String>)

                The resources.

              • ResourceTypes — (Array<String>)

                The resource types.

          • Destination — (map)

            The destination.

            • PacketHeaderStatement — (map)

              The packet header statement.

              • SourceAddresses — (Array<String>)

                The source addresses.

              • DestinationAddresses — (Array<String>)

                The destination addresses.

              • SourcePorts — (Array<String>)

                The source ports.

              • DestinationPorts — (Array<String>)

                The destination ports.

              • SourcePrefixLists — (Array<String>)

                The source prefix lists.

              • DestinationPrefixLists — (Array<String>)

                The destination prefix lists.

              • Protocols — (Array<String>)

                The protocols.

            • ResourceStatement — (map)

              The resource statement.

              • Resources — (Array<String>)

                The resources.

              • ResourceTypes — (Array<String>)

                The resource types.

          • ThroughResources — (Array<map>)

            The through resources.

            • ResourceStatement — (map)

              The resource statement.

              • Resources — (Array<String>)

                The resources.

              • ResourceTypes — (Array<String>)

                The resource types.

        • ExcludePaths — (Array<map>)

          The paths to exclude.

          • Source — (map)

            The source.

            • PacketHeaderStatement — (map)

              The packet header statement.

              • SourceAddresses — (Array<String>)

                The source addresses.

              • DestinationAddresses — (Array<String>)

                The destination addresses.

              • SourcePorts — (Array<String>)

                The source ports.

              • DestinationPorts — (Array<String>)

                The destination ports.

              • SourcePrefixLists — (Array<String>)

                The source prefix lists.

              • DestinationPrefixLists — (Array<String>)

                The destination prefix lists.

              • Protocols — (Array<String>)

                The protocols.

            • ResourceStatement — (map)

              The resource statement.

              • Resources — (Array<String>)

                The resources.

              • ResourceTypes — (Array<String>)

                The resource types.

          • Destination — (map)

            The destination.

            • PacketHeaderStatement — (map)

              The packet header statement.

              • SourceAddresses — (Array<String>)

                The source addresses.

              • DestinationAddresses — (Array<String>)

                The destination addresses.

              • SourcePorts — (Array<String>)

                The source ports.

              • DestinationPorts — (Array<String>)

                The destination ports.

              • SourcePrefixLists — (Array<String>)

                The source prefix lists.

              • DestinationPrefixLists — (Array<String>)

                The destination prefix lists.

              • Protocols — (Array<String>)

                The protocols.

            • ResourceStatement — (map)

              The resource statement.

              • Resources — (Array<String>)

                The resources.

              • ResourceTypes — (Array<String>)

                The resource types.

          • ThroughResources — (Array<map>)

            The through resources.

            • ResourceStatement — (map)

              The resource statement.

              • Resources — (Array<String>)

                The resources.

              • ResourceTypes — (Array<String>)

                The resource types.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNetworkInsightsPath(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createNetworkInsightsPath operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  Protocol: tcp | udp, /* required */
  Source: 'STRING_VALUE', /* required */
  Destination: 'STRING_VALUE',
  DestinationIp: 'STRING_VALUE',
  DestinationPort: 'NUMBER_VALUE',
  DryRun: true || false,
  FilterAtDestination: {
    DestinationAddress: 'STRING_VALUE',
    DestinationPortRange: {
      FromPort: 'NUMBER_VALUE',
      ToPort: 'NUMBER_VALUE'
    },
    SourceAddress: 'STRING_VALUE',
    SourcePortRange: {
      FromPort: 'NUMBER_VALUE',
      ToPort: 'NUMBER_VALUE'
    }
  },
  FilterAtSource: {
    DestinationAddress: 'STRING_VALUE',
    DestinationPortRange: {
      FromPort: 'NUMBER_VALUE',
      ToPort: 'NUMBER_VALUE'
    },
    SourceAddress: 'STRING_VALUE',
    SourcePortRange: {
      FromPort: 'NUMBER_VALUE',
      ToPort: 'NUMBER_VALUE'
    }
  },
  SourceIp: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createNetworkInsightsPath(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SourceIp — (String)

      The IP address of the source.

    • DestinationIp — (String)

      The IP address of the destination.

    • Source — (String)

      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)

      The protocol.

      Possible values include:
      • "tcp"
      • "udp"
    • DestinationPort — (Integer)

      The destination port.

    • TagSpecifications — (Array<map>)

      The tags to add to the path.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • FilterAtSource — (map)

      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 — (map)

        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 — (map)

        The destination port range.

        • FromPort — (Integer)

          The first port in the range.

        • ToPort — (Integer)

          The last port in the range.

    • FilterAtDestination — (map)

      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 — (map)

        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 — (map)

        The destination port range.

        • FromPort — (Integer)

          The first port in the range.

        • ToPort — (Integer)

          The last port in the range.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsPath — (map)

        Information about the path.

        • NetworkInsightsPathId — (String)

          The ID of the path.

        • NetworkInsightsPathArn — (String)

          The Amazon Resource Name (ARN) of the path.

        • CreatedDate — (Date)

          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.

          Possible values include:
          • "tcp"
          • "udp"
        • DestinationPort — (Integer)

          The destination port.

        • Tags — (Array<map>)

          The tags associated with the path.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          Scopes the analysis to network paths that match specific filters at the source.

          • SourceAddress — (String)

            The source IPv4 address.

          • SourcePortRange — (map)

            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 — (map)

            The destination port range.

            • FromPort — (Integer)

              The first port in the range.

            • ToPort — (Integer)

              The last port in the range.

        • FilterAtDestination — (map)

          Scopes the analysis to network paths that match specific filters at the destination.

          • SourceAddress — (String)

            The source IPv4 address.

          • SourcePortRange — (map)

            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 — (map)

            The destination port range.

            • FromPort — (Integer)

              The first port in the range.

            • ToPort — (Integer)

              The last port in the range.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNetworkInterface(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a network interface


/* This example creates a network interface for the specified subnet. */

 var params = {
  Description: "my network interface", 
  Groups: [
     "sg-903004f8"
  ], 
  PrivateIpAddress: "10.0.2.17", 
  SubnetId: "subnet-9d4a7b6c"
 };
 ec2.createNetworkInterface(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NetworkInterface: {
     AvailabilityZone: "us-east-1d", 
     Description: "my network interface", 
     Groups: [
        {
       GroupId: "sg-903004f8", 
       GroupName: "default"
      }
     ], 
     MacAddress: "02:1a:80:41:52:9c", 
     NetworkInterfaceId: "eni-e5aa89a3", 
     OwnerId: "123456789012", 
     PrivateIpAddress: "10.0.2.17", 
     PrivateIpAddresses: [
        {
       Primary: true, 
       PrivateIpAddress: "10.0.2.17"
      }
     ], 
     RequesterManaged: false, 
     SourceDestCheck: true, 
     Status: "pending", 
     SubnetId: "subnet-9d4a7b6c", 
     TagSet: [
     ], 
     VpcId: "vpc-a01106c2"
    }
   }
   */
 });

Calling the createNetworkInterface operation

var params = {
  SubnetId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  ConnectionTrackingSpecification: {
    TcpEstablishedTimeout: 'NUMBER_VALUE',
    UdpStreamTimeout: 'NUMBER_VALUE',
    UdpTimeout: 'NUMBER_VALUE'
  },
  Description: 'STRING_VALUE',
  DryRun: true || false,
  EnablePrimaryIpv6: true || false,
  Groups: [
    'STRING_VALUE',
    /* more items */
  ],
  InterfaceType: efa | branch | trunk,
  Ipv4PrefixCount: 'NUMBER_VALUE',
  Ipv4Prefixes: [
    {
      Ipv4Prefix: 'STRING_VALUE'
    },
    /* more items */
  ],
  Ipv6AddressCount: 'NUMBER_VALUE',
  Ipv6Addresses: [
    {
      Ipv6Address: 'STRING_VALUE',
      IsPrimaryIpv6: true || false
    },
    /* more items */
  ],
  Ipv6PrefixCount: 'NUMBER_VALUE',
  Ipv6Prefixes: [
    {
      Ipv6Prefix: 'STRING_VALUE'
    },
    /* more items */
  ],
  PrivateIpAddress: 'STRING_VALUE',
  PrivateIpAddresses: [
    {
      Primary: true || false,
      PrivateIpAddress: 'STRING_VALUE'
    },
    /* more items */
  ],
  SecondaryPrivateIpAddressCount: 'NUMBER_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createNetworkInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A description for 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.

    • Groups — (Array<String>)

      The IDs of one or more security groups.

    • 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.

    • Ipv6Addresses — (Array<map>)

      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.

      • 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.

    • 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).

    • PrivateIpAddresses — (Array<map>)

      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.

      • 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.

    • Ipv4Prefixes — (Array<map>)

      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.

    • 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 — (Array<map>)

      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.

      • 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.

      The only supported values are interface, efa, and trunk.

      Possible values include:
      • "efa"
      • "branch"
      • "trunk"
    • SubnetId — (String)

      The ID of the subnet to associate with the network interface.

    • TagSpecifications — (Array<map>)

      The tags to apply to the new network interface.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • 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 — (map)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInterface — (map)

        Information about the network interface.

        • Association — (map)

          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 — (map)

          The network interface attachment.

          • AttachTime — (Date)

            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.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • EnaSrdSpecification — (map)

            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 — (map)

              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.

        • AvailabilityZone — (String)

          The Availability Zone.

        • ConnectionTrackingConfiguration — (map)

          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 — (Array<map>)

          Any security groups for the network interface.

          • GroupName — (String)

            The name of the security group.

          • GroupId — (String)

            The ID of the security group.

        • InterfaceType — (String)

          The type of network interface.

          Possible values include:
          • "interface"
          • "natGateway"
          • "efa"
          • "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 — (Array<map>)

          The IPv6 addresses associated with the network interface.

          • 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 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 DNS name.

        • PrivateIpAddress — (String)

          The IPv4 address of the network interface within the subnet.

        • PrivateIpAddresses — (Array<map>)

          The private IPv4 addresses associated with the network interface.

          • Association — (map)

            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 — (Array<map>)

          The IPv4 prefixes that are assigned to the network interface.

        • Ipv6Prefixes — (Array<map>)

          The IPv6 prefixes that are assigned to the network interface.

          • 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.

          Possible values include:
          • "available"
          • "associated"
          • "attaching"
          • "in-use"
          • "detaching"
        • SubnetId — (String)

          The ID of the subnet.

        • TagSet — (Array<map>)

          Any tags assigned to the network interface.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      • ClientToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNetworkInterfacePermission(params = {}, callback) ⇒ AWS.Request

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

Service Reference:

Examples:

Calling the createNetworkInterfacePermission operation

var params = {
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  Permission: INSTANCE-ATTACH | EIP-ASSOCIATE, /* required */
  AwsAccountId: 'STRING_VALUE',
  AwsService: 'STRING_VALUE',
  DryRun: true || false
};
ec2.createNetworkInterfacePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInterfaceId — (String)

      The ID of the network interface.

    • AwsAccountId — (String)

      The Amazon Web Services account ID.

    • AwsService — (String)

      The Amazon Web Services service. Currently not supported.

    • Permission — (String)

      The type of permission to grant.

      Possible values include:
      • "INSTANCE-ATTACH"
      • "EIP-ASSOCIATE"
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InterfacePermission — (map)

        Information about the permission for the 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.

          Possible values include:
          • "INSTANCE-ATTACH"
          • "EIP-ASSOCIATE"
        • PermissionState — (map)

          Information about the state of the permission.

          • State — (String)

            The state of the permission.

            Possible values include:
            • "pending"
            • "granted"
            • "revoking"
            • "revoked"
          • StatusMessage — (String)

            A status message, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPlacementGroup(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a placement group


/* This example creates a placement group with the specified name. */

 var params = {
  GroupName: "my-cluster", 
  Strategy: "cluster"
 };
 ec2.createPlacementGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createPlacementGroup operation

var params = {
  DryRun: true || false,
  GroupName: 'STRING_VALUE',
  PartitionCount: 'NUMBER_VALUE',
  SpreadLevel: host | rack,
  Strategy: cluster | spread | partition,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createPlacementGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

      Possible values include:
      • "cluster"
      • "spread"
      • "partition"
    • PartitionCount — (Integer)

      The number of partitions. Valid only when Strategy is set to partition.

    • TagSpecifications — (Array<map>)

      The tags to apply to the new placement group.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      Possible values include:
      • "host"
      • "rack"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlacementGroup — (map)

        Information about the placement group.

        • GroupName — (String)

          The name of the placement group.

        • State — (String)

          The state of the placement group.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • Strategy — (String)

          The placement strategy.

          Possible values include:
          • "cluster"
          • "spread"
          • "partition"
        • PartitionCount — (Integer)

          The number of partitions. Valid only if strategy is set to partition.

        • GroupId — (String)

          The ID of the placement group.

        • Tags — (Array<map>)

          Any tags applied to the placement group.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "host"
          • "rack"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPublicIpv4Pool(params = {}, callback) ⇒ AWS.Request

Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.

Service Reference:

Examples:

Calling the createPublicIpv4Pool operation

var params = {
  DryRun: true || false,
  NetworkBorderGroup: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createPublicIpv4Pool(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 — (Array<map>)

      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.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PoolId — (String)

        The ID of the public IPv4 pool.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createReplaceRootVolumeTask(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createReplaceRootVolumeTask operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DeleteReplacedRootVolume: true || false,
  DryRun: true || false,
  ImageId: 'STRING_VALUE',
  SnapshotId: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createReplaceRootVolumeTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InstanceId — (String)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      The tags to apply to the root volume replacement task.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReplaceRootVolumeTask — (map)

        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.

          Possible values include:
          • "pending"
          • "in-progress"
          • "failing"
          • "succeeded"
          • "failed"
          • "failed-detached"
        • StartTime — (String)

          The time the task was started.

        • CompleteTime — (String)

          The time the task completed.

        • Tags — (Array<map>)

          The tags assigned to the task.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createReservedInstancesListing(params = {}, callback) ⇒ AWS.Request

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.

Note: Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the createReservedInstancesListing operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  InstanceCount: 'NUMBER_VALUE', /* required */
  PriceSchedules: [ /* required */
    {
      CurrencyCode: USD,
      Price: 'NUMBER_VALUE',
      Term: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  ReservedInstancesId: 'STRING_VALUE' /* required */
};
ec2.createReservedInstancesListing(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

    • InstanceCount — (Integer)

      The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

    • PriceSchedules — (Array<map>)

      A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

      • CurrencyCode — (String)

        The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

        Possible values include:
        • "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 active Standard Reserved Instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReservedInstancesListings — (Array<map>)

        Information about the Standard 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 — (Date)

          The time the listing was created.

        • InstanceCounts — (Array<map>)

          The number of instances in this 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.

            Possible values include:
            • "available"
            • "sold"
            • "cancelled"
            • "pending"
        • PriceSchedules — (Array<map>)

          The price of the Reserved Instance listing.

          • 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.

            Possible values include:
            • "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.

          Possible values include:
          • "active"
          • "pending"
          • "cancelled"
          • "closed"
        • StatusMessage — (String)

          The reason for the current status of the Reserved Instance listing. The response can be blank.

        • Tags — (Array<map>)

          Any tags assigned to the resource.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Date)

          The last modified timestamp of the listing.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createRestoreImageTask(params = {}, callback) ⇒ AWS.Request

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the createRestoreImageTask operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ObjectKey: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Name: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createRestoreImageTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket that contains the stored AMI object.

    • ObjectKey — (String)

      The name of the stored AMI object in the bucket.

    • Name — (String)

      The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.

    • TagSpecifications — (Array<map>)

      The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.

      • To tag the AMI, the value for ResourceType must be image.

      • To tag the snapshots, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageId — (String)

        The AMI ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createRoute(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a route


/* 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. */

 var params = {
  DestinationCidrBlock: "0.0.0.0/0", 
  GatewayId: "igw-c0a643a9", 
  RouteTableId: "rtb-22574640"
 };
 ec2.createRoute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createRoute operation

var params = {
  RouteTableId: 'STRING_VALUE', /* required */
  CarrierGatewayId: 'STRING_VALUE',
  CoreNetworkArn: 'STRING_VALUE',
  DestinationCidrBlock: 'STRING_VALUE',
  DestinationIpv6CidrBlock: 'STRING_VALUE',
  DestinationPrefixListId: 'STRING_VALUE',
  DryRun: true || false,
  EgressOnlyInternetGatewayId: 'STRING_VALUE',
  GatewayId: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  LocalGatewayId: 'STRING_VALUE',
  NatGatewayId: 'STRING_VALUE',
  NetworkInterfaceId: 'STRING_VALUE',
  TransitGatewayId: 'STRING_VALUE',
  VpcEndpointId: 'STRING_VALUE',
  VpcPeeringConnectionId: 'STRING_VALUE'
};
ec2.createRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • DestinationIpv6CidrBlock — (String)

      The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

    • DestinationPrefixListId — (String)

      The ID of a prefix list used for the destination match.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

    • EgressOnlyInternetGatewayId — (String)

      [IPv6 traffic only] The ID of an egress-only internet gateway.

    • GatewayId — (String)

      The ID of an internet gateway or virtual private gateway attached to your VPC.

    • 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.

    • NatGatewayId — (String)

      [IPv4 traffic only] 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.

      You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

    • NetworkInterfaceId — (String)

      The ID of a network interface.

    • RouteTableId — (String)

      The ID of the route table for the route.

    • VpcPeeringConnectionId — (String)

      The ID of a VPC peering connection.

    • CoreNetworkArn — (String)

      The Amazon Resource Name (ARN) of the core network.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds; otherwise, it returns an error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createRouteTable(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a route table


/* This example creates a route table for the specified VPC. */

 var params = {
  VpcId: "vpc-a01106c2"
 };
 ec2.createRouteTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    RouteTable: {
     Associations: [
     ], 
     PropagatingVgws: [
     ], 
     RouteTableId: "rtb-22574640", 
     Routes: [
        {
       DestinationCidrBlock: "10.0.0.0/16", 
       GatewayId: "local", 
       State: "active"
      }
     ], 
     Tags: [
     ], 
     VpcId: "vpc-a01106c2"
    }
   }
   */
 });

Calling the createRouteTable operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the VPC.

    • TagSpecifications — (Array<map>)

      The tags to assign to the route table.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RouteTable — (map)

        Information about the route table.

        • Associations — (Array<map>)

          The associations between the route table and your subnets or gateways.

          • 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 — (map)

            The state of the association.

            • State — (String)

              The state of the association.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failed"
            • StatusMessage — (String)

              The status message, if applicable.

        • PropagatingVgws — (Array<map>)

          Any virtual private gateway (VGW) propagating routes.

          • GatewayId — (String)

            The ID of the virtual private gateway.

        • RouteTableId — (String)

          The ID of the route table.

        • Routes — (Array<map>)

          The routes in the 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.

            Possible values include:
            • "CreateRouteTable"
            • "CreateRoute"
            • "EnableVgwRoutePropagation"
          • 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).

            Possible values include:
            • "active"
            • "blackhole"
          • VpcPeeringConnectionId — (String)

            The ID of a VPC peering connection.

          • CoreNetworkArn — (String)

            The Amazon Resource Name (ARN) of the core network.

        • Tags — (Array<map>)

          Any tags assigned to the route table.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the route table.

      • ClientToken — (String)

        Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSecurityGroup(params = {}, callback) ⇒ AWS.Request

Creates a security group.

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

When you create a security group, you specify a friendly name of your choice. You can'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.

Service Reference:

Examples:

To create a security group for a VPC


/* This example creates a security group for the specified VPC. */

 var params = {
  Description: "My security group", 
  GroupName: "my-security-group", 
  VpcId: "vpc-1a2b3c4d"
 };
 ec2.createSecurityGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GroupId: "sg-903004f8"
   }
   */
 });

Calling the createSecurityGroup operation

var params = {
  Description: 'STRING_VALUE', /* required */
  GroupName: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  VpcId: 'STRING_VALUE'
};
ec2.createSecurityGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      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)

      The name of the security group.

      Constraints: Up to 255 characters in length. Cannot 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 — (Array<map>)

      The tags to assign to the security group.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GroupId — (String)

        The ID of the security group.

      • Tags — (Array<map>)

        The tags assigned to the security group.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.

When a snapshot is created, any 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.

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.

For more information, see Amazon EBS and Amazon EBS encryption in the Amazon EBS User Guide.

Service Reference:

Examples:

To create a snapshot


/* This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot. */

 var params = {
  Description: "This is my root volume snapshot.", 
  VolumeId: "vol-1234567890abcdef0"
 };
 ec2.createSnapshot(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Description: "This is my root volume snapshot.", 
    OwnerId: "012345678910", 
    SnapshotId: "snap-066877671789bd71b", 
    StartTime: <Date Representation>, 
    State: "pending", 
    Tags: [
    ], 
    VolumeId: "vol-1234567890abcdef0", 
    VolumeSize: 8
   }
   */
 });

Calling the createSnapshot operation

var params = {
  VolumeId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DryRun: true || false,
  OutpostArn: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A description for the snapshot.

    • OutpostArn — (String)

      The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

      • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

      • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

      • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

      For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

    • VolumeId — (String)

      The ID of the Amazon EBS volume.

    • TagSpecifications — (Array<map>)

      The tags to apply to the snapshot during creation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

      • Description — (String)

        The description for the snapshot.

      • 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.

      • OwnerId — (String)

        The ID of the Amazon Web Services account that owns the EBS snapshot.

      • Progress — (String)

        The progress of the snapshot, as a percentage.

      • SnapshotId — (String)

        The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

      • StartTime — (Date)

        The time stamp when the snapshot was initiated.

      • State — (String)

        The snapshot state.

        Possible values include:
        • "pending"
        • "completed"
        • "error"
        • "recoverable"
        • "recovering"
      • 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.

      • VolumeId — (String)

        The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

      • VolumeSize — (Integer)

        The size of the volume, in GiB.

      • 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 — (Array<map>)

        Any tags assigned to the snapshot.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

        Possible values include:
        • "archive"
        • "standard"
      • RestoreExpiryTime — (Date)

        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.

        Possible values include:
        • "sse-ebs"
        • "sse-kms"
        • "none"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSnapshots(params = {}, callback) ⇒ AWS.Request

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance.

You can include all of the volumes currently attached to the instance, or you can exclude the root volume or specific data (non-root) volumes from the multi-volume snapshot set.

You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.

Service Reference:

Examples:

Calling the createSnapshots operation

var params = {
  InstanceSpecification: { /* required */
    InstanceId: 'STRING_VALUE', /* required */
    ExcludeBootVolume: true || false,
    ExcludeDataVolumeIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  CopyTagsFromSource: volume,
  Description: 'STRING_VALUE',
  DryRun: true || false,
  OutpostArn: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A description propagated to every snapshot specified by the instance.

    • InstanceSpecification — (map)

      The instance to specify which volumes should be included in the snapshots.

      • InstanceId — required — (String)

        The instance to specify which volumes should be snapshotted.

      • ExcludeBootVolume — (Boolean)

        Excludes the root volume from being snapshotted.

      • ExcludeDataVolumeIds — (Array<String>)

        The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. If you specify the ID of the root volume, the request fails. To exclude the root volume, use ExcludeBootVolume.

        You can specify up to 40 volume IDs per request.

    • OutpostArn — (String)

      The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.

      • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

      • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

      • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

      For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon EBS User Guide.

    • TagSpecifications — (Array<map>)

      Tags to apply to every snapshot specified by the instance.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

    • CopyTagsFromSource — (String)

      Copies the tags from the specified volume to corresponding snapshot.

      Possible values include:
      • "volume"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshots — (Array<map>)

        List of snapshots.

        • Description — (String)

          Description specified by the CreateSnapshotRequest that has been applied to all snapshots.

        • Tags — (Array<map>)

          Tags associated with this snapshot.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value — (String)

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

        • Encrypted — (Boolean)

          Indicates whether the snapshot is encrypted.

        • VolumeId — (String)

          Source volume from which this snapshot was created.

        • State — (String)

          Current state of the snapshot.

          Possible values include:
          • "pending"
          • "completed"
          • "error"
          • "recoverable"
          • "recovering"
        • VolumeSize — (Integer)

          Size of the volume from which this snapshot was created.

        • StartTime — (Date)

          Time this snapshot was started. This is the same for all snapshots initiated by the same request.

        • Progress — (String)

          Progress this snapshot has made towards completing.

        • OwnerId — (String)

          Account id used when creating this snapshot.

        • SnapshotId — (String)

          Snapshot id that can be used to describe this snapshot.

        • 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.

        • SseType — (String)

          Reserved for future use.

          Possible values include:
          • "sse-ebs"
          • "sse-kms"
          • "none"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSpotDatafeedSubscription(params = {}, callback) ⇒ AWS.Request

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide.

Service Reference:

Examples:

To create a Spot Instance datafeed


/* This example creates a Spot Instance data feed for your AWS account. */

 var params = {
  Bucket: "my-s3-bucket", 
  Prefix: "spotdata"
 };
 ec2.createSpotDatafeedSubscription(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SpotDatafeedSubscription: {
     Bucket: "my-s3-bucket", 
     OwnerId: "123456789012", 
     Prefix: "spotdata", 
     State: "Active"
    }
   }
   */
 });

Calling the createSpotDatafeedSubscription operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Prefix: 'STRING_VALUE'
};
ec2.createSpotDatafeedSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • Prefix — (String)

      The prefix for the data feed file names.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SpotDatafeedSubscription — (map)

        The Spot Instance data feed subscription.

        • Bucket — (String)

          The name of the Amazon S3 bucket where the Spot Instance data feed is located.

        • Fault — (map)

          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.

          Possible values include:
          • "Active"
          • "Inactive"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createStoreImageTask(params = {}, callback) ⇒ AWS.Request

Stores an AMI as a single object in an Amazon S3 bucket.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the createStoreImageTask operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ImageId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  S3ObjectTags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ec2.createStoreImageTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ImageId — (String)

      The ID of the AMI.

    • Bucket — (String)

      The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed.

    • S3ObjectTags — (Array<map>)

      The tags to apply to the AMI object that will be stored in the Amazon S3 bucket.

      • Key — (String)

        The key of the tag.

        Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in length. May not begin with aws:.

      • Value — (String)

        The value of the tag.

        Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in length.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ObjectKey — (String)

        The name of the stored AMI object in the S3 bucket.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSubnet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a subnet


/* This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you. */

 var params = {
  CidrBlock: "10.0.1.0/24", 
  VpcId: "vpc-a01106c2"
 };
 ec2.createSubnet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Subnet: {
     AvailabilityZone: "us-west-2c", 
     AvailableIpAddressCount: 251, 
     CidrBlock: "10.0.1.0/24", 
     State: "pending", 
     SubnetId: "subnet-9d4a7b6c", 
     VpcId: "vpc-a01106c2"
    }
   }
   */
 });

Calling the createSubnet operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  AvailabilityZone: 'STRING_VALUE',
  AvailabilityZoneId: 'STRING_VALUE',
  CidrBlock: 'STRING_VALUE',
  DryRun: true || false,
  Ipv4IpamPoolId: 'STRING_VALUE',
  Ipv4NetmaskLength: 'NUMBER_VALUE',
  Ipv6CidrBlock: 'STRING_VALUE',
  Ipv6IpamPoolId: 'STRING_VALUE',
  Ipv6Native: true || false,
  Ipv6NetmaskLength: 'NUMBER_VALUE',
  OutpostArn: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createSubnet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TagSpecifications — (Array<map>)

      The tags to assign to the subnet.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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)

      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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Subnet — (map)

        Information about the subnet.

        • AvailabilityZone — (String)

          The Availability Zone of the subnet.

        • AvailabilityZoneId — (String)

          The AZ ID of the subnet.

        • AvailableIpAddressCount — (Integer)

          The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

        • CidrBlock — (String)

          The IPv4 CIDR block assigned to the subnet.

        • DefaultForAz — (Boolean)

          Indicates whether this is the default subnet for the Availability Zone.

        • 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).

        • 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.

        • 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.

        • State — (String)

          The current state of the subnet.

          Possible values include:
          • "pending"
          • "available"
          • "unavailable"
        • SubnetId — (String)

          The ID of the subnet.

        • VpcId — (String)

          The ID of the VPC the subnet is in.

        • 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 — (Array<map>)

          Information about the IPv6 CIDR blocks associated with the subnet.

          • AssociationId — (String)

            The ID of the association.

          • Ipv6CidrBlock — (String)

            The IPv6 CIDR block.

          • Ipv6CidrBlockState — (map)

            The state of the CIDR block.

            • State — (String)

              The state of a CIDR block.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failing"
              • "failed"
            • 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.

            Possible values include:
            • "public"
            • "private"
          • 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.

            Possible values include:
            • "amazon"
            • "byoip"
            • "none"
        • Tags — (Array<map>)

          Any tags assigned to the subnet.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

            Possible values include:
            • "ip-name"
            • "resource-name"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSubnetCidrReservation(params = {}, callback) ⇒ AWS.Request

Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations in the Amazon VPC User Guide and Assign prefixes to network interfaces in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the createSubnetCidrReservation operation

var params = {
  Cidr: 'STRING_VALUE', /* required */
  ReservationType: prefix | explicit, /* required */
  SubnetId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createSubnetCidrReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubnetId — (String)

      The ID of the subnet.

    • Cidr — (String)

      The IPv4 or IPV6 CIDR range to reserve.

    • ReservationType — (String)

      The type of reservation. The reservation type determines how the reserved IP addresses are assigned to resources.

      • prefix - Amazon Web Services assigns the reserved IP addresses to network interfaces.

      • explicit - You assign the reserved IP addresses to network interfaces.

      Possible values include:
      • "prefix"
      • "explicit"
    • Description — (String)

      The description to assign to the subnet CIDR reservation.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      The tags to assign to the subnet CIDR reservation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SubnetCidrReservation — (map)

        Information about the created 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.

          Possible values include:
          • "prefix"
          • "explicit"
        • OwnerId — (String)

          The ID of the account that owns the subnet CIDR reservation.

        • Description — (String)

          The description assigned to the subnet CIDR reservation.

        • Tags — (Array<map>)

          The tags assigned to the subnet CIDR reservation.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTags(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To add a tag to a resource


/* This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack. */

 var params = {
  Resources: [
     "ami-78a54011"
  ], 
  Tags: [
     {
    Key: "Stack", 
    Value: "production"
   }
  ]
 };
 ec2.createTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the createTags operation

var params = {
  Resources: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  DryRun: true || false
};
ec2.createTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the resources, separated by spaces.

      Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

    • Tags — (Array<map>)

      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.

      • Key — (String)

        The key of the tag.

        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

      • Value — (String)

        The value of the tag.

        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTrafficMirrorFilter(params = {}, callback) ⇒ AWS.Request

Creates a Traffic Mirror filter.

A Traffic Mirror filter is a set of rules that defines the traffic to mirror.

By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.

Service Reference:

Examples:

Calling the createTrafficMirrorFilter operation

var params = {
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTrafficMirrorFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      The description of the Traffic Mirror filter.

    • TagSpecifications — (Array<map>)

      The tags to assign to a Traffic Mirror filter.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficMirrorFilter — (map)

        Information about the Traffic Mirror filter.

        • TrafficMirrorFilterId — (String)

          The ID of the Traffic Mirror filter.

        • IngressFilterRules — (Array<map>)

          Information about the ingress rules that are associated with the Traffic Mirror filter.

          • 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.

            Possible values include:
            • "ingress"
            • "egress"
          • RuleNumber — (Integer)

            The rule number of the Traffic Mirror rule.

          • RuleAction — (String)

            The action assigned to the Traffic Mirror rule.

            Possible values include:
            • "accept"
            • "reject"
          • Protocol — (Integer)

            The protocol assigned to the Traffic Mirror rule.

          • DestinationPortRange — (map)

            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 — (map)

            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 — (Array<map>)

            Tags on Traffic Mirroring filter rules.

            • Key — (String)

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

          Information about the egress rules that are associated with the Traffic Mirror filter.

          • 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.

            Possible values include:
            • "ingress"
            • "egress"
          • RuleNumber — (Integer)

            The rule number of the Traffic Mirror rule.

          • RuleAction — (String)

            The action assigned to the Traffic Mirror rule.

            Possible values include:
            • "accept"
            • "reject"
          • Protocol — (Integer)

            The protocol assigned to the Traffic Mirror rule.

          • DestinationPortRange — (map)

            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 — (map)

            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 — (Array<map>)

            Tags on Traffic Mirroring filter rules.

            • Key — (String)

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<String>)

          The network service traffic that is associated with the Traffic Mirror filter.

        • Description — (String)

          The description of the Traffic Mirror filter.

        • Tags — (Array<map>)

          The tags assigned to the Traffic Mirror filter.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTrafficMirrorFilterRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createTrafficMirrorFilterRule operation

var params = {
  DestinationCidrBlock: 'STRING_VALUE', /* required */
  RuleAction: accept | reject, /* required */
  RuleNumber: 'NUMBER_VALUE', /* required */
  SourceCidrBlock: 'STRING_VALUE', /* required */
  TrafficDirection: ingress | egress, /* required */
  TrafficMirrorFilterId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DestinationPortRange: {
    FromPort: 'NUMBER_VALUE',
    ToPort: 'NUMBER_VALUE'
  },
  DryRun: true || false,
  Protocol: 'NUMBER_VALUE',
  SourcePortRange: {
    FromPort: 'NUMBER_VALUE',
    ToPort: 'NUMBER_VALUE'
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTrafficMirrorFilterRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TrafficMirrorFilterId — (String)

      The ID of the filter that this rule is associated with.

    • TrafficDirection — (String)

      The type of traffic.

      Possible values include:
      • "ingress"
      • "egress"
    • RuleNumber — (Integer)

      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)

      The action to take on the filtered traffic.

      Possible values include:
      • "accept"
      • "reject"
    • DestinationPortRange — (map)

      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 — (map)

      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)

      The destination CIDR block to assign to the Traffic Mirror rule.

    • SourceCidrBlock — (String)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • TagSpecifications — (Array<map>)

      Traffic Mirroring tags specifications.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficMirrorFilterRule — (map)

        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.

          Possible values include:
          • "ingress"
          • "egress"
        • RuleNumber — (Integer)

          The rule number of the Traffic Mirror rule.

        • RuleAction — (String)

          The action assigned to the Traffic Mirror rule.

          Possible values include:
          • "accept"
          • "reject"
        • Protocol — (Integer)

          The protocol assigned to the Traffic Mirror rule.

        • DestinationPortRange — (map)

          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 — (map)

          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 — (Array<map>)

          Tags on Traffic Mirroring filter rules.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTrafficMirrorSession(params = {}, callback) ⇒ AWS.Request

Creates a Traffic Mirror session.

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.

Service Reference:

Examples:

Calling the createTrafficMirrorSession operation

var params = {
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  SessionNumber: 'NUMBER_VALUE', /* required */
  TrafficMirrorFilterId: 'STRING_VALUE', /* required */
  TrafficMirrorTargetId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  PacketLength: 'NUMBER_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  VirtualNetworkId: 'NUMBER_VALUE'
};
ec2.createTrafficMirrorSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInterfaceId — (String)

      The ID of the source network interface.

    • TrafficMirrorTargetId — (String)

      The ID of the Traffic Mirror target.

    • TrafficMirrorFilterId — (String)

      The ID of the Traffic Mirror filter.

    • PacketLength — (Integer)

      The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.

      If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

      For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

    • 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 VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an account-wide unique ID is chosen at random.

    • Description — (String)

      The description of the Traffic Mirror session.

    • TagSpecifications — (Array<map>)

      The tags to assign to a Traffic Mirror session.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficMirrorSession — (map)

        Information about the 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 — (Array<map>)

          The tags assigned to the Traffic Mirror session.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTrafficMirrorTarget(params = {}, callback) ⇒ AWS.Request

Creates a target for your Traffic Mirror session.

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

Service Reference:

Examples:

Calling the createTrafficMirrorTarget operation

var params = {
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  GatewayLoadBalancerEndpointId: 'STRING_VALUE',
  NetworkInterfaceId: 'STRING_VALUE',
  NetworkLoadBalancerArn: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTrafficMirrorTarget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInterfaceId — (String)

      The network interface ID that is associated with the target.

    • NetworkLoadBalancerArn — (String)

      The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

    • Description — (String)

      The description of the Traffic Mirror target.

    • TagSpecifications — (Array<map>)

      The tags to assign to the Traffic Mirror target.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • GatewayLoadBalancerEndpointId — (String)

      The ID of the Gateway Load Balancer endpoint.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficMirrorTarget — (map)

        Information about the 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.

          Possible values include:
          • "network-interface"
          • "network-load-balancer"
          • "gateway-load-balancer-endpoint"
        • Description — (String)

          Information about the Traffic Mirror target.

        • OwnerId — (String)

          The ID of the account that owns the Traffic Mirror target.

        • Tags — (Array<map>)

          The tags assigned to the Traffic Mirror target.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      • ClientToken — (String)

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGateway(params = {}, callback) ⇒ AWS.Request

Creates a transit gateway.

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

Service Reference:

Examples:

Calling the createTransitGateway operation

var params = {
  Description: 'STRING_VALUE',
  DryRun: true || false,
  Options: {
    AmazonSideAsn: 'NUMBER_VALUE',
    AutoAcceptSharedAttachments: enable | disable,
    DefaultRouteTableAssociation: enable | disable,
    DefaultRouteTablePropagation: enable | disable,
    DnsSupport: enable | disable,
    MulticastSupport: enable | disable,
    SecurityGroupReferencingSupport: enable | disable,
    TransitGatewayCidrBlocks: [
      'STRING_VALUE',
      /* more items */
    ],
    VpnEcmpSupport: enable | disable
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTransitGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A description of the transit gateway.

    • Options — (map)

      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. The default is 64512.

      • AutoAcceptSharedAttachments — (String)

        Enable or disable automatic acceptance of attachment requests. Disabled by default.

        Possible values include:
        • "enable"
        • "disable"
      • DefaultRouteTableAssociation — (String)

        Enable or disable automatic association with the default association route table. Enabled by default.

        Possible values include:
        • "enable"
        • "disable"
      • DefaultRouteTablePropagation — (String)

        Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.

        Possible values include:
        • "enable"
        • "disable"
      • VpnEcmpSupport — (String)

        Enable or disable Equal Cost Multipath Protocol support. Enabled by default.

        Possible values include:
        • "enable"
        • "disable"
      • DnsSupport — (String)

        Enable or disable DNS support. Enabled by default.

        Possible values include:
        • "enable"
        • "disable"
      • SecurityGroupReferencingSupport — (String)
        Note: This parameter is in preview and may not be available for your account.

        Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

        Possible values include:
        • "enable"
        • "disable"
      • MulticastSupport — (String)

        Indicates whether multicast is enabled on the transit gateway

        Possible values include:
        • "enable"
        • "disable"
      • TransitGatewayCidrBlocks — (Array<String>)

        One or more 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.

    • TagSpecifications — (Array<map>)

      The tags to apply to the transit gateway.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGateway — (map)

        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.

          Possible values include:
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the transit gateway.

        • Description — (String)

          The description of the transit gateway.

        • CreationTime — (Date)

          The creation time.

        • Options — (map)

          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 — (Array<String>)

            The transit gateway CIDR blocks.

          • AutoAcceptSharedAttachments — (String)

            Indicates whether attachment requests are automatically accepted.

            Possible values include:
            • "enable"
            • "disable"
          • DefaultRouteTableAssociation — (String)

            Indicates whether resource attachments are automatically associated with the default association route table.

            Possible values include:
            • "enable"
            • "disable"
          • 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.

            Possible values include:
            • "enable"
            • "disable"
          • PropagationDefaultRouteTableId — (String)

            The ID of the default propagation route table.

          • VpnEcmpSupport — (String)

            Indicates whether Equal Cost Multipath Protocol support is enabled.

            Possible values include:
            • "enable"
            • "disable"
          • DnsSupport — (String)

            Indicates whether DNS support is enabled.

            Possible values include:
            • "enable"
            • "disable"
          • SecurityGroupReferencingSupport — (String)
            Note: This parameter is in preview and may not be available for your account.

            Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

            Possible values include:
            • "enable"
            • "disable"
          • MulticastSupport — (String)

            Indicates whether multicast is enabled on the transit gateway

            Possible values include:
            • "enable"
            • "disable"
        • Tags — (Array<map>)

          The tags for the transit gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayConnect(params = {}, callback) ⇒ AWS.Request

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

Service Reference:

Examples:

Calling the createTransitGatewayConnect operation

var params = {
  Options: { /* required */
    Protocol: gre /* required */
  },
  TransportTransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTransitGatewayConnect(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransportTransitGatewayAttachmentId — (String)

      The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.

    • Options — (map)

      The Connect attachment options.

      • Protocol — required — (String)

        The tunnel protocol.

        Possible values include:
        • "gre"
    • TagSpecifications — (Array<map>)

      The tags to apply to the Connect attachment.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayConnect — (map)

        Information about the 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.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • CreationTime — (Date)

          The creation time.

        • Options — (map)

          The Connect attachment options.

          • Protocol — (String)

            The tunnel protocol.

            Possible values include:
            • "gre"
        • Tags — (Array<map>)

          The tags for the attachment.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayConnectPeer(params = {}, callback) ⇒ AWS.Request

Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

For more information, see Connect peers in the Amazon Web Services Transit Gateways Guide.

Service Reference:

Examples:

Calling the createTransitGatewayConnectPeer operation

var params = {
  InsideCidrBlocks: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  PeerAddress: 'STRING_VALUE', /* required */
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  BgpOptions: {
    PeerAsn: 'NUMBER_VALUE'
  },
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TransitGatewayAddress: 'STRING_VALUE'
};
ec2.createTransitGatewayConnectPeer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayAttachmentId — (String)

      The ID of the Connect attachment.

    • TransitGatewayAddress — (String)

      The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.

    • PeerAddress — (String)

      The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

    • BgpOptions — (map)

      The BGP options for the Connect peer.

      • PeerAsn — (Integer)

        The peer Autonomous System Number (ASN).

    • InsideCidrBlocks — (Array<String>)

      The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.

    • TagSpecifications — (Array<map>)

      The tags to apply to the Connect peer.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayConnectPeer — (map)

        Information about the 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.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • CreationTime — (Date)

          The creation time.

        • ConnectPeerConfiguration — (map)

          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 — (Array<String>)

            The range of interior BGP peer IP addresses.

          • Protocol — (String)

            The tunnel protocol.

            Possible values include:
            • "gre"
          • BgpConfigurations — (Array<map>)

            The BGP configuration details.

            • 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.

              Possible values include:
              • "up"
              • "down"
        • Tags — (Array<map>)

          The tags for the Connect peer.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayMulticastDomain(params = {}, callback) ⇒ AWS.Request

Creates a multicast domain using the specified transit gateway.

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

Service Reference:

Examples:

Calling the createTransitGatewayMulticastDomain operation

var params = {
  TransitGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Options: {
    AutoAcceptSharedAssociations: enable | disable,
    Igmpv2Support: enable | disable,
    StaticSourcesSupport: enable | disable
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTransitGatewayMulticastDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayId — (String)

      The ID of the transit gateway.

    • Options — (map)

      The options for the transit gateway multicast domain.

      • Igmpv2Support — (String)

        Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.

        Possible values include:
        • "enable"
        • "disable"
      • StaticSourcesSupport — (String)

        Specify whether to enable support for statically configuring multicast group sources for a domain.

        Possible values include:
        • "enable"
        • "disable"
      • AutoAcceptSharedAssociations — (String)

        Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.

        Possible values include:
        • "enable"
        • "disable"
    • TagSpecifications — (Array<map>)

      The tags for the transit gateway multicast domain.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayMulticastDomain — (map)

        Information about 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 — (map)

          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.

            Possible values include:
            • "enable"
            • "disable"
          • StaticSourcesSupport — (String)

            Indicates whether support for statically configuring transit gateway multicast group sources is turned on.

            Possible values include:
            • "enable"
            • "disable"
          • AutoAcceptSharedAssociations — (String)

            Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.

            Possible values include:
            • "enable"
            • "disable"
        • State — (String)

          The state of the transit gateway multicast domain.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • CreationTime — (Date)

          The time the transit gateway multicast domain was created.

        • Tags — (Array<map>)

          The tags for the transit gateway multicast domain.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayPeeringAttachment(params = {}, callback) ⇒ AWS.Request

Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different Amazon Web Services account.

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

Service Reference:

Examples:

Calling the createTransitGatewayPeeringAttachment operation

var params = {
  PeerAccountId: 'STRING_VALUE', /* required */
  PeerRegion: 'STRING_VALUE', /* required */
  PeerTransitGatewayId: 'STRING_VALUE', /* required */
  TransitGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Options: {
    DynamicRouting: enable | disable
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTransitGatewayPeeringAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayId — (String)

      The ID of the transit gateway.

    • PeerTransitGatewayId — (String)

      The ID of the peer transit gateway with which to create the peering attachment.

    • PeerAccountId — (String)

      The ID of the Amazon Web Services account that owns the peer transit gateway.

    • PeerRegion — (String)

      The Region where the peer transit gateway is located.

    • Options — (map)

      Requests a transit gateway peering attachment.

      • DynamicRouting — (String)

        Indicates whether dynamic routing is enabled or disabled.

        Possible values include:
        • "enable"
        • "disable"
    • TagSpecifications — (Array<map>)

      The tags to apply to the transit gateway peering attachment.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayPeeringAttachment — (map)

        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 — (map)

          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 — (map)

          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 — (map)

          Details about the transit gateway peering attachment.

          • DynamicRouting — (String)

            Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.

            Possible values include:
            • "enable"
            • "disable"
        • Status — (map)

          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.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • CreationTime — (Date)

          The time the transit gateway peering attachment was created.

        • Tags — (Array<map>)

          The tags for the transit gateway peering attachment.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayPolicyTable(params = {}, callback) ⇒ AWS.Request

Creates a transit gateway policy table.

Service Reference:

Examples:

Calling the createTransitGatewayPolicyTable operation

var params = {
  TransitGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTransitGatewayPolicyTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayId — (String)

      The ID of the transit gateway used for the policy table.

    • TagSpecifications — (Array<map>)

      The tags specification for the transit gateway policy table created during the request.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayPolicyTable — (map)

        Describes the created 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

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • CreationTime — (Date)

          The timestamp when the transit gateway policy table was created.

        • Tags — (Array<map>)

          he key-value pairs associated with the transit gateway policy table.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayPrefixListReference(params = {}, callback) ⇒ AWS.Request

Creates a reference (route) to a prefix list in a specified transit gateway route table.

Service Reference:

Examples:

Calling the createTransitGatewayPrefixListReference operation

var params = {
  PrefixListId: 'STRING_VALUE', /* required */
  TransitGatewayRouteTableId: 'STRING_VALUE', /* required */
  Blackhole: true || false,
  DryRun: true || false,
  TransitGatewayAttachmentId: 'STRING_VALUE'
};
ec2.createTransitGatewayPrefixListReference(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayRouteTableId — (String)

      The ID of the transit gateway route table.

    • PrefixListId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayPrefixListReference — (map)

        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.

          Possible values include:
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
        • Blackhole — (Boolean)

          Indicates whether traffic that matches this route is dropped.

        • TransitGatewayAttachment — (map)

          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.

            Possible values include:
            • "vpc"
            • "vpn"
            • "direct-connect-gateway"
            • "connect"
            • "peering"
            • "tgw-peering"
          • ResourceId — (String)

            The ID of the resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayRoute(params = {}, callback) ⇒ AWS.Request

Creates a static route for the specified transit gateway route table.

Service Reference:

Examples:

Calling the createTransitGatewayRoute operation

var params = {
  DestinationCidrBlock: 'STRING_VALUE', /* required */
  TransitGatewayRouteTableId: 'STRING_VALUE', /* required */
  Blackhole: true || false,
  DryRun: true || false,
  TransitGatewayAttachmentId: 'STRING_VALUE'
};
ec2.createTransitGatewayRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DestinationCidrBlock — (String)

      The CIDR range used for destination matches. Routing decisions are based on the most specific match.

    • TransitGatewayRouteTableId — (String)

      The ID of the transit gateway route table.

    • TransitGatewayAttachmentId — (String)

      The ID of the attachment.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Route — (map)

        Information about the 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 — (Array<map>)

          The attachments.

          • 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.

            Possible values include:
            • "vpc"
            • "vpn"
            • "direct-connect-gateway"
            • "connect"
            • "peering"
            • "tgw-peering"
        • Type — (String)

          The route type.

          Possible values include:
          • "static"
          • "propagated"
        • State — (String)

          The state of the route.

          Possible values include:
          • "pending"
          • "active"
          • "blackhole"
          • "deleting"
          • "deleted"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayRouteTable(params = {}, callback) ⇒ AWS.Request

Creates a route table for the specified transit gateway.

Service Reference:

Examples:

Calling the createTransitGatewayRouteTable operation

var params = {
  TransitGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTransitGatewayRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayId — (String)

      The ID of the transit gateway.

    • TagSpecifications — (Array<map>)

      The tags to apply to the transit gateway route table.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayRouteTable — (map)

        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.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • 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 — (Date)

          The creation time.

        • Tags — (Array<map>)

          Any tags assigned to the route table.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayRouteTableAnnouncement(params = {}, callback) ⇒ AWS.Request

Advertises a new transit gateway route table.

Service Reference:

Examples:

Calling the createTransitGatewayRouteTableAnnouncement operation

var params = {
  PeeringAttachmentId: 'STRING_VALUE', /* required */
  TransitGatewayRouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTransitGatewayRouteTableAnnouncement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayRouteTableId — (String)

      The ID of the transit gateway route table.

    • PeeringAttachmentId — (String)

      The ID of the peering attachment.

    • TagSpecifications — (Array<map>)

      The tags specifications applied to the transit gateway route table announcement.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayRouteTableAnnouncement — (map)

        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.

          Possible values include:
          • "outgoing"
          • "incoming"
        • TransitGatewayRouteTableId — (String)

          The ID of the transit gateway route table.

        • State — (String)

          The state of the transit gateway announcement.

          Possible values include:
          • "available"
          • "pending"
          • "failing"
          • "failed"
          • "deleting"
          • "deleted"
        • CreationTime — (Date)

          The timestamp when the transit gateway route table announcement was created.

        • Tags — (Array<map>)

          The key-value pairs associated with the route table announcement.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request

Attaches the specified VPC to the specified transit gateway.

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

Service Reference:

Examples:

Calling the createTransitGatewayVpcAttachment operation

var params = {
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TransitGatewayId: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Options: {
    ApplianceModeSupport: enable | disable,
    DnsSupport: enable | disable,
    Ipv6Support: enable | disable,
    SecurityGroupReferencingSupport: enable | disable
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createTransitGatewayVpcAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayId — (String)

      The ID of the transit gateway.

    • VpcId — (String)

      The ID of the VPC.

    • SubnetIds — (Array<String>)

      The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.

    • Options — (map)

      The VPC attachment options.

      • DnsSupport — (String)

        Enable or disable DNS support. The default is enable.

        Possible values include:
        • "enable"
        • "disable"
      • SecurityGroupReferencingSupport — (String)
        Note: This parameter is in preview and may not be available for your account.

        Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

        If you don't enable or disable SecurityGroupReferencingSupport in the request, the attachment will inherit the security group referencing support setting on the transit gateway.

        Possible values include:
        • "enable"
        • "disable"
      • Ipv6Support — (String)

        Enable or disable IPv6 support. The default is disable.

        Possible values include:
        • "enable"
        • "disable"
      • ApplianceModeSupport — (String)

        Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.

        Possible values include:
        • "enable"
        • "disable"
    • TagSpecifications — (Array<map>)

      The tags to apply to the VPC attachment.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayVpcAttachment — (map)

        Information about the 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.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • SubnetIds — (Array<String>)

          The IDs of the subnets.

        • CreationTime — (Date)

          The creation time.

        • Options — (map)

          The VPC attachment options.

          • DnsSupport — (String)

            Indicates whether DNS support is enabled.

            Possible values include:
            • "enable"
            • "disable"
          • SecurityGroupReferencingSupport — (String)
            Note: This parameter is in preview and may not be available for your account.

            Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

            Possible values include:
            • "enable"
            • "disable"
          • Ipv6Support — (String)

            Indicates whether IPv6 support is disabled.

            Possible values include:
            • "enable"
            • "disable"
          • ApplianceModeSupport — (String)

            Indicates whether appliance mode support is enabled.

            Possible values include:
            • "enable"
            • "disable"
        • Tags — (Array<map>)

          The tags for the VPC attachment.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVerifiedAccessEndpoint(params = {}, callback) ⇒ AWS.Request

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

Service Reference:

Examples:

Calling the createVerifiedAccessEndpoint operation

var params = {
  ApplicationDomain: 'STRING_VALUE', /* required */
  AttachmentType: vpc, /* required */
  DomainCertificateArn: 'STRING_VALUE', /* required */
  EndpointDomainPrefix: 'STRING_VALUE', /* required */
  EndpointType: load-balancer | network-interface, /* required */
  VerifiedAccessGroupId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  LoadBalancerOptions: {
    LoadBalancerArn: 'STRING_VALUE',
    Port: 'NUMBER_VALUE',
    Protocol: http | https,
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  NetworkInterfaceOptions: {
    NetworkInterfaceId: 'STRING_VALUE',
    Port: 'NUMBER_VALUE',
    Protocol: http | https
  },
  PolicyDocument: 'STRING_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SseSpecification: {
    CustomerManagedKeyEnabled: true || false,
    KmsKeyArn: 'STRING_VALUE'
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createVerifiedAccessEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VerifiedAccessGroupId — (String)

      The ID of the Verified Access group to associate the endpoint with.

    • EndpointType — (String)

      The type of Verified Access endpoint to create.

      Possible values include:
      • "load-balancer"
      • "network-interface"
    • AttachmentType — (String)

      The type of attachment.

      Possible values include:
      • "vpc"
    • 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 — (Array<String>)

      The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.

    • LoadBalancerOptions — (map)

      The load balancer details. This parameter is required if the endpoint type is load-balancer.

      • Protocol — (String)

        The IP protocol.

        Possible values include:
        • "http"
        • "https"
      • Port — (Integer)

        The IP port number.

      • LoadBalancerArn — (String)

        The ARN of the load balancer.

      • SubnetIds — (Array<String>)

        The IDs of the subnets.

    • NetworkInterfaceOptions — (map)

      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.

        Possible values include:
        • "http"
        • "https"
      • Port — (Integer)

        The IP port number.

    • Description — (String)

      A description for the Verified Access endpoint.

    • PolicyDocument — (String)

      The Verified Access policy document.

    • TagSpecifications — (Array<map>)

      The tags to assign to the Verified Access endpoint.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (map)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedAccessEndpoint — (map)

        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.

          Possible values include:
          • "load-balancer"
          • "network-interface"
        • AttachmentType — (String)

          The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application.

          Possible values include:
          • "vpc"
        • 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 — (Array<String>)

          The IDs of the security groups for the endpoint.

        • LoadBalancerOptions — (map)

          The load balancer details if creating the Amazon Web Services Verified Access endpoint as load-balancertype.

          • Protocol — (String)

            The IP protocol.

            Possible values include:
            • "http"
            • "https"
          • Port — (Integer)

            The IP port number.

          • LoadBalancerArn — (String)

            The ARN of the load balancer.

          • SubnetIds — (Array<String>)

            The IDs of the subnets.

        • NetworkInterfaceOptions — (map)

          The options for network-interface type endpoint.

          • NetworkInterfaceId — (String)

            The ID of the network interface.

          • Protocol — (String)

            The IP protocol.

            Possible values include:
            • "http"
            • "https"
          • Port — (Integer)

            The IP port number.

        • Status — (map)

          The endpoint status.

          • Code — (String)

            The status code of the Verified Access endpoint.

            Possible values include:
            • "pending"
            • "active"
            • "updating"
            • "deleting"
            • "deleted"
          • Message — (String)

            The status message of the Verified Access endpoint.

        • Description — (String)

          A description for the Amazon Web Services Verified Access endpoint.

        • CreationTime — (String)

          The creation time.

        • LastUpdatedTime — (String)

          The last updated time.

        • DeletionTime — (String)

          The deletion time.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVerifiedAccessGroup(params = {}, callback) ⇒ AWS.Request

An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with "sales" applications together and use one common Verified Access policy.

Service Reference:

Examples:

Calling the createVerifiedAccessGroup operation

var params = {
  VerifiedAccessInstanceId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  PolicyDocument: 'STRING_VALUE',
  SseSpecification: {
    CustomerManagedKeyEnabled: true || false,
    KmsKeyArn: 'STRING_VALUE'
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createVerifiedAccessGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VerifiedAccessInstanceId — (String)

      The ID of the Verified Access instance.

    • Description — (String)

      A description for the Verified Access group.

    • PolicyDocument — (String)

      The Verified Access policy document.

    • TagSpecifications — (Array<map>)

      The tags to assign to the Verified Access group.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (map)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedAccessGroup — (map)

        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 — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVerifiedAccessInstance(params = {}, callback) ⇒ AWS.Request

An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.

Service Reference:

Examples:

Calling the createVerifiedAccessInstance operation

var params = {
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DryRun: true || false,
  FIPSEnabled: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createVerifiedAccessInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A description for the Verified Access instance.

    • TagSpecifications — (Array<map>)

      The tags to assign to the Verified Access instance.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • FIPSEnabled — (Boolean)

      Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedAccessInstance — (map)

        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 — (Array<map>)

          The IDs of the Amazon Web Services Verified Access trust providers.

          • 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).

            Possible values include:
            • "user"
            • "device"
          • UserTrustProviderType — (String)

            The type of user-based trust provider.

            Possible values include:
            • "iam-identity-center"
            • "oidc"
          • DeviceTrustProviderType — (String)

            The type of device-based trust provider.

            Possible values include:
            • "jamf"
            • "crowdstrike"
            • "jumpcloud"
        • CreationTime — (String)

          The creation time.

        • LastUpdatedTime — (String)

          The last updated time.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVerifiedAccessTrustProvider(params = {}, callback) ⇒ AWS.Request

A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.

Service Reference:

Examples:

Calling the createVerifiedAccessTrustProvider operation

var params = {
  PolicyReferenceName: 'STRING_VALUE', /* required */
  TrustProviderType: user | device, /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DeviceOptions: {
    PublicSigningKeyUrl: 'STRING_VALUE',
    TenantId: 'STRING_VALUE'
  },
  DeviceTrustProviderType: jamf | crowdstrike | jumpcloud,
  DryRun: true || false,
  OidcOptions: {
    AuthorizationEndpoint: 'STRING_VALUE',
    ClientId: 'STRING_VALUE',
    ClientSecret: 'STRING_VALUE',
    Issuer: 'STRING_VALUE',
    Scope: 'STRING_VALUE',
    TokenEndpoint: 'STRING_VALUE',
    UserInfoEndpoint: 'STRING_VALUE'
  },
  SseSpecification: {
    CustomerManagedKeyEnabled: true || false,
    KmsKeyArn: 'STRING_VALUE'
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  UserTrustProviderType: iam-identity-center | oidc
};
ec2.createVerifiedAccessTrustProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TrustProviderType — (String)

      The type of trust provider.

      Possible values include:
      • "user"
      • "device"
    • UserTrustProviderType — (String)

      The type of user-based trust provider. This parameter is required when the provider type is user.

      Possible values include:
      • "iam-identity-center"
      • "oidc"
    • DeviceTrustProviderType — (String)

      The type of device-based trust provider. This parameter is required when the provider type is device.

      Possible values include:
      • "jamf"
      • "crowdstrike"
      • "jumpcloud"
    • OidcOptions — (map)

      The options for a OpenID Connect-compatible user-identity trust provider. This parameter is required when the provider type is user.

      • 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)

        OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.

    • DeviceOptions — (map)

      The options for a device-based trust provider. This parameter is required when the provider type is device.

      • 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.

    • Description — (String)

      A description for the Verified Access trust provider.

    • TagSpecifications — (Array<map>)

      The tags to assign to the Verified Access trust provider.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (map)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedAccessTrustProvider — (map)

        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.

          Possible values include:
          • "user"
          • "device"
        • UserTrustProviderType — (String)

          The type of user-based trust provider.

          Possible values include:
          • "iam-identity-center"
          • "oidc"
        • DeviceTrustProviderType — (String)

          The type of device-based trust provider.

          Possible values include:
          • "jamf"
          • "crowdstrike"
          • "jumpcloud"
        • OidcOptions — (map)

          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 — (map)

          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 — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVolume(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a new volume


/* This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``. */

 var params = {
  AvailabilityZone: "us-east-1a", 
  Size: 80, 
  VolumeType: "gp2"
 };
 ec2.createVolume(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AvailabilityZone: "us-east-1a", 
    CreateTime: <Date Representation>, 
    Encrypted: false, 
    Iops: 240, 
    Size: 80, 
    SnapshotId: "", 
    State: "creating", 
    VolumeId: "vol-6b60b7c7", 
    VolumeType: "gp2"
   }
   */
 });

To create a new Provisioned IOPS (SSD) volume from a snapshot


/* This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``. */

 var params = {
  AvailabilityZone: "us-east-1a", 
  Iops: 1000, 
  SnapshotId: "snap-066877671789bd71b", 
  VolumeType: "io1"
 };
 ec2.createVolume(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Attachments: [
    ], 
    AvailabilityZone: "us-east-1a", 
    CreateTime: <Date Representation>, 
    Iops: 1000, 
    Size: 500, 
    SnapshotId: "snap-066877671789bd71b", 
    State: "creating", 
    Tags: [
    ], 
    VolumeId: "vol-1234567890abcdef0", 
    VolumeType: "io1"
   }
   */
 });

Calling the createVolume operation

var params = {
  AvailabilityZone: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  Encrypted: true || false,
  Iops: 'NUMBER_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MultiAttachEnabled: true || false,
  OutpostArn: 'STRING_VALUE',
  Size: 'NUMBER_VALUE',
  SnapshotId: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Throughput: 'NUMBER_VALUE',
  VolumeType: standard | io1 | io2 | gp2 | sc1 | st1 | gp3
};
ec2.createVolume(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AvailabilityZone — (String)

      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

      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

      Possible values include:
      • "standard"
      • "io1"
      • "io2"
      • "gp2"
      • "sc1"
      • "st1"
      • "gp3"
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      The tags to apply to the volume during creation.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attachments — (Array<map>)
        Note: This parameter is not returned by CreateVolume.

        Information about the volume attachments.

        • AttachTime — (Date)

          The time stamp when the attachment initiated.

        • Device — (String)

          The device name.

          If the volume is attached to a Fargate task, this parameter returns null.

        • InstanceId — (String)

          The ID of the instance.

          If the volume is attached to a Fargate task, this parameter returns null.

        • State — (String)

          The attachment state of the volume.

          Possible values include:
          • "attaching"
          • "attached"
          • "detaching"
          • "detached"
          • "busy"
        • VolumeId — (String)

          The ID of the volume.

        • DeleteOnTermination — (Boolean)

          Indicates whether the EBS volume is deleted on instance termination.

        • AssociatedResource — (String)

          The ARN of the Amazon ECS or Fargate task to which the volume is attached.

        • InstanceOwningService — (String)

          The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.

          This parameter is returned only for volumes that are attached to Fargate tasks.

      • AvailabilityZone — (String)

        The Availability Zone for the volume.

      • CreateTime — (Date)

        The time stamp when volume creation was 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.

      • OutpostArn — (String)

        The Amazon Resource Name (ARN) of the Outpost.

      • Size — (Integer)

        The size of the volume, in GiBs.

      • SnapshotId — (String)

        The snapshot from which the volume was created, if applicable.

      • State — (String)

        The volume state.

        Possible values include:
        • "creating"
        • "available"
        • "in-use"
        • "deleting"
        • "deleted"
        • "error"
      • VolumeId — (String)

        The ID of the volume.

      • 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 — (Array<map>)

        Any tags assigned to the volume.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

        Possible values include:
        • "standard"
        • "io1"
        • "io2"
        • "gp2"
        • "sc1"
        • "st1"
        • "gp3"
      • 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.

        Possible values include:
        • "sse-ebs"
        • "sse-kms"
        • "none"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVpc(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To create a VPC


/* This example creates a VPC with the specified CIDR block. */

 var params = {
  CidrBlock: "10.0.0.0/16"
 };
 ec2.createVpc(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Vpc: {
     CidrBlock: "10.0.0.0/16", 
     DhcpOptionsId: "dopt-7a8b9c2d", 
     InstanceTenancy: "default", 
     State: "pending", 
     VpcId: "vpc-a01106c2"
    }
   }
   */
 });

Calling the createVpc operation

var params = {
  AmazonProvidedIpv6CidrBlock: true || false,
  CidrBlock: 'STRING_VALUE',
  DryRun: true || false,
  InstanceTenancy: default | dedicated | host,
  Ipv4IpamPoolId: 'STRING_VALUE',
  Ipv4NetmaskLength: 'NUMBER_VALUE',
  Ipv6CidrBlock: 'STRING_VALUE',
  Ipv6CidrBlockNetworkBorderGroup: 'STRING_VALUE',
  Ipv6IpamPoolId: 'STRING_VALUE',
  Ipv6NetmaskLength: 'NUMBER_VALUE',
  Ipv6Pool: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createVpc(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • 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.

    • 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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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

      Possible values include:
      • "default"
      • "dedicated"
      • "host"
    • 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 — (Array<map>)

      The tags to assign to the VPC.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Vpc — (map)

        Information about 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.

        • State — (String)

          The current state of the VPC.

          Possible values include:
          • "pending"
          • "available"
        • VpcId — (String)

          The ID of 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.

          Possible values include:
          • "default"
          • "dedicated"
          • "host"
        • Ipv6CidrBlockAssociationSet — (Array<map>)

          Information about the IPv6 CIDR blocks associated with the VPC.

          • AssociationId — (String)

            The association ID for the IPv6 CIDR block.

          • Ipv6CidrBlock — (String)

            The IPv6 CIDR block.

          • Ipv6CidrBlockState — (map)

            Information about the state of the CIDR block.

            • State — (String)

              The state of the CIDR block.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failing"
              • "failed"
            • 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.

            Possible values include:
            • "public"
            • "private"
          • 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.

            Possible values include:
            • "amazon"
            • "byoip"
            • "none"
        • CidrBlockAssociationSet — (Array<map>)

          Information about the IPv4 CIDR blocks associated with the VPC.

          • AssociationId — (String)

            The association ID for the IPv4 CIDR block.

          • CidrBlock — (String)

            The IPv4 CIDR block.

          • CidrBlockState — (map)

            Information about the state of the CIDR block.

            • State — (String)

              The state of the CIDR block.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failing"
              • "failed"
            • StatusMessage — (String)

              A message about the status of the CIDR block, if applicable.

        • IsDefault — (Boolean)

          Indicates whether the VPC is the default VPC.

        • Tags — (Array<map>)

          Any tags assigned to the VPC.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVpcEndpoint(params = {}, callback) ⇒ AWS.Request

Creates a VPC endpoint. A VPC endpoint provides a private connection between the specified VPC and the specified endpoint service. You can use an endpoint service provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink User Guide.

Service Reference:

Examples:

Calling the createVpcEndpoint operation

var params = {
  ServiceName: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DnsOptions: {
    DnsRecordIpType: ipv4 | dualstack | ipv6 | service-defined,
    PrivateDnsOnlyForInboundResolverEndpoint: true || false
  },
  DryRun: true || false,
  IpAddressType: ipv4 | dualstack | ipv6,
  PolicyDocument: 'STRING_VALUE',
  PrivateDnsEnabled: true || false,
  RouteTableIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SubnetConfigurations: [
    {
      Ipv4: 'STRING_VALUE',
      Ipv6: 'STRING_VALUE',
      SubnetId: 'STRING_VALUE'
    },
    /* more items */
  ],
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  VpcEndpointType: Interface | Gateway | GatewayLoadBalancer
};
ec2.createVpcEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • VpcEndpointType — (String)

      The type of endpoint.

      Default: Gateway

      Possible values include:
      • "Interface"
      • "Gateway"
      • "GatewayLoadBalancer"
    • VpcId — (String)

      The ID of the VPC.

    • ServiceName — (String)

      The name of the endpoint 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. If this parameter is not specified, we attach a default policy that allows full access to the service.

    • RouteTableIds — (Array<String>)

      (Gateway endpoint) The route table IDs.

    • SubnetIds — (Array<String>)

      (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.

    • SecurityGroupIds — (Array<String>)

      (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.

    • IpAddressType — (String)

      The IP address type for the endpoint.

      Possible values include:
      • "ipv4"
      • "dualstack"
      • "ipv6"
    • DnsOptions — (map)

      The DNS options for the endpoint.

      • DnsRecordIpType — (String)

        The DNS records created for the endpoint.

        Possible values include:
        • "ipv4"
        • "dualstack"
        • "ipv6"
        • "service-defined"
      • 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.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • PrivateDnsEnabled — (Boolean)

      (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

      To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

      Default: true

    • TagSpecifications — (Array<map>)

      The tags to associate with the endpoint.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

    • SubnetConfigurations — (Array<map>)

      The subnet configurations for the 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcEndpoint — (map)

        Information about the endpoint.

        • VpcEndpointId — (String)

          The ID of the endpoint.

        • VpcEndpointType — (String)

          The type of endpoint.

          Possible values include:
          • "Interface"
          • "Gateway"
          • "GatewayLoadBalancer"
        • 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.

          Possible values include:
          • "PendingAcceptance"
          • "Pending"
          • "Available"
          • "Deleting"
          • "Deleted"
          • "Rejected"
          • "Failed"
          • "Expired"
        • PolicyDocument — (String)

          The policy document associated with the endpoint, if applicable.

        • RouteTableIds — (Array<String>)

          (Gateway endpoint) The IDs of the route tables associated with the endpoint.

        • SubnetIds — (Array<String>)

          (Interface endpoint) The subnets for the endpoint.

        • Groups — (Array<map>)

          (Interface endpoint) Information about the security groups that are associated with the network interface.

          • 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.

          Possible values include:
          • "ipv4"
          • "dualstack"
          • "ipv6"
        • DnsOptions — (map)

          The DNS options for the endpoint.

          • DnsRecordIpType — (String)

            The DNS records created for the endpoint.

            Possible values include:
            • "ipv4"
            • "dualstack"
            • "ipv6"
            • "service-defined"
          • 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 — (Array<String>)

          (Interface endpoint) The network interfaces for the endpoint.

        • DnsEntries — (Array<map>)

          (Interface endpoint) The DNS entries for the endpoint.

          • DnsName — (String)

            The DNS name.

          • HostedZoneId — (String)

            The ID of the private hosted zone.

        • CreationTimestamp — (Date)

          The date and time that the endpoint was created.

        • Tags — (Array<map>)

          The tags assigned to the endpoint.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

      • ClientToken — (String)

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVpcEndpointConnectionNotification(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createVpcEndpointConnectionNotification operation

var params = {
  ConnectionEvents: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ConnectionNotificationArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  ServiceId: 'STRING_VALUE',
  VpcEndpointId: 'STRING_VALUE'
};
ec2.createVpcEndpointConnectionNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ARN of the SNS topic for the notifications.

    • ConnectionEvents — (Array<String>)

      The endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConnectionNotification — (map)

        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.

          Possible values include:
          • "Topic"
        • ConnectionNotificationArn — (String)

          The ARN of the SNS topic for the notification.

        • ConnectionEvents — (Array<String>)

          The events for the notification. Valid values are Accept, Connect, Delete, and Reject.

        • ConnectionNotificationState — (String)

          The state of the notification.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • ClientToken — (String)

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVpcEndpointServiceConfiguration(params = {}, callback) ⇒ AWS.Request

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect.

Before you create an endpoint service, you must create one of the following for your service:

If you set the private DNS name, you must prove that you own the private DNS domain name.

For more information, see the Amazon Web Services PrivateLink Guide.

Service Reference:

Examples:

Calling the createVpcEndpointServiceConfiguration operation

var params = {
  AcceptanceRequired: true || false,
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  GatewayLoadBalancerArns: [
    'STRING_VALUE',
    /* more items */
  ],
  NetworkLoadBalancerArns: [
    'STRING_VALUE',
    /* more items */
  ],
  PrivateDnsName: 'STRING_VALUE',
  SupportedIpAddressTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createVpcEndpointServiceConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • AcceptanceRequired — (Boolean)

      Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.

    • PrivateDnsName — (String)

      (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.

    • NetworkLoadBalancerArns — (Array<String>)

      The Amazon Resource Names (ARNs) of the Network Load Balancers.

    • GatewayLoadBalancerArns — (Array<String>)

      The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

    • SupportedIpAddressTypes — (Array<String>)

      The supported IP address types. The possible values are ipv4 and ipv6.

    • ClientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • TagSpecifications — (Array<map>)

      The tags to associate with the service.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServiceConfiguration — (map)

        Information about the service configuration.

        • ServiceType — (Array<map>)

          The type of service.

          • ServiceType — (String)

            The type of service.

            Possible values include:
            • "Interface"
            • "Gateway"
            • "GatewayLoadBalancer"
        • ServiceId — (String)

          The ID of the service.

        • ServiceName — (String)

          The name of the service.

        • ServiceState — (String)

          The service state.

          Possible values include:
          • "Pending"
          • "Available"
          • "Deleting"
          • "Deleted"
          • "Failed"
        • AvailabilityZones — (Array<String>)

          The Availability Zones in which the service is available.

        • 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 — (Array<String>)

          The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

        • GatewayLoadBalancerArns — (Array<String>)

          The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

        • SupportedIpAddressTypes — (Array<String>)

          The supported IP address types.

        • BaseEndpointDnsNames — (Array<String>)

          The DNS names for the service.

        • PrivateDnsName — (String)

          The private DNS name for the service.

        • PrivateDnsNameConfiguration — (map)

          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.

            Possible values include:
            • "pendingVerification"
            • "verified"
            • "failed"
          • 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.

          Possible values include:
          • "ServiceOwner"
        • Tags — (Array<map>)

          The tags assigned to the service.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createVpcPeeringConnection operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  PeerOwnerId: 'STRING_VALUE',
  PeerRegion: 'STRING_VALUE',
  PeerVpcId: 'STRING_VALUE',
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createVpcPeeringConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • PeerOwnerId — (String)

      The Amazon Web Services account ID of the owner of the accepter VPC.

      Default: Your Amazon Web Services account ID

    • PeerVpcId — (String)

      The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.

    • VpcId — (String)

      The ID of the requester VPC. You must specify this parameter in the request.

    • 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 — (Array<map>)

      The tags to assign to the peering connection.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcPeeringConnection — (map)

        Information about the VPC peering connection.

        • AccepterVpcInfo — (map)

          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 — (Array<map>)

            The IPv6 CIDR block for the VPC.

            • Ipv6CidrBlock — (String)

              The IPv6 CIDR block.

          • CidrBlockSet — (Array<map>)

            Information about the IPv4 CIDR blocks for the VPC.

            • CidrBlock — (String)

              The IPv4 CIDR block.

          • OwnerId — (String)

            The ID of the Amazon Web Services account that owns the VPC.

          • PeeringOptions — (map)

            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 — (Date)

          The time that an unaccepted VPC peering connection will expire.

        • RequesterVpcInfo — (map)

          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 — (Array<map>)

            The IPv6 CIDR block for the VPC.

            • Ipv6CidrBlock — (String)

              The IPv6 CIDR block.

          • CidrBlockSet — (Array<map>)

            Information about the IPv4 CIDR blocks for the VPC.

            • CidrBlock — (String)

              The IPv4 CIDR block.

          • OwnerId — (String)

            The ID of the Amazon Web Services account that owns the VPC.

          • PeeringOptions — (map)

            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 — (map)

          The status of the VPC peering connection.

          • Code — (String)

            The status of the VPC peering connection.

            Possible values include:
            • "initiating-request"
            • "pending-acceptance"
            • "active"
            • "deleted"
            • "rejected"
            • "failed"
            • "expired"
            • "provisioning"
            • "deleting"
          • Message — (String)

            A message that provides more information about the status, if applicable.

        • Tags — (Array<map>)

          Any tags assigned to the resource.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVpnConnection(params = {}, callback) ⇒ AWS.Request

Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Service Reference:

Examples:

Calling the createVpnConnection operation

var params = {
  CustomerGatewayId: 'STRING_VALUE', /* required */
  Type: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Options: {
    EnableAcceleration: true || false,
    LocalIpv4NetworkCidr: 'STRING_VALUE',
    LocalIpv6NetworkCidr: 'STRING_VALUE',
    OutsideIpAddressType: 'STRING_VALUE',
    RemoteIpv4NetworkCidr: 'STRING_VALUE',
    RemoteIpv6NetworkCidr: 'STRING_VALUE',
    StaticRoutesOnly: true || false,
    TransportTransitGatewayAttachmentId: 'STRING_VALUE',
    TunnelInsideIpVersion: ipv4 | ipv6,
    TunnelOptions: [
      {
        DPDTimeoutAction: 'STRING_VALUE',
        DPDTimeoutSeconds: 'NUMBER_VALUE',
        EnableTunnelLifecycleControl: true || false,
        IKEVersions: [
          {
            Value: 'STRING_VALUE'
          },
          /* more items */
        ],
        LogOptions: {
          CloudWatchLogOptions: {
            LogEnabled: true || false,
            LogGroupArn: 'STRING_VALUE',
            LogOutputFormat: 'STRING_VALUE'
          }
        },
        Phase1DHGroupNumbers: [
          {
            Value: 'NUMBER_VALUE'
          },
          /* more items */
        ],
        Phase1EncryptionAlgorithms: [
          {
            Value: 'STRING_VALUE'
          },
          /* more items */
        ],
        Phase1IntegrityAlgorithms: [
          {
            Value: 'STRING_VALUE'
          },
          /* more items */
        ],
        Phase1LifetimeSeconds: 'NUMBER_VALUE',
        Phase2DHGroupNumbers: [
          {
            Value: 'NUMBER_VALUE'
          },
          /* more items */
        ],
        Phase2EncryptionAlgorithms: [
          {
            Value: 'STRING_VALUE'
          },
          /* more items */
        ],
        Phase2IntegrityAlgorithms: [
          {
            Value: 'STRING_VALUE'
          },
          /* more items */
        ],
        Phase2LifetimeSeconds: 'NUMBER_VALUE',
        PreSharedKey: 'STRING_VALUE',
        RekeyFuzzPercentage: 'NUMBER_VALUE',
        RekeyMarginTimeSeconds: 'NUMBER_VALUE',
        ReplayWindowSize: 'NUMBER_VALUE',
        StartupAction: 'STRING_VALUE',
        TunnelInsideCidr: 'STRING_VALUE',
        TunnelInsideIpv6Cidr: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TransitGatewayId: 'STRING_VALUE',
  VpnGatewayId: 'STRING_VALUE'
};
ec2.createVpnConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CustomerGatewayId — (String)

      The ID of the customer gateway.

    • Type — (String)

      The type of VPN connection (ipsec.1).

    • VpnGatewayId — (String)

      The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

    • TransitGatewayId — (String)

      The ID of the transit gateway. If you specify a transit gateway, you cannot specify a 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.

    • Options — (map)

      The options for the VPN connection.

      • EnableAcceleration — (Boolean)

        Indicate whether to enable acceleration for the VPN connection.

        Default: false

      • StaticRoutesOnly — (Boolean)

        Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.

        Default: false

      • TunnelInsideIpVersion — (String)

        Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

        Default: ipv4

        Possible values include:
        • "ipv4"
        • "ipv6"
      • TunnelOptions — (Array<map>)

        The tunnel options for the VPN connection.

        • 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 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.

          Constraints: A value greater than or equal to 30.

          Default: 30

        • 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 — (Array<map>)

          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

          • Value — (String)

            The value for the encryption algorithm.

        • Phase2EncryptionAlgorithms — (Array<map>)

          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

          • Value — (String)

            The encryption algorithm.

        • Phase1IntegrityAlgorithms — (Array<map>)

          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

          • Value — (String)

            The value for the integrity algorithm.

        • Phase2IntegrityAlgorithms — (Array<map>)

          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

          • Value — (String)

            The integrity algorithm.

        • Phase1DHGroupNumbers — (Array<map>)

          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

          • Value — (Integer)

            The Diffie-Hellmann group number.

        • Phase2DHGroupNumbers — (Array<map>)

          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

          • Value — (Integer)

            The Diffie-Hellmann group number.

        • IKEVersions — (Array<map>)

          The IKE versions that are permitted for the VPN tunnel.

          Valid values: ikev1 | ikev2

          • 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 — (map)

          Options for logging VPN tunnel activity.

          • CloudWatchLogOptions — (map)

            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.

      • 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

      • OutsideIpAddressType — (String)

        The type of IPv4 address assigned to the outside interface of the customer gateway device.

        Valid values: PrivateIpv4 | PublicIpv4

        Default: PublicIpv4

      • TransportTransitGatewayAttachmentId — (String)

        The transit gateway attachment ID to use for the VPN tunnel.

        Required if OutsideIpAddressType is set to PrivateIpv4.

    • TagSpecifications — (Array<map>)

      The tags to apply to the VPN connection.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpnConnection — (map)

        Information about 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.

        • CustomerGatewayId — (String)

          The ID of the customer gateway at your end of 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.

        • State — (String)

          The current state of the VPN connection.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • Type — (String)

          The type of VPN connection.

          Possible values include:
          • "ipsec.1"
        • VpnConnectionId — (String)

          The ID of the VPN connection.

        • VpnGatewayId — (String)

          The ID of the virtual private gateway at the Amazon Web Services side of the 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.

          Possible values include:
          • "associated"
          • "not-associated"
          • "associating"
          • "disassociating"
        • Options — (map)

          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

            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.

            Possible values include:
            • "ipv4"
            • "ipv6"
          • TunnelOptions — (Array<map>)

            Indicates 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 — (Array<map>)

              The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.

              • Value — (String)

                The value for the encryption algorithm.

            • Phase2EncryptionAlgorithms — (Array<map>)

              The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.

              • Value — (String)

                The encryption algorithm.

            • Phase1IntegrityAlgorithms — (Array<map>)

              The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.

              • Value — (String)

                The value for the integrity algorithm.

            • Phase2IntegrityAlgorithms — (Array<map>)

              The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.

              • Value — (String)

                The integrity algorithm.

            • Phase1DHGroupNumbers — (Array<map>)

              The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.

              • Value — (Integer)

                The Diffie-Hellmann group number.

            • Phase2DHGroupNumbers — (Array<map>)

              The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.

              • Value — (Integer)

                The Diffie-Hellmann group number.

            • IkeVersions — (Array<map>)

              The IKE versions that are 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 — (map)

              Options for logging VPN tunnel activity.

              • CloudWatchLogOptions — (map)

                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 — (Array<map>)

          The static routes associated with the 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.

            Possible values include:
            • "Static"
          • State — (String)

            The current state of the static route.

            Possible values include:
            • "pending"
            • "available"
            • "deleting"
            • "deleted"
        • Tags — (Array<map>)

          Any tags assigned to the VPN connection.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

          Information about the VPN tunnel.

          • AcceptedRouteCount — (Integer)

            The number of accepted routes.

          • LastStatusChange — (Date)

            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.

            Possible values include:
            • "UP"
            • "DOWN"
          • StatusMessage — (String)

            If an error occurs, a description of the error.

          • CertificateArn — (String)

            The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVpnConnectionRoute(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createVpnConnectionRoute operation

var params = {
  DestinationCidrBlock: 'STRING_VALUE', /* required */
  VpnConnectionId: 'STRING_VALUE' /* required */
};
ec2.createVpnConnectionRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DestinationCidrBlock — (String)

      The CIDR block associated with the local subnet of the customer network.

    • VpnConnectionId — (String)

      The ID of the VPN connection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createVpnGateway(params = {}, callback) ⇒ AWS.Request

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Service Reference:

Examples:

Calling the createVpnGateway operation

var params = {
  Type: ipsec.1, /* required */
  AmazonSideAsn: 'NUMBER_VALUE',
  AvailabilityZone: 'STRING_VALUE',
  DryRun: true || false,
  TagSpecifications: [
    {
      ResourceType: capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | 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 | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | 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 | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | ipam-external-resource-verification-token,
      Tags: [
        {
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.createVpnGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AvailabilityZone — (String)

      The Availability Zone for the virtual private gateway.

    • Type — (String)

      The type of VPN connection this virtual private gateway supports.

      Possible values include:
      • "ipsec.1"
    • TagSpecifications — (Array<map>)

      The tags to apply to the virtual private gateway.

      • ResourceType — (String)

        The type of resource to tag on creation.

        Possible values include:
        • "capacity-reservation"
        • "client-vpn-endpoint"
        • "customer-gateway"
        • "carrier-gateway"
        • "coip-pool"
        • "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"
        • "placement-group"
        • "prefix-list"
        • "replace-root-volume-task"
        • "reserved-instances"
        • "route-table"
        • "security-group"
        • "security-group-rule"
        • "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"
        • "ipam-resource-discovery"
        • "ipam-resource-discovery-association"
        • "instance-connect-endpoint"
        • "ipam-external-resource-verification-token"
      • Tags — (Array<map>)

        The tags to apply to the resource.

        • Key — (String)

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value — (String)

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

    • AmazonSideAsn — (Integer)

      A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

      Default: 64512

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpnGateway — (map)

        Information about the virtual private gateway.

        • AvailabilityZone — (String)

          The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

        • State — (String)

          The current state of the virtual private gateway.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • Type — (String)

          The type of VPN connection the virtual private gateway supports.

          Possible values include:
          • "ipsec.1"
        • VpcAttachments — (Array<map>)

          Any VPCs attached to the virtual private gateway.

          • State — (String)

            The current state of the attachment.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • VpcId — (String)

            The ID of the VPC.

        • VpnGatewayId — (String)

          The ID of the virtual private gateway.

        • AmazonSideAsn — (Integer)

          The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

        • Tags — (Array<map>)

          Any tags assigned to the virtual private gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCarrierGateway(params = {}, callback) ⇒ AWS.Request

Deletes a carrier gateway.

If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.

Service Reference:

Examples:

Calling the deleteCarrierGateway operation

var params = {
  CarrierGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteCarrierGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CarrierGatewayId — (String)

      The ID of the carrier 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CarrierGateway — (map)

        Information about the 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.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • OwnerId — (String)

          The Amazon Web Services account ID of the owner of the carrier gateway.

        • Tags — (Array<map>)

          The tags assigned to the carrier gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteClientVpnEndpoint(params = {}, callback) ⇒ AWS.Request

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.

Service Reference:

Examples:

Calling the deleteClientVpnEndpoint operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteClientVpnEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN to be 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (map)

        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.

          Possible values include:
          • "pending-associate"
          • "available"
          • "deleting"
          • "deleted"
        • Message — (String)

          A message about the status of the Client VPN endpoint.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteClientVpnRoute(params = {}, callback) ⇒ AWS.Request

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.

Service Reference:

Examples:

Calling the deleteClientVpnRoute operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  DestinationCidrBlock: 'STRING_VALUE', /* required */
  DryRun: true || false,
  TargetVpcSubnetId: 'STRING_VALUE'
};
ec2.deleteClientVpnRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint from which the route is to be deleted.

    • TargetVpcSubnetId — (String)

      The ID of the target subnet used by the route.

    • DestinationCidrBlock — (String)

      The IPv4 address range, in CIDR notation, of the route to be 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (map)

        The current state of the route.

        • Code — (String)

          The state of the Client VPN endpoint route.

          Possible values include:
          • "creating"
          • "active"
          • "failed"
          • "deleting"
        • Message — (String)

          A message about the status of the Client VPN endpoint route, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCoipCidr(params = {}, callback) ⇒ AWS.Request

Deletes a range of customer-owned IP addresses.

Service Reference:

Examples:

Calling the deleteCoipCidr operation

var params = {
  Cidr: 'STRING_VALUE', /* required */
  CoipPoolId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteCoipCidr(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Cidr — (String)

      A customer-owned IP address range that you want to delete.

    • CoipPoolId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CoipCidr — (map)

        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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCoipPool(params = {}, callback) ⇒ AWS.Request

Deletes a pool of customer-owned IP (CoIP) addresses.

Service Reference:

Examples:

Calling the deleteCoipPool operation

var params = {
  CoipPoolId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteCoipPool(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CoipPoolId — (String)

      The ID of the CoIP pool that you want 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CoipPool — (map)

        Information about the CoIP address pool.

        • PoolId — (String)

          The ID of the address pool.

        • PoolCidrs — (Array<String>)

          The address ranges of the address pool.

        • LocalGatewayRouteTableId — (String)

          The ID of the local gateway route table.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCustomerGateway(params = {}, callback) ⇒ AWS.Request

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

Service Reference:

Examples:

To delete a customer gateway


/* This example deletes the specified customer gateway. */

 var params = {
  CustomerGatewayId: "cgw-0e11f167"
 };
 ec2.deleteCustomerGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteCustomerGateway operation

var params = {
  CustomerGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteCustomerGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CustomerGatewayId — (String)

      The ID of the customer 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDhcpOptions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To delete a DHCP options set


/* This example deletes the specified DHCP options set. */

 var params = {
  DhcpOptionsId: "dopt-d9070ebb"
 };
 ec2.deleteDhcpOptions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteDhcpOptions operation

var params = {
  DhcpOptionsId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteDhcpOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DhcpOptionsId — (String)

      The ID of the DHCP options set.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteEgressOnlyInternetGateway(params = {}, callback) ⇒ AWS.Request

Deletes an egress-only internet gateway.

Service Reference:

Examples:

Calling the deleteEgressOnlyInternetGateway operation

var params = {
  EgressOnlyInternetGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteEgressOnlyInternetGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • EgressOnlyInternetGatewayId — (String)

      The ID of the egress-only internet gateway.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReturnCode — (Boolean)

        Returns true if the request succeeds; otherwise, it returns an error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteFleets(params = {}, callback) ⇒ AWS.Request

Deletes the specified EC2 Fleets.

After you delete an EC2 Fleet, it launches no new instances.

You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.

For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. Up to 1000 instances can be terminated in a single request to delete instant fleets. A deleted instant fleet with running instances is not supported.

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 in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the deleteFleets operation

var params = {
  FleetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TerminateInstances: true || false, /* required */
  DryRun: true || false
};
ec2.deleteFleets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      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.

    • TerminateInstances — (Boolean)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SuccessfulFleetDeletions — (Array<map>)

        Information about the EC2 Fleets that are successfully deleted.

        • CurrentFleetState — (String)

          The current state of the EC2 Fleet.

          Possible values include:
          • "submitted"
          • "active"
          • "deleted"
          • "failed"
          • "deleted_running"
          • "deleted_terminating"
          • "modifying"
        • PreviousFleetState — (String)

          The previous state of the EC2 Fleet.

          Possible values include:
          • "submitted"
          • "active"
          • "deleted"
          • "failed"
          • "deleted_running"
          • "deleted_terminating"
          • "modifying"
        • FleetId — (String)

          The ID of the EC2 Fleet.

      • UnsuccessfulFleetDeletions — (Array<map>)

        Information about the EC2 Fleets that are not successfully deleted.

        • Error — (map)

          The error.

          • Code — (String)

            The error code.

            Possible values include:
            • "fleetIdDoesNotExist"
            • "fleetIdMalformed"
            • "fleetNotInDeletableState"
            • "unexpectedError"
          • Message — (String)

            The description for the error code.

        • FleetId — (String)

          The ID of the EC2 Fleet.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteFlowLogs(params = {}, callback) ⇒ AWS.Request

Deletes one or more flow logs.

Service Reference:

Examples:

Calling the deleteFlowLogs operation

var params = {
  FlowLogIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.deleteFlowLogs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      One or more flow log IDs.

      Constraint: Maximum of 1000 flow log IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Unsuccessful — (Array<map>)

        Information about the flow logs that could not be deleted successfully.

        • Error — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteFpgaImage(params = {}, callback) ⇒ AWS.Request

Deletes the specified Amazon FPGA Image (AFI).

Service Reference:

Examples:

Calling the deleteFpgaImage operation

var params = {
  FpgaImageId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteFpgaImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the AFI.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Is true if the request succeeds, and an error otherwise.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteInstanceConnectEndpoint(params = {}, callback) ⇒ AWS.Request

Deletes the specified EC2 Instance Connect Endpoint.

Service Reference:

Examples:

Calling the deleteInstanceConnectEndpoint operation

var params = {
  InstanceConnectEndpointId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteInstanceConnectEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • InstanceConnectEndpointId — (String)

      The ID of the EC2 Instance Connect Endpoint to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceConnectEndpoint — (map)

        Information about 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.

          Possible values include:
          • "create-in-progress"
          • "create-complete"
          • "create-failed"
          • "delete-in-progress"
          • "delete-complete"
          • "delete-failed"
        • 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)

        • NetworkInterfaceIds — (Array<String>)

          The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.

        • 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 — (Date)

          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 — (Array<String>)

          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.

        • Tags — (Array<map>)

          The tags assigned to the EC2 Instance Connect Endpoint.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteInstanceEventWindow(params = {}, callback) ⇒ AWS.Request

Deletes the specified event window.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the deleteInstanceEventWindow operation

var params = {
  InstanceEventWindowId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  ForceDelete: true || false
};
ec2.deleteInstanceEventWindow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the event window.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceEventWindowState — (map)

        The state of the event window.

        • InstanceEventWindowId — (String)

          The ID of the event window.

        • State — (String)

          The current state of the event window.

          Possible values include:
          • "creating"
          • "deleting"
          • "active"
          • "deleted"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteInternetGateway(params = {}, callback) ⇒ AWS.Request

Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.

Service Reference:

Examples:

To delete an Internet gateway


/* This example deletes the specified Internet gateway. */

 var params = {
  InternetGatewayId: "igw-c0a643a9"
 };
 ec2.deleteInternetGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteInternetGateway operation

var params = {
  InternetGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteInternetGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the internet gateway.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteIpam(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteIpam operation

var params = {
  IpamId: 'STRING_VALUE', /* required */
  Cascade: true || false,
  DryRun: true || false
};
ec2.deleteIpam(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Ipam — (map)

        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 — (Array<map>)

          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.

          Possible values include:
          • "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 — (Array<map>)

          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 the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "free"
          • "advanced"
        • EnablePrivateGua — (Boolean)

          Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteIpamExternalResourceVerificationToken(params = {}, callback) ⇒ AWS.Request

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).

Service Reference:

Examples:

Calling the deleteIpamExternalResourceVerificationToken operation

var params = {
  IpamExternalResourceVerificationTokenId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteIpamExternalResourceVerificationToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      The token ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamExternalResourceVerificationToken — (map)

        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 — (Date)

          Token expiration.

        • Status — (String)

          Token status.

          Possible values include:
          • "valid"
          • "expired"
        • Tags — (Array<map>)

          Token tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "create-in-progress"
          • "create-complete"
          • "create-failed"
          • "delete-in-progress"
          • "delete-complete"
          • "delete-failed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteIpamPool(params = {}, callback) ⇒ AWS.Request

Delete an IPAM pool.

Note: You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.

For more information, see Delete a pool in the Amazon VPC IPAM User Guide.

Service Reference:

Examples:

Calling the deleteIpamPool operation

var params = {
  IpamPoolId: 'STRING_VALUE', /* required */
  Cascade: true || false,
  DryRun: true || false
};
ec2.deleteIpamPool(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      The ID of the pool to delete.

    • Cascade — (Boolean)

      Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.

      You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamPool — (map)

        Information about the results of the deletion.

        • 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.

          Possible values include:
          • "public"
          • "private"
        • 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.

          Possible values include:
          • "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)

          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.

          Possible values include:
          • "ipv4"
          • "ipv6"
        • 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 — (Array<map>)

          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.

          • 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 — (Array<map>)

          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 the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "ec2"
        • 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.

          Possible values include:
          • "amazon"
          • "byoip"
        • SourceResource — (map)

          The resource used to provision CIDRs to a resource planning pool.

          • ResourceId — (String)

            The source resource ID.

          • ResourceType — (String)

            The source resource type.

            Possible values include:
            • "vpc"
          • ResourceRegion — (String)

            The source resource Region.

          • ResourceOwner — (String)

            The source resource owner.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteIpamResourceDiscovery(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteIpamResourceDiscovery operation

var params = {
  IpamResourceDiscoveryId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteIpamResourceDiscovery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      The IPAM resource discovery ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamResourceDiscovery — (map)

        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 — (Array<map>)

          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.

          • 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.

          Possible values include:
          • "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 — (Array<map>)

          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.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteIpamScope(params = {}, callback) ⇒ AWS.Request

Delete the scope for an IPAM. You cannot delete the default scopes.

For more information, see Delete a scope in the Amazon VPC IPAM User Guide.

Service Reference:

Examples:

Calling the deleteIpamScope operation

var params = {
  IpamScopeId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteIpamScope(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      The ID of the scope to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamScope — (map)

        Information about the results of the deletion.

        • 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.

          Possible values include:
          • "public"
          • "private"
        • 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.

          Possible values include:
          • "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 — (Array<map>)

          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 the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteKeyPair(params = {}, callback) ⇒ AWS.Request

Deletes the specified key pair, by removing the public key from Amazon EC2.

Service Reference:

Examples:

To delete a key pair


/* This example deletes the specified key pair. */

 var params = {
  KeyName: "my-key-pair"
 };
 ec2.deleteKeyPair(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteKeyPair operation

var params = {
  DryRun: true || false,
  KeyName: 'STRING_VALUE',
  KeyPairId: 'STRING_VALUE'
};
ec2.deleteKeyPair(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Is true if the request succeeds, and an error otherwise.

      • KeyPairId — (String)

        The ID of the key pair.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteLaunchTemplate(params = {}, callback) ⇒ AWS.Request

Deletes a launch template. Deleting a launch template deletes all of its versions.

Service Reference:

Examples:

To delete a launch template


/* This example deletes the specified launch template. */

 var params = {
  LaunchTemplateId: "lt-0abcd290751193123"
 };
 ec2.deleteLaunchTemplate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LaunchTemplate: {
     CreateTime: <Date Representation>, 
     CreatedBy: "arn:aws:iam::123456789012:root", 
     DefaultVersionNumber: 2, 
     LatestVersionNumber: 2, 
     LaunchTemplateId: "lt-0abcd290751193123", 
     LaunchTemplateName: "my-template"
    }
   }
   */
 });

Calling the deleteLaunchTemplate operation

var params = {
  DryRun: true || false,
  LaunchTemplateId: 'STRING_VALUE',
  LaunchTemplateName: 'STRING_VALUE'
};
ec2.deleteLaunchTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LaunchTemplate — (map)

        Information about the launch template.

        • LaunchTemplateId — (String)

          The ID of the launch template.

        • LaunchTemplateName — (String)

          The name of the launch template.

        • CreateTime — (Date)

          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 — (Array<map>)

          The tags for the launch template.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteLaunchTemplateVersions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To delete a launch template version


/* This example deletes the specified launch template version. */

 var params = {
  LaunchTemplateId: "lt-0abcd290751193123", 
  Versions: [
     "1"
  ]
 };
 ec2.deleteLaunchTemplateVersions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SuccessfullyDeletedLaunchTemplateVersions: [
       {
      LaunchTemplateId: "lt-0abcd290751193123", 
      LaunchTemplateName: "my-template", 
      VersionNumber: 1
     }
    ], 
    UnsuccessfullyDeletedLaunchTemplateVersions: [
    ]
   }
   */
 });

Calling the deleteLaunchTemplateVersions operation

var params = {
  Versions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  LaunchTemplateId: 'STRING_VALUE',
  LaunchTemplateName: 'STRING_VALUE'
};
ec2.deleteLaunchTemplateVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The version numbers of one or more launch template versions to delete. You can specify up to 200 launch template version numbers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SuccessfullyDeletedLaunchTemplateVersions — (Array<map>)

        Information about the launch template versions that were 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 — (Array<map>)

        Information about the launch template versions 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 — (map)

          Information about the error.

          • Code — (String)

            The error code.

            Possible values include:
            • "launchTemplateIdDoesNotExist"
            • "launchTemplateIdMalformed"
            • "launchTemplateNameDoesNotExist"
            • "launchTemplateNameMalformed"
            • "launchTemplateVersionDoesNotExist"
            • "unexpectedError"
          • Message — (String)

            The error message, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteLocalGatewayRoute(params = {}, callback) ⇒ AWS.Request

Deletes the specified route from the specified local gateway route table.

Service Reference:

Examples:

Calling the deleteLocalGatewayRoute operation

var params = {
  LocalGatewayRouteTableId: 'STRING_VALUE', /* required */
  DestinationCidrBlock: 'STRING_VALUE',
  DestinationPrefixListId: 'STRING_VALUE',
  DryRun: true || false
};
ec2.deleteLocalGatewayRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DestinationCidrBlock — (String)

      The CIDR range for the route. This must match the CIDR for the route exactly.

    • LocalGatewayRouteTableId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Route — (map)

        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.

          Possible values include:
          • "static"
          • "propagated"
        • State — (String)

          The state of the route.

          Possible values include:
          • "pending"
          • "active"
          • "blackhole"
          • "deleting"
          • "deleted"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteLocalGatewayRouteTable(params = {}, callback) ⇒ AWS.Request

Deletes a local gateway route table.

Service Reference:

Examples:

Calling the deleteLocalGatewayRouteTable operation

var params = {
  LocalGatewayRouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteLocalGatewayRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTable — (map)

        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 — (Array<map>)

          The tags assigned to the local gateway route table.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "direct-vpc-routing"
          • "coip"
        • StateReason — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation(params = {}, callback) ⇒ AWS.Request

Deletes a local gateway route table virtual interface group association.

Service Reference:

Examples:

Calling the deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation operation

var params = {
  LocalGatewayRouteTableVirtualInterfaceGroupAssociationId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableVirtualInterfaceGroupAssociationId — (String)

      The ID of the local gateway route table virtual interface group 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTableVirtualInterfaceGroupAssociation — (map)

        Information about the association.

        • LocalGatewayRouteTableVirtualInterfaceGroupAssociationId — (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 — (Array<map>)

          The tags assigned to the association.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteLocalGatewayRouteTableVpcAssociation(params = {}, callback) ⇒ AWS.Request

Deletes the specified association between a VPC and local gateway route table.

Service Reference:

Examples:

Calling the deleteLocalGatewayRouteTableVpcAssociation operation

var params = {
  LocalGatewayRouteTableVpcAssociationId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteLocalGatewayRouteTableVpcAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableVpcAssociationId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTableVpcAssociation — (map)

        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 — (Array<map>)

          The tags assigned to the association.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteManagedPrefixList(params = {}, callback) ⇒ AWS.Request

Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.

Service Reference:

Examples:

Calling the deleteManagedPrefixList operation

var params = {
  PrefixListId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteManagedPrefixList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the prefix list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PrefixList — (map)

        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.

          Possible values include:
          • "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)

          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 — (Array<map>)

          The tags for the prefix list.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteNatGateway(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To delete a NAT gateway


/* This example deletes the specified NAT gateway. */

 var params = {
  NatGatewayId: "nat-04ae55e711cec5680"
 };
 ec2.deleteNatGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NatGatewayId: "nat-04ae55e711cec5680"
   }
   */
 });

Calling the deleteNatGateway operation

var params = {
  NatGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteNatGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the NAT gateway.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NatGatewayId — (String)

        The ID of the NAT gateway.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteNetworkAcl(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To delete a network ACL


/* This example deletes the specified network ACL. */

 var params = {
  NetworkAclId: "acl-5fb85d36"
 };
 ec2.deleteNetworkAcl(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteNetworkAcl operation

var params = {
  NetworkAclId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteNetworkAcl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the network ACL.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteNetworkAclEntry(params = {}, callback) ⇒ AWS.Request

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

Service Reference:

Examples:

To delete a network ACL entry


/* This example deletes ingress rule number 100 from the specified network ACL. */

 var params = {
  Egress: true, 
  NetworkAclId: "acl-5fb85d36", 
  RuleNumber: 100
 };
 ec2.deleteNetworkAclEntry(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteNetworkAclEntry operation

var params = {
  Egress: true || false, /* required */
  NetworkAclId: 'STRING_VALUE', /* required */
  RuleNumber: 'NUMBER_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteNetworkAclEntry(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • Egress — (Boolean)

      Indicates whether the rule is an egress rule.

    • NetworkAclId — (String)

      The ID of the network ACL.

    • RuleNumber — (Integer)

      The rule number of the entry to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteNetworkInsightsAccessScope(params = {}, callback) ⇒ AWS.Request

Deletes the specified Network Access Scope.

Service Reference:

Examples:

Calling the deleteNetworkInsightsAccessScope operation

var params = {
  NetworkInsightsAccessScopeId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteNetworkInsightsAccessScope(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • NetworkInsightsAccessScopeId — (String)

      The ID of the Network Access Scope.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsAccessScopeId — (String)

        The ID of the Network Access Scope.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteNetworkInsightsAccessScopeAnalysis(params = {}, callback) ⇒ AWS.Request

Deletes the specified Network Access Scope analysis.

Service Reference:

Examples:

Calling the deleteNetworkInsightsAccessScopeAnalysis operation

var params = {
  NetworkInsightsAccessScopeAnalysisId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteNetworkInsightsAccessScopeAnalysis(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInsightsAccessScopeAnalysisId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsAccessScopeAnalysisId — (String)

        The ID of the Network Access Scope analysis.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteNetworkInsightsAnalysis(params = {}, callback) ⇒ AWS.Request

Deletes the specified network insights analysis.

Service Reference:

Examples:

Calling the deleteNetworkInsightsAnalysis operation

var params = {
  NetworkInsightsAnalysisId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteNetworkInsightsAnalysis(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • NetworkInsightsAnalysisId — (String)

      The ID of the network insights analysis.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsAnalysisId — (String)

        The ID of the network insights analysis.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteNetworkInsightsPath(params = {}, callback) ⇒ AWS.Request

Deletes the specified path.

Service Reference:

Examples:

Calling the deleteNetworkInsightsPath operation

var params = {
  NetworkInsightsPathId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteNetworkInsightsPath(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the path.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsPathId — (String)

        The ID of the path.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteNetworkInterface(params = {}, callback) ⇒ AWS.Request

Deletes the specified network interface. You must detach the network interface before you can delete it.

Service Reference:

Examples:

To delete a network interface


/* This example deletes the specified network interface. */

 var params = {
  NetworkInterfaceId: "eni-e5aa89a3"
 };
 ec2.deleteNetworkInterface(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteNetworkInterface operation

var params = {
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteNetworkInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteNetworkInterfacePermission(params = {}, callback) ⇒ AWS.Request

Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.

Service Reference:

Examples:

Calling the deleteNetworkInterfacePermission operation

var params = {
  NetworkInterfacePermissionId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Force: true || false
};
ec2.deleteNetworkInterfacePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInterfacePermissionId — (String)

      The ID of the network interface permission.

    • Force — (Boolean)

      Specify true to remove the permission even if the network interface is attached to an 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds, otherwise returns an error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePlacementGroup(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To delete a placement group


/* This example deletes the specified placement group.
*/

 var params = {
  GroupName: "my-cluster"
 };
 ec2.deletePlacementGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deletePlacementGroup operation

var params = {
  GroupName: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deletePlacementGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The name of the placement group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePublicIpv4Pool(params = {}, callback) ⇒ AWS.Request

Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.

Service Reference:

Examples:

Calling the deletePublicIpv4Pool operation

var params = {
  PoolId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  NetworkBorderGroup: 'STRING_VALUE'
};
ec2.deletePublicIpv4Pool(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • PoolId — (String)

      The ID of the public IPv4 pool you want to delete.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReturnValue — (Boolean)

        Information about the result of deleting the public IPv4 pool.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteQueuedReservedInstances(params = {}, callback) ⇒ AWS.Request

Deletes the queued purchases for the specified Reserved Instances.

Service Reference:

Examples:

Calling the deleteQueuedReservedInstances operation

var params = {
  ReservedInstancesIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.deleteQueuedReservedInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • ReservedInstancesIds — (Array<String>)

      The IDs of the Reserved Instances.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SuccessfulQueuedPurchaseDeletions — (Array<map>)

        Information about the queued purchases that were successfully deleted.

        • ReservedInstancesId — (String)

          The ID of the Reserved Instance.

      • FailedQueuedPurchaseDeletions — (Array<map>)

        Information about the queued purchases that could not be deleted.

        • Error — (map)

          The error.

          • Code — (String)

            The error code.

            Possible values include:
            • "reserved-instances-id-invalid"
            • "reserved-instances-not-in-queued-state"
            • "unexpected-error"
          • Message — (String)

            The error message.

        • ReservedInstancesId — (String)

          The ID of the Reserved Instance.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteRoute(params = {}, callback) ⇒ AWS.Request

Deletes the specified route from the specified route table.

Service Reference:

Examples:

To delete a route


/* This example deletes the specified route from the specified route table. */

 var params = {
  DestinationCidrBlock: "0.0.0.0/0", 
  RouteTableId: "rtb-22574640"
 };
 ec2.deleteRoute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteRoute operation

var params = {
  RouteTableId: 'STRING_VALUE', /* required */
  DestinationCidrBlock: 'STRING_VALUE',
  DestinationIpv6CidrBlock: 'STRING_VALUE',
  DestinationPrefixListId: 'STRING_VALUE',
  DryRun: true || false
};
ec2.deleteRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DestinationCidrBlock — (String)

      The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

    • DestinationIpv6CidrBlock — (String)

      The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

    • 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.

    • RouteTableId — (String)

      The ID of the route table.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteRouteTable(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To delete a route table


/* This example deletes the specified route table. */

 var params = {
  RouteTableId: "rtb-22574640"
 };
 ec2.deleteRouteTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteRouteTable operation

var params = {
  RouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the route table.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSecurityGroup(params = {}, callback) ⇒ AWS.Request

Deletes a security group.

If you attempt to delete a security group that is associated with an instance or network interface or is referenced by another security group in the same VPC, the operation fails with DependencyViolation.

Service Reference:

Examples:

To delete a security group


/* This example deletes the specified security group. */

 var params = {
  GroupId: "sg-903004f8"
 };
 ec2.deleteSecurityGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteSecurityGroup operation

var params = {
  DryRun: true || false,
  GroupId: 'STRING_VALUE',
  GroupName: 'STRING_VALUE'
};
ec2.deleteSecurityGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GroupId — (String)

      The ID of the security group.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSnapshot(params = {}, callback) ⇒ AWS.Request

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Delete an Amazon EBS snapshot in the Amazon EBS User Guide.

Service Reference:

Examples:

To delete a snapshot


/* This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned. */

 var params = {
  SnapshotId: "snap-1234567890abcdef0"
 };
 ec2.deleteSnapshot(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteSnapshot operation

var params = {
  SnapshotId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSpotDatafeedSubscription(params = {}, callback) ⇒ AWS.Request

Deletes the data feed for Spot Instances.

Service Reference:

Examples:

To cancel a Spot Instance data feed subscription


/* This example deletes a Spot data feed subscription for the account. */

 var params = {
 };
 ec2.deleteSpotDatafeedSubscription(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteSpotDatafeedSubscription operation

var params = {
  DryRun: true || false
};
ec2.deleteSpotDatafeedSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSubnet(params = {}, callback) ⇒ AWS.Request

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

Service Reference:

Examples:

To delete a subnet


/* This example deletes the specified subnet. */

 var params = {
  SubnetId: "subnet-9d4a7b6c"
 };
 ec2.deleteSubnet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteSubnet operation

var params = {
  SubnetId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteSubnet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubnetId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSubnetCidrReservation(params = {}, callback) ⇒ AWS.Request

Deletes a subnet CIDR reservation.

Service Reference:

Examples:

Calling the deleteSubnetCidrReservation operation

var params = {
  SubnetCidrReservationId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteSubnetCidrReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubnetCidrReservationId — (String)

      The ID of the subnet CIDR reservation.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeletedSubnetCidrReservation — (map)

        Information about the deleted 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.

          Possible values include:
          • "prefix"
          • "explicit"
        • OwnerId — (String)

          The ID of the account that owns the subnet CIDR reservation.

        • Description — (String)

          The description assigned to the subnet CIDR reservation.

        • Tags — (Array<map>)

          The tags assigned to the subnet CIDR reservation.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTags(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To delete a tag from a resource


/* This example deletes the tag Stack=test from the specified image. */

 var params = {
  Resources: [
     "ami-78a54011"
  ], 
  Tags: [
     {
    Key: "Stack", 
    Value: "test"
   }
  ]
 };
 ec2.deleteTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteTags operation

var params = {
  Resources: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ec2.deleteTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the resources, separated by spaces.

      Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

    • Tags — (Array<map>)

      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.

      • Key — (String)

        The key of the tag.

        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

      • Value — (String)

        The value of the tag.

        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTrafficMirrorFilter(params = {}, callback) ⇒ AWS.Request

Deletes the specified Traffic Mirror filter.

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

Service Reference:

Examples:

Calling the deleteTrafficMirrorFilter operation

var params = {
  TrafficMirrorFilterId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTrafficMirrorFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TrafficMirrorFilterId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficMirrorFilterId — (String)

        The ID of the Traffic Mirror filter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTrafficMirrorFilterRule(params = {}, callback) ⇒ AWS.Request

Deletes the specified Traffic Mirror rule.

Service Reference:

Examples:

Calling the deleteTrafficMirrorFilterRule operation

var params = {
  TrafficMirrorFilterRuleId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTrafficMirrorFilterRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TrafficMirrorFilterRuleId — (String)

      The ID 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficMirrorFilterRuleId — (String)

        The ID of the deleted Traffic Mirror rule.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTrafficMirrorSession(params = {}, callback) ⇒ AWS.Request

Deletes the specified Traffic Mirror session.

Service Reference:

Examples:

Calling the deleteTrafficMirrorSession operation

var params = {
  TrafficMirrorSessionId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTrafficMirrorSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TrafficMirrorSessionId — (String)

      The ID of the Traffic Mirror session.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficMirrorSessionId — (String)

        The ID of the deleted Traffic Mirror session.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTrafficMirrorTarget(params = {}, callback) ⇒ AWS.Request

Deletes the specified Traffic Mirror target.

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

Service Reference:

Examples:

Calling the deleteTrafficMirrorTarget operation

var params = {
  TrafficMirrorTargetId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTrafficMirrorTarget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TrafficMirrorTargetId — (String)

      The ID of the Traffic Mirror target.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficMirrorTargetId — (String)

        The ID of the deleted Traffic Mirror target.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGateway(params = {}, callback) ⇒ AWS.Request

Deletes the specified transit gateway.

Service Reference:

Examples:

Calling the deleteTransitGateway operation

var params = {
  TransitGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayId — (String)

      The ID of 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGateway — (map)

        Information about the deleted 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.

          Possible values include:
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the transit gateway.

        • Description — (String)

          The description of the transit gateway.

        • CreationTime — (Date)

          The creation time.

        • Options — (map)

          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 — (Array<String>)

            The transit gateway CIDR blocks.

          • AutoAcceptSharedAttachments — (String)

            Indicates whether attachment requests are automatically accepted.

            Possible values include:
            • "enable"
            • "disable"
          • DefaultRouteTableAssociation — (String)

            Indicates whether resource attachments are automatically associated with the default association route table.

            Possible values include:
            • "enable"
            • "disable"
          • 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.

            Possible values include:
            • "enable"
            • "disable"
          • PropagationDefaultRouteTableId — (String)

            The ID of the default propagation route table.

          • VpnEcmpSupport — (String)

            Indicates whether Equal Cost Multipath Protocol support is enabled.

            Possible values include:
            • "enable"
            • "disable"
          • DnsSupport — (String)

            Indicates whether DNS support is enabled.

            Possible values include:
            • "enable"
            • "disable"
          • SecurityGroupReferencingSupport — (String)
            Note: This parameter is in preview and may not be available for your account.

            Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

            Possible values include:
            • "enable"
            • "disable"
          • MulticastSupport — (String)

            Indicates whether multicast is enabled on the transit gateway

            Possible values include:
            • "enable"
            • "disable"
        • Tags — (Array<map>)

          The tags for the transit gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayConnect(params = {}, callback) ⇒ AWS.Request

Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.

Service Reference:

Examples:

Calling the deleteTransitGatewayConnect operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayConnect(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayAttachmentId — (String)

      The ID of the Connect 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayConnect — (map)

        Information about the deleted 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.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • CreationTime — (Date)

          The creation time.

        • Options — (map)

          The Connect attachment options.

          • Protocol — (String)

            The tunnel protocol.

            Possible values include:
            • "gre"
        • Tags — (Array<map>)

          The tags for the attachment.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayConnectPeer(params = {}, callback) ⇒ AWS.Request

Deletes the specified Connect peer.

Service Reference:

Examples:

Calling the deleteTransitGatewayConnectPeer operation

var params = {
  TransitGatewayConnectPeerId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayConnectPeer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayConnectPeerId — (String)

      The ID of the Connect peer.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayConnectPeer — (map)

        Information about the deleted 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.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • CreationTime — (Date)

          The creation time.

        • ConnectPeerConfiguration — (map)

          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 — (Array<String>)

            The range of interior BGP peer IP addresses.

          • Protocol — (String)

            The tunnel protocol.

            Possible values include:
            • "gre"
          • BgpConfigurations — (Array<map>)

            The BGP configuration details.

            • 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.

              Possible values include:
              • "up"
              • "down"
        • Tags — (Array<map>)

          The tags for the Connect peer.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayMulticastDomain(params = {}, callback) ⇒ AWS.Request

Deletes the specified transit gateway multicast domain.

Service Reference:

Examples:

Calling the deleteTransitGatewayMulticastDomain operation

var params = {
  TransitGatewayMulticastDomainId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayMulticastDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayMulticastDomainId — (String)

      The ID of the transit gateway multicast domain.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayMulticastDomain — (map)

        Information about the deleted 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 — (map)

          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.

            Possible values include:
            • "enable"
            • "disable"
          • StaticSourcesSupport — (String)

            Indicates whether support for statically configuring transit gateway multicast group sources is turned on.

            Possible values include:
            • "enable"
            • "disable"
          • AutoAcceptSharedAssociations — (String)

            Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.

            Possible values include:
            • "enable"
            • "disable"
        • State — (String)

          The state of the transit gateway multicast domain.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • CreationTime — (Date)

          The time the transit gateway multicast domain was created.

        • Tags — (Array<map>)

          The tags for the transit gateway multicast domain.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayPeeringAttachment(params = {}, callback) ⇒ AWS.Request

Deletes a transit gateway peering attachment.

Service Reference:

Examples:

Calling the deleteTransitGatewayPeeringAttachment operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayPeeringAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayAttachmentId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayPeeringAttachment — (map)

        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 — (map)

          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 — (map)

          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 — (map)

          Details about the transit gateway peering attachment.

          • DynamicRouting — (String)

            Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.

            Possible values include:
            • "enable"
            • "disable"
        • Status — (map)

          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.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • CreationTime — (Date)

          The time the transit gateway peering attachment was created.

        • Tags — (Array<map>)

          The tags for the transit gateway peering attachment.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayPolicyTable(params = {}, callback) ⇒ AWS.Request

Deletes the specified transit gateway policy table.

Service Reference:

Examples:

Calling the deleteTransitGatewayPolicyTable operation

var params = {
  TransitGatewayPolicyTableId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayPolicyTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayPolicyTableId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayPolicyTable — (map)

        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

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • CreationTime — (Date)

          The timestamp when the transit gateway policy table was created.

        • Tags — (Array<map>)

          he key-value pairs associated with the transit gateway policy table.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayPrefixListReference(params = {}, callback) ⇒ AWS.Request

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

Service Reference:

Examples:

Calling the deleteTransitGatewayPrefixListReference operation

var params = {
  PrefixListId: 'STRING_VALUE', /* required */
  TransitGatewayRouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayPrefixListReference(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayRouteTableId — (String)

      The ID of the route table.

    • PrefixListId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayPrefixListReference — (map)

        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.

          Possible values include:
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
        • Blackhole — (Boolean)

          Indicates whether traffic that matches this route is dropped.

        • TransitGatewayAttachment — (map)

          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.

            Possible values include:
            • "vpc"
            • "vpn"
            • "direct-connect-gateway"
            • "connect"
            • "peering"
            • "tgw-peering"
          • ResourceId — (String)

            The ID of the resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayRoute(params = {}, callback) ⇒ AWS.Request

Deletes the specified route from the specified transit gateway route table.

Service Reference:

Examples:

Calling the deleteTransitGatewayRoute operation

var params = {
  DestinationCidrBlock: 'STRING_VALUE', /* required */
  TransitGatewayRouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayRouteTableId — (String)

      The ID of the transit gateway route table.

    • DestinationCidrBlock — (String)

      The CIDR range for the route. This must match the CIDR for the route exactly.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Route — (map)

        Information about the 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 — (Array<map>)

          The attachments.

          • 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.

            Possible values include:
            • "vpc"
            • "vpn"
            • "direct-connect-gateway"
            • "connect"
            • "peering"
            • "tgw-peering"
        • Type — (String)

          The route type.

          Possible values include:
          • "static"
          • "propagated"
        • State — (String)

          The state of the route.

          Possible values include:
          • "pending"
          • "active"
          • "blackhole"
          • "deleting"
          • "deleted"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayRouteTable(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteTransitGatewayRouteTable operation

var params = {
  TransitGatewayRouteTableId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayRouteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayRouteTableId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayRouteTable — (map)

        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.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • 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 — (Date)

          The creation time.

        • Tags — (Array<map>)

          Any tags assigned to the route table.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayRouteTableAnnouncement(params = {}, callback) ⇒ AWS.Request

Advertises to the transit gateway that a transit gateway route table is deleted.

Service Reference:

Examples:

Calling the deleteTransitGatewayRouteTableAnnouncement operation

var params = {
  TransitGatewayRouteTableAnnouncementId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayRouteTableAnnouncement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayRouteTableAnnouncementId — (String)

      The transit gateway route table ID that's being 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayRouteTableAnnouncement — (map)

        Provides details about a deleted transit gateway route table.

        • 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.

          Possible values include:
          • "outgoing"
          • "incoming"
        • TransitGatewayRouteTableId — (String)

          The ID of the transit gateway route table.

        • State — (String)

          The state of the transit gateway announcement.

          Possible values include:
          • "available"
          • "pending"
          • "failing"
          • "failed"
          • "deleting"
          • "deleted"
        • CreationTime — (Date)

          The timestamp when the transit gateway route table announcement was created.

        • Tags — (Array<map>)

          The key-value pairs associated with the route table announcement.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTransitGatewayVpcAttachment(params = {}, callback) ⇒ AWS.Request

Deletes the specified VPC attachment.

Service Reference:

Examples:

Calling the deleteTransitGatewayVpcAttachment operation

var params = {
  TransitGatewayAttachmentId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteTransitGatewayVpcAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayVpcAttachment — (map)

        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.

          Possible values include:
          • "initiating"
          • "initiatingRequest"
          • "pendingAcceptance"
          • "rollingBack"
          • "pending"
          • "available"
          • "modifying"
          • "deleting"
          • "deleted"
          • "failed"
          • "rejected"
          • "rejecting"
          • "failing"
        • SubnetIds — (Array<String>)

          The IDs of the subnets.

        • CreationTime — (Date)

          The creation time.

        • Options — (map)

          The VPC attachment options.

          • DnsSupport — (String)

            Indicates whether DNS support is enabled.

            Possible values include:
            • "enable"
            • "disable"
          • SecurityGroupReferencingSupport — (String)
            Note: This parameter is in preview and may not be available for your account.

            Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

            Possible values include:
            • "enable"
            • "disable"
          • Ipv6Support — (String)

            Indicates whether IPv6 support is disabled.

            Possible values include:
            • "enable"
            • "disable"
          • ApplianceModeSupport — (String)

            Indicates whether appliance mode support is enabled.

            Possible values include:
            • "enable"
            • "disable"
        • Tags — (Array<map>)

          The tags for the VPC attachment.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVerifiedAccessEndpoint(params = {}, callback) ⇒ AWS.Request

Delete an Amazon Web Services Verified Access endpoint.

Service Reference:

Examples:

Calling the deleteVerifiedAccessEndpoint operation

var params = {
  VerifiedAccessEndpointId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false
};
ec2.deleteVerifiedAccessEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VerifiedAccessEndpointId — (String)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedAccessEndpoint — (map)

        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.

          Possible values include:
          • "load-balancer"
          • "network-interface"
        • AttachmentType — (String)

          The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application.

          Possible values include:
          • "vpc"
        • 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 — (Array<String>)

          The IDs of the security groups for the endpoint.

        • LoadBalancerOptions — (map)

          The load balancer details if creating the Amazon Web Services Verified Access endpoint as load-balancertype.

          • Protocol — (String)

            The IP protocol.

            Possible values include:
            • "http"
            • "https"
          • Port — (Integer)

            The IP port number.

          • LoadBalancerArn — (String)

            The ARN of the load balancer.

          • SubnetIds — (Array<String>)

            The IDs of the subnets.

        • NetworkInterfaceOptions — (map)

          The options for network-interface type endpoint.

          • NetworkInterfaceId — (String)

            The ID of the network interface.

          • Protocol — (String)

            The IP protocol.

            Possible values include:
            • "http"
            • "https"
          • Port — (Integer)

            The IP port number.

        • Status — (map)

          The endpoint status.

          • Code — (String)

            The status code of the Verified Access endpoint.

            Possible values include:
            • "pending"
            • "active"
            • "updating"
            • "deleting"
            • "deleted"
          • Message — (String)

            The status message of the Verified Access endpoint.

        • Description — (String)

          A description for the Amazon Web Services Verified Access endpoint.

        • CreationTime — (String)

          The creation time.

        • LastUpdatedTime — (String)

          The last updated time.

        • DeletionTime — (String)

          The deletion time.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVerifiedAccessGroup(params = {}, callback) ⇒ AWS.Request

Delete an Amazon Web Services Verified Access group.

Service Reference:

Examples:

Calling the deleteVerifiedAccessGroup operation

var params = {
  VerifiedAccessGroupId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false
};
ec2.deleteVerifiedAccessGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VerifiedAccessGroupId — (String)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedAccessGroup — (map)

        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 — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVerifiedAccessInstance(params = {}, callback) ⇒ AWS.Request

Delete an Amazon Web Services Verified Access instance.

Service Reference:

Examples:

Calling the deleteVerifiedAccessInstance operation

var params = {
  VerifiedAccessInstanceId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false
};
ec2.deleteVerifiedAccessInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VerifiedAccessInstanceId — (String)

      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.

    • ClientToken — (String)

      A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedAccessInstance — (map)

        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 — (Array<map>)

          The IDs of the Amazon Web Services Verified Access trust providers.

          • 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).

            Possible values include:
            • "user"
            • "device"
          • UserTrustProviderType — (String)

            The type of user-based trust provider.

            Possible values include:
            • "iam-identity-center"
            • "oidc"
          • DeviceTrustProviderType — (String)

            The type of device-based trust provider.

            Possible values include:
            • "jamf"
            • "crowdstrike"
            • "jumpcloud"
        • CreationTime — (String)

          The creation time.

        • LastUpdatedTime — (String)

          The last updated time.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVerifiedAccessTrustProvider(params = {}, callback) ⇒ AWS.Request

Delete an Amazon Web Services Verified Access trust provider.

Service Reference:

Examples:

Calling the deleteVerifiedAccessTrustProvider operation

var params = {
  VerifiedAccessTrustProviderId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false
};
ec2.deleteVerifiedAccessTrustProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VerifiedAccessTrustProviderId — (String)

      The ID of the Verified Access trust provider.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedAccessTrustProvider — (map)

        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.

          Possible values include:
          • "user"
          • "device"
        • UserTrustProviderType — (String)

          The type of user-based trust provider.

          Possible values include:
          • "iam-identity-center"
          • "oidc"
        • DeviceTrustProviderType — (String)

          The type of device-based trust provider.

          Possible values include:
          • "jamf"
          • "crowdstrike"
          • "jumpcloud"
        • OidcOptions — (map)

          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 — (map)

          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 — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVolume(params = {}, callback) ⇒ AWS.Request

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume can remain in the deleting state for several minutes.

For more information, see Delete an Amazon EBS volume in the Amazon EBS User Guide.

Service Reference:

Examples:

To delete a volume


/* This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned. */

 var params = {
  VolumeId: "vol-049df61146c4d7901"
 };
 ec2.deleteVolume(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteVolume operation

var params = {
  VolumeId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteVolume(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VolumeId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVpc(params = {}, callback) ⇒ AWS.Request

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 VPC's default security group, network ACL, and route table.

Service Reference:

Examples:

To delete a VPC


/* This example deletes the specified VPC. */

 var params = {
  VpcId: "vpc-a01106c2"
 };
 ec2.deleteVpc(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteVpc operation

var params = {
  VpcId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteVpc(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VpcId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVpcEndpointConnectionNotifications(params = {}, callback) ⇒ AWS.Request

Deletes the specified VPC endpoint connection notifications.

Service Reference:

Examples:

Calling the deleteVpcEndpointConnectionNotifications operation

var params = {
  ConnectionNotificationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.deleteVpcEndpointConnectionNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the notifications.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Unsuccessful — (Array<map>)

        Information about the notifications that could not be deleted successfully.

        • Error — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVpcEndpoints(params = {}, callback) ⇒ AWS.Request

Deletes the specified VPC endpoints.

When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint.

When you delete a Gateway Load Balancer endpoint, we delete its endpoint network interfaces. You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.

When you delete an interface endpoint, we delete its endpoint network interfaces.

Service Reference:

Examples:

Calling the deleteVpcEndpoints operation

var params = {
  VpcEndpointIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.deleteVpcEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the VPC endpoints.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Unsuccessful — (Array<map>)

        Information about the VPC endpoints that were not successfully deleted.

        • Error — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVpcEndpointServiceConfigurations(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteVpcEndpointServiceConfigurations operation

var params = {
  ServiceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.deleteVpcEndpointServiceConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the services.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Unsuccessful — (Array<map>)

        Information about the service configurations that were not deleted, if applicable.

        • Error — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteVpcPeeringConnection operation

var params = {
  VpcPeeringConnectionId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteVpcPeeringConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the VPC peering connection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Return — (Boolean)

        Returns true if the request succeeds; otherwise, it returns an error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVpnConnection(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteVpnConnection operation

var params = {
  VpnConnectionId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteVpnConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VpnConnectionId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVpnConnectionRoute(params = {}, callback) ⇒ AWS.Request

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

Service Reference:

Examples:

Calling the deleteVpnConnectionRoute operation

var params = {
  DestinationCidrBlock: 'STRING_VALUE', /* required */
  VpnConnectionId: 'STRING_VALUE' /* required */
};
ec2.deleteVpnConnectionRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DestinationCidrBlock — (String)

      The CIDR block associated with the local subnet of the customer network.

    • VpnConnectionId — (String)

      The ID of the VPN connection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVpnGateway(params = {}, callback) ⇒ AWS.Request

Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

Service Reference:

Examples:

Calling the deleteVpnGateway operation

var params = {
  VpnGatewayId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deleteVpnGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VpnGatewayId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deprovisionByoipCidr(params = {}, callback) ⇒ AWS.Request

Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.

Service Reference:

Examples:

Calling the deprovisionByoipCidr operation

var params = {
  Cidr: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deprovisionByoipCidr(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Cidr — (String)

      The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ByoipCidr — (map)

        Information about the address range.

        • Cidr — (String)

          The address range, in CIDR notation.

        • Description — (String)

          The description of the address range.

        • AsnAssociations — (Array<map>)

          The BYOIP CIDR associations with ASNs.

          • 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.

            Possible values include:
            • "disassociated"
            • "failed-disassociation"
            • "failed-association"
            • "pending-disassociation"
            • "pending-association"
            • "associated"
        • 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.

          Possible values include:
          • "advertised"
          • "deprovisioned"
          • "failed-deprovision"
          • "failed-provision"
          • "pending-deprovision"
          • "pending-provision"
          • "provisioned"
          • "provisioned-not-publicly-advertisable"
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deprovisionIpamByoasn(params = {}, callback) ⇒ AWS.Request

Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account. This action can only be called after any BYOIP CIDR associations are removed from your Amazon Web Services account with DisassociateIpamByoasn. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

Service Reference:

Examples:

Calling the deprovisionIpamByoasn operation

var params = {
  Asn: 'STRING_VALUE', /* required */
  IpamId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deprovisionIpamByoasn(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The IPAM ID.

    • Asn — (String)

      An ASN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Byoasn — (map)

        An 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.

          Possible values include:
          • "deprovisioned"
          • "failed-deprovision"
          • "failed-provision"
          • "pending-deprovision"
          • "pending-provision"
          • "provisioned"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deprovisionIpamPoolCidr(params = {}, callback) ⇒ AWS.Request

Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.

Service Reference:

Examples:

Calling the deprovisionIpamPoolCidr operation

var params = {
  IpamPoolId: 'STRING_VALUE', /* required */
  Cidr: 'STRING_VALUE',
  DryRun: true || false
};
ec2.deprovisionIpamPoolCidr(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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)

      The ID of the pool that has the CIDR you want to deprovision.

    • Cidr — (String)

      The CIDR which you want to deprovision from the pool.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamPoolCidr — (map)

        The deprovisioned pool CIDR.

        • 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.

          Possible values include:
          • "pending-provision"
          • "provisioned"
          • "failed-provision"
          • "pending-deprovision"
          • "deprovisioned"
          • "failed-deprovision"
          • "pending-import"
          • "failed-import"
        • FailureReason — (map)

          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.

            Possible values include:
            • "cidr-not-available"
            • "limit-exceeded"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deprovisionPublicIpv4PoolCidr(params = {}, callback) ⇒ AWS.Request

Deprovision a CIDR from a public IPv4 pool.

Service Reference:

Examples:

Calling the deprovisionPublicIpv4PoolCidr operation

var params = {
  Cidr: 'STRING_VALUE', /* required */
  PoolId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deprovisionPublicIpv4PoolCidr(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • PoolId — (String)

      The ID of the pool that you want to deprovision the CIDR from.

    • Cidr — (String)

      The CIDR you want to deprovision from the pool. Enter the CIDR you want to deprovision with a netmask of /32. You must rerun this command for each IP address in the CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of the 256 IP addresses in the /24 CIDR.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PoolId — (String)

        The ID of the pool that you deprovisioned the CIDR from.

      • DeprovisionedAddresses — (Array<String>)

        The deprovisioned CIDRs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deregisterImage(params = {}, callback) ⇒ AWS.Request

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon EC2 User Guide.

When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.

Service Reference:

Examples:

Calling the deregisterImage operation

var params = {
  ImageId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.deregisterImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ImageId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deregisterInstanceEventNotificationAttributes(params = {}, callback) ⇒ AWS.Request

Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.

Service Reference:

Examples:

Calling the deregisterInstanceEventNotificationAttributes operation

var params = {
  InstanceTagAttribute: { /* required */
    IncludeAllTagsOfInstance: true || false,
    InstanceTagKeys: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  DryRun: true || false
};
ec2.deregisterInstanceEventNotificationAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (map)

      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 — (Array<String>)

        Information about the tag keys to deregister.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceTagAttribute — (map)

        The resulting set of tag keys.

        • InstanceTagKeys — (Array<String>)

          The registered tag keys.

        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deregisterTransitGatewayMulticastGroupMembers(params = {}, callback) ⇒ AWS.Request

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

Service Reference:

Examples:

Calling the deregisterTransitGatewayMulticastGroupMembers operation

var params = {
  DryRun: true || false,
  GroupIpAddress: 'STRING_VALUE',
  NetworkInterfaceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  TransitGatewayMulticastDomainId: 'STRING_VALUE'
};
ec2.deregisterTransitGatewayMulticastGroupMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayMulticastDomainId — (String)

      The ID of the transit gateway multicast domain.

    • GroupIpAddress — (String)

      The IP address assigned to the transit gateway multicast group.

    • NetworkInterfaceIds — (Array<String>)

      The IDs of the group members' network interfaces.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeregisteredMulticastGroupMembers — (map)

        Information about the deregistered members.

        • TransitGatewayMulticastDomainId — (String)

          The ID of the transit gateway multicast domain.

        • DeregisteredNetworkInterfaceIds — (Array<String>)

          The network interface IDs of the deregistered members.

        • GroupIpAddress — (String)

          The IP address assigned to the transit gateway multicast group.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deregisterTransitGatewayMulticastGroupSources(params = {}, callback) ⇒ AWS.Request

Deregisters the specified sources (network interfaces) from the transit gateway multicast group.

Service Reference:

Examples:

Calling the deregisterTransitGatewayMulticastGroupSources operation

var params = {
  DryRun: true || false,
  GroupIpAddress: 'STRING_VALUE',
  NetworkInterfaceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  TransitGatewayMulticastDomainId: 'STRING_VALUE'
};
ec2.deregisterTransitGatewayMulticastGroupSources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransitGatewayMulticastDomainId — (String)

      The ID of the transit gateway multicast domain.

    • GroupIpAddress — (String)

      The IP address assigned to the transit gateway multicast group.

    • NetworkInterfaceIds — (Array<String>)

      The IDs of the group sources' network interfaces.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeregisteredMulticastGroupSources — (map)

        Information about the deregistered group sources.

        • TransitGatewayMulticastDomainId — (String)

          The ID of the transit gateway multicast domain.

        • DeregisteredNetworkInterfaceIds — (Array<String>)

          The network interface IDs of the non-registered members.

        • GroupIpAddress — (String)

          The IP address assigned to the transit gateway multicast group.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAccountAttributes(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe a single attribute for your AWS account


/* This example describes the supported-platforms attribute for your AWS account. */

 var params = {
  AttributeNames: [
     "supported-platforms"
  ]
 };
 ec2.describeAccountAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AccountAttributes: [
       {
      AttributeName: "supported-platforms", 
      AttributeValues: [
         {
        AttributeValue: "EC2"
       }, 
         {
        AttributeValue: "VPC"
       }
      ]
     }
    ]
   }
   */
 });

To describe all attributes for your AWS account


/* This example describes the attributes for your AWS account. */

 var params = {
 };
 ec2.describeAccountAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
       }
      ]
     }
    ]
   }
   */
 });

Calling the describeAccountAttributes operation

var params = {
  AttributeNames: [
    supported-platforms | default-vpc,
    /* more items */
  ],
  DryRun: true || false
};
ec2.describeAccountAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AttributeNames — (Array<String>)

      The account attribute names.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountAttributes — (Array<map>)

        Information about the account attributes.

        • AttributeName — (String)

          The name of the account attribute.

        • AttributeValues — (Array<map>)

          The values for the account attribute.

          • AttributeValue — (String)

            The value of the attribute.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAddresses(params = {}, callback) ⇒ AWS.Request

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

Service Reference:

Examples:

To describe your Elastic IP addresses


/* This example describes your Elastic IP addresses. */

 var params = {
 };
 ec2.describeAddresses(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
     }
    ]
   }
   */
 });

Calling the describeAddresses operation

var params = {
  AllocationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  PublicIps: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeAddresses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • PublicIps — (Array<String>)

      One or more Elastic IP addresses.

      Default: Describes all your Elastic IP addresses.

    • AllocationIds — (Array<String>)

      Information about the allocation IDs.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Addresses — (Array<map>)

        Information about the Elastic IP addresses.

        • InstanceId — (String)

          The ID of the instance that the address is associated with (if any).

        • PublicIp — (String)

          The Elastic 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).

          Possible values include:
          • "vpc"
          • "standard"
        • 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 — (Array<map>)

          Any tags assigned to the Elastic IP address.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAddressesAttribute(params = {}, callback) ⇒ AWS.Request

Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.

Service Reference:

Examples:

Calling the describeAddressesAttribute operation

var params = {
  AllocationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Attribute: domain-name,
  DryRun: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeAddressesAttribute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AllocationIds — (Array<String>)

      [EC2-VPC] The allocation IDs.

    • Attribute — (String)

      The attribute of the IP address.

      Possible values include:
      • "domain-name"
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Addresses — (Array<map>)

        Information about the IP addresses.

        • PublicIp — (String)

          The public IP address.

        • AllocationId — (String)

          [EC2-VPC] The allocation ID.

        • PtrRecord — (String)

          The pointer (PTR) record for the IP address.

        • PtrRecordUpdate — (map)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAddressTransfers(params = {}, callback) ⇒ AWS.Request

Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.

When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, the transfer expires and ownership of the Elastic IP address returns to the source account. Accepted transfers are visible to the source account for 14 days after the transfers have been accepted.

Service Reference:

Examples:

Calling the describeAddressTransfers operation

var params = {
  AllocationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeAddressTransfers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AllocationIds — (Array<String>)

      The allocation IDs of Elastic IP addresses.

    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of address transfers to return in one 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AddressTransfers — (Array<map>)

        The 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 — (Date)

          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 — (Date)

          The timestamp when the Elastic IP address transfer was accepted.

        • AddressTransferStatus — (String)

          The Elastic IP address transfer status.

          Possible values include:
          • "pending"
          • "disabled"
          • "accepted"
      • NextToken — (String)

        Specify the pagination token from a previous request to retrieve the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAggregateIdFormat(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeAggregateIdFormat operation

var params = {
  DryRun: true || false
};
ec2.describeAggregateIdFormat(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Information about each resource's ID format.

        • Deadline — (Date)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAvailabilityZones(params = {}, callback) ⇒ AWS.Request

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.

For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions 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.

Service Reference:

Examples:

To describe your Availability Zones


/* This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region. */

 var params = {
 };
 ec2.describeAvailabilityZones(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
     }
    ]
   }
   */
 });

Calling the describeAvailabilityZones operation

var params = {
  AllAvailabilityZones: true || false,
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ZoneIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ZoneNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeAvailabilityZones(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      The filters.

      • group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).

      • 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).

      • 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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • ZoneNames — (Array<String>)

      The names of the Availability Zones, Local Zones, and Wavelength Zones.

    • ZoneIds — (Array<String>)

      The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AvailabilityZones — (Array<map>)

        Information about the Availability Zones, Local Zones, and Wavelength Zones.

        • State — (String)

          The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always available.

          Possible values include:
          • "available"
          • "information"
          • "impaired"
          • "unavailable"
          • "constrained"
        • 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.

          Possible values include:
          • "opt-in-not-required"
          • "opted-in"
          • "not-opted-in"
        • Messages — (Array<map>)

          Any messages about the 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)

          For Availability Zones, this parameter has the same value as the Region name.

          For Local Zones, the name of the associated group, for example us-west-2-lax-1.

          For Wavelength Zones, the name of the associated group, for example us-east-1-wl1-bos-wlz-1.

        • NetworkBorderGroup — (String)

          The name of the network border group.

        • ZoneType — (String)

          The type of zone. The valid values are availability-zone, local-zone, and 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAwsNetworkPerformanceMetricSubscriptions(params = {}, callback) ⇒ AWS.Request

Describes the current Infrastructure Performance metric subscriptions.

Service Reference:

Examples:

Calling the describeAwsNetworkPerformanceMetricSubscriptions operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeAwsNetworkPerformanceMetricSubscriptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 — (Array<map>)

      One or more filters.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

      • Subscriptions — (Array<map>)

        Describes the current Infrastructure Performance subscriptions.

        • Source — (String)

          The Region or Availability Zone that's the source for the subscription. For example, us-east-1.

        • Destination — (String)

          The Region or Availability Zone that's the target for the subscription. For example, eu-west-1.

        • Metric — (String)

          The metric used for the subscription.

          Possible values include:
          • "aggregate-latency"
        • Statistic — (String)

          The statistic used for the subscription.

          Possible values include:
          • "p50"
        • Period — (String)

          The data aggregation time for the subscription.

          Possible values include:
          • "five-minutes"
          • "fifteen-minutes"
          • "one-hour"
          • "three-hours"
          • "one-day"
          • "one-week"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeBundleTasks(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeBundleTasks operation

var params = {
  BundleIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.describeBundleTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BundleIds — (Array<String>)

      The bundle task IDs.

      Default: Describes all your bundle tasks.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BundleTasks — (Array<map>)

        Information about the bundle tasks.

        • BundleId — (String)

          The ID of the bundle task.

        • BundleTaskError — (map)

          If the task fails, a description of the error.

          • Code — (String)

            The error code.

          • Message — (String)

            The error message.

        • InstanceId — (String)

          The ID of the instance associated with this bundle task.

        • Progress — (String)

          The level of task completion, as a percent (for example, 20%).

        • StartTime — (Date)

          The time this task started.

        • State — (String)

          The state of the task.

          Possible values include:
          • "pending"
          • "waiting-for-shutdown"
          • "bundling"
          • "storing"
          • "cancelling"
          • "complete"
          • "failed"
        • Storage — (map)

          The Amazon S3 storage locations.

          • S3 — (map)

            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 — (Buffer, Typed Array, Blob, String)

              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.

        • UpdateTime — (Date)

          The time of the most recent update for the task.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeByoipCidrs(params = {}, callback) ⇒ AWS.Request

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

Service Reference:

Examples:

Calling the describeByoipCidrs operation

var params = {
  MaxResults: 'NUMBER_VALUE', /* required */
  DryRun: true || false,
  NextToken: 'STRING_VALUE'
};
ec2.describeByoipCidrs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ByoipCidrs — (Array<map>)

        Information about your address ranges.

        • Cidr — (String)

          The address range, in CIDR notation.

        • Description — (String)

          The description of the address range.

        • AsnAssociations — (Array<map>)

          The BYOIP CIDR associations with ASNs.

          • 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.

            Possible values include:
            • "disassociated"
            • "failed-disassociation"
            • "failed-association"
            • "pending-disassociation"
            • "pending-association"
            • "associated"
        • 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.

          Possible values include:
          • "advertised"
          • "deprovisioned"
          • "failed-deprovision"
          • "failed-provision"
          • "pending-deprovision"
          • "pending-provision"
          • "provisioned"
          • "provisioned-not-publicly-advertisable"
        • 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.
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeCapacityBlockOfferings(params = {}, callback) ⇒ AWS.Request

Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.

Service Reference:

Examples:

Calling the describeCapacityBlockOfferings operation

var params = {
  CapacityDurationHours: 'NUMBER_VALUE', /* required */
  InstanceCount: 'NUMBER_VALUE', /* required */
  InstanceType: 'STRING_VALUE', /* required */
  DryRun: true || false,
  EndDateRange: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartDateRange: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
ec2.describeCapacityBlockOfferings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

    • StartDateRange — (Date)

      The earliest start date for the Capacity Block offering.

    • EndDateRange — (Date)

      The latest end date for the Capacity Block offering.

    • CapacityDurationHours — (Integer)

      The number of hours for which to reserve Capacity Block.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CapacityBlockOfferings — (Array<map>)

        The recommended Capacity Block offering for the dates specified.

        • 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 — (Date)

          The start date of the Capacity Block offering.

        • EndDate — (Date)

          The end date of the Capacity Block offering.

        • CapacityBlockDurationHours — (Integer)

          The amount of time of the Capacity Block reservation in hours.

        • 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.

          Possible values include:
          • "default"
          • "dedicated"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeCapacityReservationFleets(params = {}, callback) ⇒ AWS.Request

Describes one or more Capacity Reservation Fleets.

Service Reference:

Examples:

Calling the describeCapacityReservationFleets operation

var params = {
  CapacityReservationFleetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeCapacityReservationFleets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CapacityReservationFleetIds — (Array<String>)

      The IDs of the Capacity Reservation Fleets to describe.

    • 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 — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CapacityReservationFleets — (Array<map>)

        Information about the Capacity Reservation Fleets.

        • 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.

          Possible values include:
          • "submitted"
          • "modifying"
          • "active"
          • "partially_fulfilled"
          • "expiring"
          • "expired"
          • "cancelling"
          • "cancelled"
          • "failed"
        • 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.

          Possible values include:
          • "default"
        • EndDate — (Date)

          The date and time at which the Capacity Reservation Fleet expires.

        • CreateTime — (Date)

          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.

          Possible values include:
          • "open"
        • 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 — (Array<map>)

          Information about the instance types for which to reserve the capacity.

          • 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.

            Possible values include:
            • "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"
          • InstancePlatform — (String)

            The type of operating system for which the Capacity Reservation reserves capacity.

            Possible values include:
            • "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)

            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 — (Date)

            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 — (Array<map>)

          The tags assigned to the Capacity Reservation Fleet.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeCapacityReservations(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeCapacityReservations operation

var params = {
  CapacityReservationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeCapacityReservations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CapacityReservationIds — (Array<String>)

      The ID of the Capacity Reservation.

    • 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 — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Information about the Capacity Reservations.

        • 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.

          Possible values include:
          • "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)

          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.

          Possible values include:
          • "default"
          • "dedicated"
        • 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 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.

          Possible values include:
          • "active"
          • "expired"
          • "cancelled"
          • "pending"
          • "failed"
          • "scheduled"
          • "payment-pending"
          • "payment-failed"
        • StartDate — (Date)

          The date and time at which the Capacity Reservation was started.

        • EndDate — (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.

        • 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.

          Possible values include:
          • "unlimited"
          • "limited"
        • 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.

          Possible values include:
          • "open"
          • "targeted"
        • CreateDate — (Date)

          The date and time at which the Capacity Reservation was created.

        • Tags — (Array<map>)

          Any tags assigned to the Capacity Reservation.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

          Information about instance capacity usage.

          • AllocationType — (String)

            The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.

            Possible values include:
            • "used"
          • 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.

          Possible values include:
          • "default"
          • "capacity-block"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeCarrierGateways(params = {}, callback) ⇒ AWS.Request

Describes one or more of your carrier gateways.

Service Reference:

Examples:

Calling the describeCarrierGateways operation

var params = {
  CarrierGatewayIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeCarrierGateways(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CarrierGatewayIds — (Array<String>)

      One or more carrier gateway IDs.

    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • vpc-id - The ID of the VPC associated with the carrier gateway.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CarrierGateways — (Array<map>)

        Information about the 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.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • OwnerId — (String)

          The Amazon Web Services account ID of the owner of the carrier gateway.

        • Tags — (Array<map>)

          The tags assigned to the carrier gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClassicLinkInstances(params = {}, callback) ⇒ AWS.Request

Note: This action is deprecated.

Describes your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.

Service Reference:

Examples:

Calling the describeClassicLinkInstances operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  InstanceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeClassicLinkInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • vpc-id - The ID of the VPC to which the instance is linked.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The instance IDs. Must be instances linked to a VPC through ClassicLink.

    • 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.

      Constraint: If the value is greater than 1000, we return only 1000 items.

    • NextToken — (String)

      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Instances — (Array<map>)

        Information about one or more linked EC2-Classic instances.

        • Groups — (Array<map>)

          The security groups.

          • GroupName — (String)

            The name of the security group.

          • GroupId — (String)

            The ID of the security group.

        • InstanceId — (String)

          The ID of the instance.

        • Tags — (Array<map>)

          Any tags assigned to the instance.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClientVpnAuthorizationRules(params = {}, callback) ⇒ AWS.Request

Describes the authorization rules for a specified Client VPN endpoint.

Service Reference:

Examples:

Calling the describeClientVpnAuthorizationRules operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeClientVpnAuthorizationRules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      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 — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuthorizationRules — (Array<map>)

        Information about the authorization rules.

        • 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 — (map)

          The current state of the authorization rule.

          • Code — (String)

            The state of the authorization rule.

            Possible values include:
            • "authorizing"
            • "active"
            • "failed"
            • "revoking"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClientVpnConnections(params = {}, callback) ⇒ AWS.Request

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

Service Reference:

Examples:

Calling the describeClientVpnConnections operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeClientVpnConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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 can be seen by sending another request with the 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Connections — (Array<map>)

        Information about the active and terminated client connections.

        • 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 — (map)

          The current state of the client connection.

          • Code — (String)

            The state of the client connection.

            Possible values include:
            • "active"
            • "failed-to-terminate"
            • "terminating"
            • "terminated"
          • 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 — (Array<String>)

          The statuses returned by the client connect handler for posture compliance, 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClientVpnEndpoints(params = {}, callback) ⇒ AWS.Request

Describes one or more Client VPN endpoints in the account.

Service Reference:

Examples:

Calling the describeClientVpnEndpoints operation

var params = {
  ClientVpnEndpointIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeClientVpnEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointIds — (Array<String>)

      The ID of the Client VPN endpoint.

    • 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.

    • NextToken — (String)

      The token to retrieve the next page of results.

    • Filters — (Array<map>)

      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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientVpnEndpoints — (Array<map>)

        Information about the Client VPN endpoints.

        • ClientVpnEndpointId — (String)

          The ID of the Client VPN endpoint.

        • Description — (String)

          A brief description of the endpoint.

        • Status — (map)

          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.

            Possible values include:
            • "pending-associate"
            • "available"
            • "deleting"
            • "deleted"
          • 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 — (Array<String>)

          Information about the DNS servers to be used for DNS resolution.

        • 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.

          Possible values include:
          • "openvpn"
        • TransportProtocol — (String)

          The transport protocol used by the Client VPN endpoint.

          Possible values include:
          • "tcp"
          • "udp"
        • VpnPort — (Integer)

          The port number for the Client VPN endpoint.

        • AssociatedTargetNetworks — (Array<map>)

          Information about the associated target networks. A target network is a subnet in a VPC.

          • NetworkId — (String)

            The ID of the subnet.

          • NetworkType — (String)

            The target network type.

            Possible values include:
            • "vpc"
        • ServerCertificateArn — (String)

          The ARN of the server certificate.

        • AuthenticationOptions — (Array<map>)

          Information about the authentication method used by the Client VPN endpoint.

          • Type — (String)

            The authentication type used.

            Possible values include:
            • "certificate-authentication"
            • "directory-service-authentication"
            • "federated-authentication"
          • ActiveDirectory — (map)

            Information about the Active Directory, if applicable.

            • DirectoryId — (String)

              The ID of the Active Directory used for authentication.

          • MutualAuthentication — (map)

            Information about the authentication certificates, if applicable.

            • ClientRootCertificateChain — (String)

              The ARN of the client certificate.

          • FederatedAuthentication — (map)

            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 — (map)

          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 — (Array<map>)

          Any tags assigned to the Client VPN endpoint.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<String>)

          The IDs of the security groups for the target network.

        • VpcId — (String)

          The ID of the VPC.

        • SelfServicePortalUrl — (String)

          The URL of the self-service portal.

        • ClientConnectOptions — (map)

          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 — (map)

            The status of any updates to the client connect options.

            • Code — (String)

              The status code.

              Possible values include:
              • "applying"
              • "applied"
            • 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 — (map)

          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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClientVpnRoutes(params = {}, callback) ⇒ AWS.Request

Describes the routes for the specified Client VPN endpoint.

Service Reference:

Examples:

Calling the describeClientVpnRoutes operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeClientVpnRoutes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

    • NextToken — (String)

      The token to retrieve 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Routes — (Array<map>)

        Information about the Client VPN endpoint routes.

        • 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 — (map)

          The current state of the route.

          • Code — (String)

            The state of the Client VPN endpoint route.

            Possible values include:
            • "creating"
            • "active"
            • "failed"
            • "deleting"
          • Message — (String)

            A message about the status of the Client VPN endpoint route, if applicable.

        • Description — (String)

          A brief description of the route.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClientVpnTargetNetworks(params = {}, callback) ⇒ AWS.Request

Describes the target networks associated with the specified Client VPN endpoint.

Service Reference:

Examples:

Calling the describeClientVpnTargetNetworks operation

var params = {
  ClientVpnEndpointId: 'STRING_VALUE', /* required */
  AssociationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeClientVpnTargetNetworks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientVpnEndpointId — (String)

      The ID of the Client VPN endpoint.

    • AssociationIds — (Array<String>)

      The IDs of the target network associations.

    • 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.

    • NextToken — (String)

      The token to retrieve the next page of results.

    • Filters — (Array<map>)

      One or more filters. Filter names and values are case-sensitive.

      • association-id - The ID of the association.

      • target-network-id - The ID of the subnet specified as the target network.

      • vpc-id - The ID of the VPC in which the target network is located.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientVpnTargetNetworks — (Array<map>)

        Information about the associated target networks.

        • AssociationId — (String)

          The ID of the association.

        • VpcId — (String)

          The ID of the VPC in which the target network (subnet) is located.

        • TargetNetworkId — (String)

          The ID of the subnet specified as the target network.

        • ClientVpnEndpointId — (String)

          The ID of the Client VPN endpoint with which the target network is associated.

        • Status — (map)

          The current state of the target network association.

          • Code — (String)

            The state of the target network association.

            Possible values include:
            • "associating"
            • "associated"
            • "association-failed"
            • "disassociating"
            • "disassociated"
          • Message — (String)

            A message about the status of the target network association, if applicable.

        • SecurityGroups — (Array<String>)

          The IDs of the security groups applied to the target network 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeCoipPools(params = {}, callback) ⇒ AWS.Request

Describes the specified customer-owned address pools or all of your customer-owned address pools.

Service Reference:

Examples:

Calling the describeCoipPools operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PoolIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeCoipPools(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PoolIds — (Array<String>)

      The IDs of the address pools.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CoipPools — (Array<map>)

        Information about the address pools.

        • PoolId — (String)

          The ID of the address pool.

        • PoolCidrs — (Array<String>)

          The address ranges of the address pool.

        • LocalGatewayRouteTableId — (String)

          The ID of the local gateway route table.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConversionTasks(params = {}, callback) ⇒ AWS.Request

Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

Service Reference:

Examples:

Calling the describeConversionTasks operation

var params = {
  ConversionTaskIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.describeConversionTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConversionTaskIds — (Array<String>)

      The conversion task IDs.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConversionTasks — (Array<map>)

        Information about the conversion tasks.

        • 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 — (map)

          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.

            Possible values include:
            • "Windows"
          • Volumes — (Array<map>)

            The volumes.

            • 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 — (map)

              The image.

              • Checksum — (String)

                The checksum computed for the disk image.

              • Format — (String)

                The disk image format.

                Possible values include:
                • "VMDK"
                • "RAW"
                • "VHD"
              • 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 — (map)

              The volume.

              • Id — (String)

                The volume identifier.

              • Size — (Integer)

                The size of the volume, in GiB.

        • ImportVolume — (map)

          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 — (map)

            The image.

            • Checksum — (String)

              The checksum computed for the disk image.

            • Format — (String)

              The disk image format.

              Possible values include:
              • "VMDK"
              • "RAW"
              • "VHD"
            • 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 — (map)

            The volume.

            • Id — (String)

              The volume identifier.

            • Size — (Integer)

              The size of the volume, in GiB.

        • State — (String)

          The state of the conversion task.

          Possible values include:
          • "active"
          • "cancelling"
          • "cancelled"
          • "completed"
        • StatusMessage — (String)

          The status message related to the conversion task.

        • Tags — (Array<map>)

          Any tags assigned to the task.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeCustomerGateways(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe a customer gateway


/* This example describes the specified customer gateway. */

 var params = {
  CustomerGatewayIds: [
     "cgw-0e11f167"
  ]
 };
 ec2.describeCustomerGateways(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomerGateways: [
       {
      BgpAsn: "65534", 
      CustomerGatewayId: "cgw-0e11f167", 
      IpAddress: "12.1.2.3", 
      State: "available", 
      Type: "ipsec.1"
     }
    ]
   }
   */
 });

Calling the describeCustomerGateways operation

var params = {
  CustomerGatewayIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.describeCustomerGateways(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CustomerGatewayIds — (Array<String>)

      One or more customer gateway IDs.

      Default: Describes all your customer gateways.

    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CustomerGateways — (Array<map>)

        Information about one or more customer gateways.

        • BgpAsn — (String)

          The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

          Valid values: 1 to 2,147,483,647

        • CustomerGatewayId — (String)

          The ID of the customer gateway.

        • IpAddress — (String)

          IPv4 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.

        • CertificateArn — (String)

          The Amazon Resource Name (ARN) for the customer gateway certificate.

        • 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).

        • DeviceName — (String)

          The name of customer gateway device.

        • Tags — (Array<map>)

          Any tags assigned to the customer gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeDhcpOptions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe a DHCP options set


/* This example describes the specified DHCP options set. */

 var params = {
  DhcpOptionsIds: [
     "dopt-d9070ebb"
  ]
 };
 ec2.describeDhcpOptions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DhcpOptions: [
       {
      DhcpConfigurations: [
         {
        Key: "domain-name-servers", 
        Values: [
           {
          Value: "10.2.5.2"
         }, 
           {
          Value: "10.2.5.1"
         }
        ]
       }
      ], 
      DhcpOptionsId: "dopt-d9070ebb"
     }
    ]
   }
   */
 });

Calling the describeDhcpOptions operation

var params = {
  DhcpOptionsIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeDhcpOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DhcpOptionsIds — (Array<String>)

      The IDs of DHCP option sets.

    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DhcpOptions — (Array<map>)

        Information about the DHCP options sets.

        • DhcpConfigurations — (Array<map>)

          The DHCP options in the set.

          • Key — (String)

            The name of a DHCP option.

          • Values — (Array<map>)

            The values for the DHCP option.

            • Value — (String)

              The attribute value. The value is case-sensitive.

        • DhcpOptionsId — (String)

          The ID of the set of DHCP options.

        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the DHCP options set.

        • Tags — (Array<map>)

          Any tags assigned to the DHCP options set.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 include in another request to get the next page of items. This value is null when there are no more items to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEgressOnlyInternetGateways(params = {}, callback) ⇒ AWS.Request

Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.

Service Reference:

Examples:

Calling the describeEgressOnlyInternetGateways operation

var params = {
  DryRun: true || false,
  EgressOnlyInternetGatewayIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeEgressOnlyInternetGateways(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • EgressOnlyInternetGatewayIds — (Array<String>)

      The IDs of the egress-only internet gateways.

    • 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.

    • Filters — (Array<map>)

      The filters.

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EgressOnlyInternetGateways — (Array<map>)

        Information about the egress-only internet gateways.

        • Attachments — (Array<map>)

          Information about the attachment of the 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.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • VpcId — (String)

            The ID of the VPC.

        • EgressOnlyInternetGatewayId — (String)

          The ID of the egress-only internet gateway.

        • Tags — (Array<map>)

          The tags assigned to the egress-only internet gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 include in another request to get the next page of items. This value is null when there are no more items to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeElasticGpus(params = {}, callback) ⇒ AWS.Request

Note: Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4, G5, or G6 instances.

Describes the Elastic Graphics accelerator associated with your instances.

Service Reference:

Examples:

Calling the describeElasticGpus operation

var params = {
  DryRun: true || false,
  ElasticGpuIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeElasticGpus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ElasticGpuIds — (Array<String>)

      The Elastic Graphics accelerator IDs.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ElasticGpuSet — (Array<map>)

        Information about the Elastic Graphics accelerators.

        • 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 — (map)

          The status of the Elastic Graphics accelerator.

          • Status — (String)

            The health status.

            Possible values include:
            • "OK"
            • "IMPAIRED"
        • ElasticGpuState — (String)

          The state of the Elastic Graphics accelerator.

          Possible values include:
          • "ATTACHED"
        • InstanceId — (String)

          The ID of the instance to which the Elastic Graphics accelerator is attached.

        • Tags — (Array<map>)

          The tags assigned to the Elastic Graphics accelerator.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeExportImageTasks(params = {}, callback) ⇒ AWS.Request

Describes the specified export image tasks or all of your export image tasks.

Service Reference:

Examples:

Calling the describeExportImageTasks operation

var params = {
  DryRun: true || false,
  ExportImageTaskIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeExportImageTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • ExportImageTaskIds — (Array<String>)

      The IDs of the export image tasks.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

    • NextToken — (String)

      A token that indicates the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExportImageTasks — (Array<map>)

        Information about the export image tasks.

        • 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 — (map)

          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 — (Array<map>)

          Any tags assigned to the export image task.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeExportTasks(params = {}, callback) ⇒ AWS.Request

Describes the specified export instance tasks or all of your export instance tasks.

Service Reference:

Examples:

Calling the describeExportTasks operation

var params = {
  ExportTaskIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
ec2.describeExportTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ExportTaskIds — (Array<String>)

      The export task IDs.

    • Filters — (Array<map>)

      the filters for the export tasks.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExportTasks — (Array<map>)

        Information about the export tasks.

        • Description — (String)

          A description of the resource being exported.

        • ExportTaskId — (String)

          The ID of the export task.

        • ExportToS3Task — (map)

          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.

            Possible values include:
            • "ova"
          • DiskImageFormat — (String)

            The format for the exported image.

            Possible values include:
            • "VMDK"
            • "RAW"
            • "VHD"
          • 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 — (map)

          Information about the instance to export.

          • InstanceId — (String)

            The ID of the resource being exported.

          • TargetEnvironment — (String)

            The target virtualization environment.

            Possible values include:
            • "citrix"
            • "vmware"
            • "microsoft"
        • State — (String)

          The state of the export task.

          Possible values include:
          • "active"
          • "cancelling"
          • "cancelled"
          • "completed"
        • StatusMessage — (String)

          The status message related to the export task.

        • Tags — (Array<map>)

          The tags for the export task.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeFastLaunchImages(params = {}, callback) ⇒ AWS.Request

Describe details for Windows AMIs that are configured for Windows fast launch.

Service Reference:

Examples:

Calling the describeFastLaunchImages operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ImageIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeFastLaunchImages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ImageIds — (Array<String>)

      Specify one or more Windows AMI image IDs for the request.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FastLaunchImages — (Array<map>)

        A collection of details about the fast-launch enabled Windows images that meet the requested criteria.

        • 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.

          Possible values include:
          • "snapshot"
        • SnapshotConfiguration — (map)

          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 — (map)

          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.

          Possible values include:
          • "enabling"
          • "enabling-failed"
          • "enabled"
          • "enabled-failed"
          • "disabling"
          • "disabling-failed"
        • StateTransitionReason — (String)

          The reason that Windows fast launch for the AMI changed to the current state.

        • StateTransitionTime — (Date)

          The time that Windows fast launch for the AMI changed to the current 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFastSnapshotRestores(params = {}, callback) ⇒ AWS.Request

Describes the state of fast snapshot restores for your snapshots.

Service Reference:

Examples:

Calling the describeFastSnapshotRestores operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeFastSnapshotRestores(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FastSnapshotRestores — (Array<map>)

        Information about the state of fast snapshot restores.

        • SnapshotId — (String)

          The ID of the snapshot.

        • AvailabilityZone — (String)

          The Availability Zone.

        • State — (String)

          The state of fast snapshot restores.

          Possible values include:
          • "enabling"
          • "optimizing"
          • "enabled"
          • "disabling"
          • "disabled"
        • 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 — (Date)

          The time at which fast snapshot restores entered the enabling state.

        • OptimizingTime — (Date)

          The time at which fast snapshot restores entered the optimizing state.

        • EnabledTime — (Date)

          The time at which fast snapshot restores entered the enabled state.

        • DisablingTime — (Date)

          The time at which fast snapshot restores entered the disabling state.

        • DisabledTime — (Date)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFleetHistory(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeFleetHistory operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  DryRun: true || false,
  EventType: instance-change | fleet-change | service-error,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeFleetHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

      Possible values include:
      • "instance-change"
      • "fleet-change"
      • "service-error"
    • 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)

      The ID of the EC2 Fleet.

    • StartTime — (Date)

      The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HistoryRecords — (Array<map>)

        Information about the events in the history of the EC2 Fleet.

        • EventInformation — (map)

          Information about the event.

          • EventDescription — (String)

            The description of the event.

          • EventSubType — (String)

            The event.

            error events:

            • iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.

            • allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.

            • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot Instances that you can launch.

            • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

            fleetRequestChange events:

            • active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.

            • deleted (EC2 Fleet) / cancelled (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.

            • deleted_running (EC2 Fleet) / cancelled_running (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.

            • deleted_terminating (EC2 Fleet) / cancelled_terminating (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.

            • expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.

            • modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.

            • modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.

            • submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.

            • progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.

            instanceChange events:

            • launched - A new instance was launched.

            • terminated - An instance was terminated by the user.

            • termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.

            Information events:

            • fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.

            • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

            • launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.

            • registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.

          • InstanceId — (String)

            The ID of the instance. This information is available only for instanceChange events.

        • EventType — (String)

          The event type.

          Possible values include:
          • "instance-change"
          • "fleet-change"
          • "service-error"
        • Timestamp — (Date)

          The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

      • LastEvaluatedTime — (Date)

        The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

        If nextToken indicates that there are more items, this value is not present.

      • 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.

      • FleetId — (String)

        The ID of the EC Fleet.

      • StartTime — (Date)

        The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFleetInstances(params = {}, callback) ⇒ AWS.Request

Describes the running instances for the specified EC2 Fleet.

Note: Currently, DescribeFleetInstances does not support fleets of type instant. Instead, use DescribeFleets, specifying the instant fleet ID in the request.

For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the describeFleetInstances operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeFleetInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

    • FleetId — (String)

      The ID of the EC2 Fleet.

    • Filters — (Array<map>)

      The filters.

      • instance-type - The instance type.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ActiveInstances — (Array<map>)

        The running instances. This list is refreshed periodically and might be out of date.

        • InstanceId — (String)

          The ID of the instance.

        • InstanceType — (String)

          The instance type.

        • SpotInstanceRequestId — (String)

          The ID of the Spot Instance request.

        • InstanceHealth — (String)

          The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.

          Possible values include:
          • "healthy"
          • "unhealthy"
      • 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.

      • FleetId — (String)

        The ID of the EC2 Fleet.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFleets(params = {}, callback) ⇒ AWS.Request

Describes the specified EC2 Fleet or all of your EC2 Fleets.

If a fleet is of type instant, you must specify the fleet ID in the request, otherwise the fleet does not appear in the response.

For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the describeFleets operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  FleetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeFleets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      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.
    • Filters — (Array<map>)

      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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Information about the EC2 Fleets.

        • 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.

          Possible values include:
          • "error"
          • "pending_fulfillment"
          • "pending_termination"
          • "fulfilled"
        • CreateTime — (Date)

          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.

          Possible values include:
          • "submitted"
          • "active"
          • "deleted"
          • "failed"
          • "deleted_running"
          • "deleted_terminating"
          • "modifying"
        • 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.

          Possible values include:
          • "no-termination"
          • "termination"
        • 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 — (Array<map>)

          The launch template and overrides.

          • LaunchTemplateSpecification — (map)

            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 — (Array<map>)

            Any parameters that you specify override the same parameters in the 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.
              Possible values include:
              • "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"
            • 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.

              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 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 — (map)

              The location where the instance launched, if applicable.

              • GroupName — (String)

                The name of the placement group that the instance is in.

            • InstanceRequirements — (map)

              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 — (map)

                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 — (map)

                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 — (Array<String>)

                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.

                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

              • MemoryGiBPerVCpu — (map)

                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 — (Array<String>)

                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

              • InstanceGenerations — (Array<String>)

                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

              • 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

                Possible values include:
                • "included"
                • "required"
                • "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

                Possible values include:
                • "included"
                • "required"
                • "excluded"
              • RequireHibernateSupport — (Boolean)

                Indicates whether instance types must support hibernation for On-Demand Instances.

                This parameter is not supported for GetSpotPlacementScores.

                Default: false

              • NetworkInterfaceCount — (map)

                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

                Possible values include:
                • "included"
                • "required"
                • "excluded"
              • LocalStorageTypes — (Array<String>)

                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

              • TotalLocalStorageGB — (map)

                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 — (map)

                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 — (Array<String>)

                The accelerator types that must be on the instance type.

                • For instance types with GPU accelerators, specify gpu.

                • For instance types with FPGA accelerators, specify fpga.

                • For instance types with inference accelerators, specify inference.

                Default: Any accelerator type

              • AcceleratorCount — (map)

                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 — (Array<String>)

                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

              • AcceleratorNames — (Array<String>)

                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

              • AcceleratorTotalMemoryMiB — (map)

                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 — (map)

                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 — (Array<String>)

                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

              • 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.
            • 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.
        • TargetCapacitySpecification — (map)

          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.

            Possible values include:
            • "spot"
            • "on-demand"
            • "capacity-block"
          • TargetCapacityUnitType — (String)

            The unit for the target capacity.

            Possible values include:
            • "vcpu"
            • "memory-mib"
            • "units"
        • 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.

          Possible values include:
          • "request"
          • "maintain"
          • "instant"
        • ValidFrom — (Date)

          The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

        • ValidUntil — (Date)

          The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

        • ReplaceUnhealthyInstances — (Boolean)

          Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.

        • SpotOptions — (map)

          The configuration of Spot Instances in an EC2 Fleet.

          • AllocationStrategy — (String)

            The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.

            price-capacity-optimized (recommended)

            EC2 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. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

            capacity-optimized

            EC2 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 capacity-optimized-prioritized. 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. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

            diversified

            EC2 Fleet requests instances from all of the Spot Instance pools that you specify.

            lowest-price (not recommended)

            We don't recommend the lowest-price allocation strategy because it has the highest risk of interruption for your Spot Instances.

            EC2 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, EC2 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: lowest-price

            Possible values include:
            • "lowest-price"
            • "diversified"
            • "capacity-optimized"
            • "capacity-optimized-prioritized"
            • "price-capacity-optimized"
          • MaintenanceStrategies — (map)

            The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.

            • CapacityRebalance — (map)

              The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.

              • ReplacementStrategy — (String)

                The replacement strategy to use. Only available for fleets of type maintain.

                launch - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 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 - EC2 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.

                Possible values include:
                • "launch"
                • "launch-before-terminate"
              • 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.

          • InstanceInterruptionBehavior — (String)

            The behavior when a Spot Instance is interrupted.

            Default: terminate

            Possible values include:
            • "hibernate"
            • "stop"
            • "terminate"
          • InstancePoolsToUseCount — (Integer)

            The number of Spot pools across which to allocate your target Spot capacity. Supported only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

            Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

          • SingleInstanceType — (Boolean)

            Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

            Supported only for fleets of type instant.

          • SingleAvailabilityZone — (Boolean)

            Indicates that the fleet launches all Spot Instances into a single Availability Zone.

            Supported only for fleets of type instant.

          • MinTargetCapacity — (Integer)

            The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.

            Constraints: Maximum value of 1000. Supported only for fleets of type instant.

            At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

          • MaxTotalPrice — (String)

            The maximum amount per hour for Spot Instances that you're willing to pay. 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 specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
            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 maxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for maxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
        • OnDemandOptions — (map)

          The allocation strategy of On-Demand Instances in an EC2 Fleet.

          • AllocationStrategy — (String)

            The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.

            lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.

            prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.

            Default: lowest-price

            Possible values include:
            • "lowest-price"
            • "prioritized"
          • CapacityReservationOptions — (map)

            The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

            Supported only for fleets of type instant.

            • UsageStrategy — (String)

              Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

              If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).

              If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

              Possible values include:
              • "use-capacity-reservations-first"
          • SingleInstanceType — (Boolean)

            Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.

            Supported only for fleets of type instant.

          • SingleAvailabilityZone — (Boolean)

            Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

            Supported only for fleets of type instant.

          • MinTargetCapacity — (Integer)

            The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.

            Constraints: Maximum value of 1000. Supported only for fleets of type instant.

            At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

          • MaxTotalPrice — (String)

            The maximum amount per hour for On-Demand Instances that you're willing to pay.

            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 maxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for maxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
        • Tags — (Array<map>)

          The tags for an EC2 Fleet resource.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value — (String)

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

        • Errors — (Array<map>)

          Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

          • LaunchTemplateAndOverrides — (map)

            The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

            • LaunchTemplateSpecification — (map)

              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 — (map)

              Any parameters that you specify override the same parameters in the 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.
                Possible values include:
                • "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"
              • 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.

                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 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 — (map)

                The location where the instance launched, if applicable.

                • GroupName — (String)

                  The name of the placement group that the instance is in.

              • InstanceRequirements — (map)

                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 — (map)

                  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 — (map)

                  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 — (Array<String>)

                  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.

                  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

                • MemoryGiBPerVCpu — (map)

                  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 — (Array<String>)

                  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

                • InstanceGenerations — (Array<String>)

                  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

                • 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

                  Possible values include:
                  • "included"
                  • "required"
                  • "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

                  Possible values include:
                  • "included"
                  • "required"
                  • "excluded"
                • RequireHibernateSupport — (Boolean)

                  Indicates whether instance types must support hibernation for On-Demand Instances.

                  This parameter is not supported for GetSpotPlacementScores.

                  Default: false

                • NetworkInterfaceCount — (map)

                  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

                  Possible values include:
                  • "included"
                  • "required"
                  • "excluded"
                • LocalStorageTypes — (Array<String>)

                  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

                • TotalLocalStorageGB — (map)

                  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 — (map)

                  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 — (Array<String>)

                  The accelerator types that must be on the instance type.

                  • For instance types with GPU accelerators, specify gpu.

                  • For instance types with FPGA accelerators, specify fpga.

                  • For instance types with inference accelerators, specify inference.

                  Default: Any accelerator type

                • AcceleratorCount — (map)

                  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 — (Array<String>)

                  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

                • AcceleratorNames — (Array<String>)

                  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

                • AcceleratorTotalMemoryMiB — (map)

                  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 — (map)

                  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 — (Array<String>)

                  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

                • 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.
              • 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.
          • Lifecycle — (String)

            Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

            Possible values include:
            • "spot"
            • "on-demand"
          • ErrorCode — (String)

            The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.

          • ErrorMessage — (String)

            The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.

        • Instances — (Array<map>)

          Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

          • LaunchTemplateAndOverrides — (map)

            The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

            • LaunchTemplateSpecification — (map)

              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 — (map)

              Any parameters that you specify override the same parameters in the 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.
                Possible values include:
                • "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"
              • 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.

                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 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 — (map)

                The location where the instance launched, if applicable.

                • GroupName — (String)

                  The name of the placement group that the instance is in.

              • InstanceRequirements — (map)

                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 — (map)

                  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 — (map)

                  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 — (Array<String>)

                  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.

                  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

                • MemoryGiBPerVCpu — (map)

                  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 — (Array<String>)

                  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

                • InstanceGenerations — (Array<String>)

                  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

                • 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

                  Possible values include:
                  • "included"
                  • "required"
                  • "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

                  Possible values include:
                  • "included"
                  • "required"
                  • "excluded"
                • RequireHibernateSupport — (Boolean)

                  Indicates whether instance types must support hibernation for On-Demand Instances.

                  This parameter is not supported for GetSpotPlacementScores.

                  Default: false

                • NetworkInterfaceCount — (map)

                  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

                  Possible values include:
                  • "included"
                  • "required"
                  • "excluded"
                • LocalStorageTypes — (Array<String>)

                  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

                • TotalLocalStorageGB — (map)

                  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 — (map)

                  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 — (Array<String>)

                  The accelerator types that must be on the instance type.

                  • For instance types with GPU accelerators, specify gpu.

                  • For instance types with FPGA accelerators, specify fpga.

                  • For instance types with inference accelerators, specify inference.

                  Default: Any accelerator type

                • AcceleratorCount — (map)

                  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 — (Array<String>)

                  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

                • AcceleratorNames — (Array<String>)

                  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

                • AcceleratorTotalMemoryMiB — (map)

                  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 — (map)

                  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 — (Array<String>)

                  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

                • 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.
              • 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.
          • Lifecycle — (String)

            Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

            Possible values include:
            • "spot"
            • "on-demand"
          • InstanceIds — (Array<String>)

            The IDs of the instances.

          • InstanceType — (String)

            The instance type.

            Possible values include:
            • "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"
          • Platform — (String)

            The value is Windows for Windows instances. Otherwise, the value is blank.

            Possible values include:
            • "Windows"
        • Context — (String)

          Reserved.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFlowLogs(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeFlowLogs operation

var params = {
  DryRun: true || false,
  Filter: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  FlowLogIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeFlowLogs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • Filter — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • FlowLogIds — (Array<String>)

      One or more flow log IDs.

      Constraint: Maximum of 1000 flow log IDs.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowLogs — (Array<map>)

        Information about the flow logs.

        • CreationTime — (Date)

          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.

          Possible values include:
          • "ACCEPT"
          • "REJECT"
          • "ALL"
        • LogDestinationType — (String)

          The type of destination for the flow log data.

          Possible values include:
          • "cloud-watch-logs"
          • "s3"
          • "kinesis-data-firehose"
        • 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 — (Array<map>)

          The tags for the flow log.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          The destination options.

          • FileFormat — (String)

            The format for the flow log.

            Possible values include:
            • "plain-text"
            • "parquet"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFpgaImageAttribute(params = {}, callback) ⇒ AWS.Request

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

Service Reference:

Examples:

Calling the describeFpgaImageAttribute operation

var params = {
  Attribute: description | name | loadPermission | productCodes, /* required */
  FpgaImageId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.describeFpgaImageAttribute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the AFI.

    • Attribute — (String)

      The AFI attribute.

      Possible values include:
      • "description"
      • "name"
      • "loadPermission"
      • "productCodes"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FpgaImageAttribute — (map)

        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 — (Array<map>)

          The load permissions.

          • UserId — (String)

            The Amazon Web Services account ID.

          • Group — (String)

            The name of the group.

            Possible values include:
            • "all"
        • ProductCodes — (Array<map>)

          The product codes.

          • ProductCodeId — (String)

            The product code.

          • ProductCodeType — (String)

            The type of product code.

            Possible values include:
            • "devpay"
            • "marketplace"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFpgaImages(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeFpgaImages operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  FpgaImageIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Owners: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeFpgaImages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The AFI IDs.

    • Owners — (Array<String>)

      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).

    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • update-time - The time of the most recent update.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • NextToken — (String)

      The token to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FpgaImages — (Array<map>)

        Information about the FPGA images.

        • 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 — (map)

          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 — (map)

          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.

            Possible values include:
            • "pending"
            • "failed"
            • "available"
            • "unavailable"
          • Message — (String)

            If the state is failed, this is the error message.

        • CreateTime — (Date)

          The date and time the AFI was created.

        • UpdateTime — (Date)

          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 — (Array<map>)

          The product codes for the AFI.

          • ProductCodeId — (String)

            The product code.

          • ProductCodeType — (String)

            The type of product code.

            Possible values include:
            • "devpay"
            • "marketplace"
        • Tags — (Array<map>)

          Any tags assigned to the AFI.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<String>)

          The instance types supported by the AFI.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeHostReservationOfferings(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeHostReservationOfferings operation

var params = {
  Filter: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxDuration: 'NUMBER_VALUE',
  MaxResults: 'NUMBER_VALUE',
  MinDuration: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OfferingId: 'STRING_VALUE'
};
ec2.describeHostReservationOfferings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filter — (Array<map>)

      The filters.

      • instance-family - The instance family of the offering (for example, m4).

      • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Information about the offerings.

        • CurrencyCode — (String)

          The currency of the offering.

          Possible values include:
          • "USD"
        • 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.

          Possible values include:
          • "AllUpfront"
          • "PartialUpfront"
          • "NoUpfront"
        • UpfrontPrice — (String)

          The upfront price of the offering. Does not apply to No Upfront offerings.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeHostReservations(params = {}, callback) ⇒ AWS.Request

Describes reservations that are associated with Dedicated Hosts in your account.

Service Reference:

Examples:

Calling the describeHostReservations operation

var params = {
  Filter: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  HostReservationIdSet: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeHostReservations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filter — (Array<map>)

      The filters.

      • instance-family - The instance family (for example, m4).

      • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

      • state - The state of the reservation (payment-pending | payment-failed | active | retired).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • HostReservationIdSet — (Array<String>)

      The host reservation IDs.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostReservationSet — (Array<map>)

        Details about the reservation's configuration.

        • 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.

          Possible values include:
          • "USD"
        • Duration — (Integer)

          The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).

        • End — (Date)

          The date and time that the reservation ends.

        • HostIdSet — (Array<String>)

          The IDs of the Dedicated Hosts associated with the reservation.

        • 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.

          Possible values include:
          • "AllUpfront"
          • "PartialUpfront"
          • "NoUpfront"
        • Start — (Date)

          The date and time that the reservation started.

        • State — (String)

          The state of the reservation.

          Possible values include:
          • "payment-pending"
          • "payment-failed"
          • "active"
          • "retired"
        • UpfrontPrice — (String)

          The upfront price of the reservation.

        • Tags — (Array<map>)

          Any tags assigned to the Dedicated Host Reservation.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeHosts(params = {}, callback) ⇒ AWS.Request

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.

Service Reference:

Examples:

Calling the describeHosts operation

var params = {
  Filter: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  HostIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeHosts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filter — (Array<map>)

      The filters.

      • auto-placement - Whether auto-placement is enabled or disabled (on | off).

      • availability-zone - The Availability Zone of the host.

      • client-token - The idempotency token that you provided when you allocated the host.

      • host-reservation-id - The ID of the reservation assigned to this host.

      • instance-type - The instance type size that the Dedicated Host is configured to support.

      • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • HostIds — (Array<String>)

      The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

    • 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.

      You cannot specify this parameter and the host IDs parameter in the same request.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Hosts — (Array<map>)

        Information about the Dedicated Hosts.

        • AutoPlacement — (String)

          Whether auto-placement is on or off.

          Possible values include:
          • "on"
          • "off"
        • AvailabilityZone — (String)

          The Availability Zone of the Dedicated Host.

        • AvailableCapacity — (map)

          Information about the instances running on the Dedicated Host.

          • AvailableInstanceCapacity — (Array<map>)

            The number of instances that can be launched onto the Dedicated Host depending on the host's available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.

            • AvailableCapacity — (Integer)

              The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.

            • InstanceType — (String)

              The instance type supported by the Dedicated Host.

            • TotalCapacity — (Integer)

              The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.

          • AvailableVCpus — (Integer)

            The number of vCPUs available for launching instances onto the Dedicated Host.

        • ClientToken — (String)

          Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

        • HostId — (String)

          The ID of the Dedicated Host.

        • HostProperties — (map)

          The hardware specifications of the Dedicated Host.

          • Cores — (Integer)

            The number of cores on the Dedicated Host.

          • InstanceType — (String)

            The instance type supported by the Dedicated Host. For example, m5.large. If the host supports multiple instance types, no instanceType is returned.

          • InstanceFamily — (String)

            The instance family supported by the Dedicated Host. For example, m5.

          • Sockets — (Integer)

            The number of sockets on the Dedicated Host.

          • TotalVCpus — (Integer)

            The total number of vCPUs on the Dedicated Host.

        • HostReservationId — (String)

          The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

        • Instances — (Array<map>)

          The IDs and instance type that are currently running on the Dedicated Host.

          • InstanceId — (String)

            The ID of instance that is running on the Dedicated Host.

          • InstanceType — (String)

            The instance type (for example, m3.medium) of the running instance.

          • OwnerId — (String)

            The ID of the Amazon Web Services account that owns the instance.

        • State — (String)

          The Dedicated Host's state.

          Possible values include:
          • "available"
          • "under-assessment"
          • "permanent-failure"
          • "released"
          • "released-permanent-failure"
          • "pending"
        • AllocationTime — (Date)

          The time that the Dedicated Host was allocated.

        • ReleaseTime — (Date)

          The time that the Dedicated Host was released.

        • Tags — (Array<map>)

          Any tags assigned to the Dedicated Host.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value — (String)

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

        • HostRecovery — (String)

          Indicates whether host recovery is enabled or disabled for the Dedicated Host.

          Possible values include:
          • "on"
          • "off"
        • AllowsMultipleInstanceTypes — (String)

          Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.

          Possible values include:
          • "on"
          • "off"
        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the Dedicated Host.

        • AvailabilityZoneId — (String)

          The ID of the Availability Zone in which the Dedicated Host is allocated.

        • MemberOfServiceLinkedResourceGroup — (Boolean)

          Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.

        • OutpostArn — (String)

          The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.

        • HostMaintenance — (String)

          Indicates whether host maintenance is enabled or disabled for the Dedicated Host.

          Possible values include:
          • "on"
          • "off"
        • AssetId — (String)

          The ID of the Outpost hardware asset on which the Dedicated Host is allocated.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIamInstanceProfileAssociations(params = {}, callback) ⇒ AWS.Request

Describes your IAM instance profile associations.

Service Reference:

Examples:

To describe an IAM instance profile association


/* This example describes the specified IAM instance profile association. */

 var params = {
  AssociationIds: [
     "iip-assoc-0db249b1f25fa24b8"
  ]
 };
 ec2.describeIamInstanceProfileAssociations(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    IamInstanceProfileAssociations: [
       {
      AssociationId: "iip-assoc-0db249b1f25fa24b8", 
      IamInstanceProfile: {
       Arn: "arn:aws:iam::123456789012:instance-profile/admin-role", 
       Id: "AIPAJVQN4F5WVLGCJDRGM"
      }, 
      InstanceId: "i-09eb09efa73ec1dee", 
      State: "associated"
     }
    ]
   }
   */
 });

Calling the describeIamInstanceProfileAssociations operation

var params = {
  AssociationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeIamInstanceProfileAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AssociationIds — (Array<String>)

      The IAM instance profile associations.

    • Filters — (Array<map>)

      The filters.

      • instance-id - The ID of the instance.

      • state - The state of the association (associating | associated | disassociating).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IamInstanceProfileAssociations — (Array<map>)

        Information about the IAM instance profile associations.

        • AssociationId — (String)

          The ID of the association.

        • InstanceId — (String)

          The ID of the instance.

        • IamInstanceProfile — (map)

          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.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"
        • Timestamp — (Date)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIdentityIdFormat(params = {}, callback) ⇒ AWS.Request

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

Service Reference:

Examples:

Calling the describeIdentityIdFormat operation

var params = {
  PrincipalArn: 'STRING_VALUE', /* required */
  Resource: 'STRING_VALUE'
};
ec2.describeIdentityIdFormat(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PrincipalArn — (String)

      The ARN of the principal, which can be an IAM role, IAM user, or the root user.

    • 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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Statuses — (Array<map>)

        Information about the ID format for the resources.

        • Deadline — (Date)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIdFormat(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeIdFormat operation

var params = {
  Resource: 'STRING_VALUE'
};
ec2.describeIdFormat(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Statuses — (Array<map>)

        Information about the ID format for the resource.

        • Deadline — (Date)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeImageAttribute(params = {}, callback) ⇒ AWS.Request

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

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.

Service Reference:

Examples:

To describe the launch permissions for an AMI


/* This example describes the launch permissions for the specified AMI. */

 var params = {
  Attribute: "launchPermission", 
  ImageId: "ami-5731123e"
 };
 ec2.describeImageAttribute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ImageId: "ami-5731123e", 
    LaunchPermissions: [
       {
      UserId: "123456789012"
     }
    ]
   }
   */
 });

Calling the describeImageAttribute operation

var params = {
  Attribute: description | kernel | ramdisk | launchPermission | productCodes | blockDeviceMapping | sriovNetSupport | bootMode | tpmSupport | uefiData | lastLaunchedTime | imdsSupport | deregistrationProtection, /* required */
  ImageId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.describeImageAttribute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Attribute — (String)

      The AMI attribute.

      Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.

      Possible values include:
      • "description"
      • "kernel"
      • "ramdisk"
      • "launchPermission"
      • "productCodes"
      • "blockDeviceMapping"
      • "sriovNetSupport"
      • "bootMode"
      • "tpmSupport"
      • "uefiData"
      • "lastLaunchedTime"
      • "imdsSupport"
      • "deregistrationProtection"
    • ImageId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BlockDeviceMappings — (Array<map>)

        The block device mapping entries.

        • 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 — (map)

          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.

            Possible values include:
            • "standard"
            • "io1"
            • "io2"
            • "gp2"
            • "sc1"
            • "st1"
            • "gp3"
          • KmsKeyId — (String)

            Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

            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.

          • 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.

        • 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.

      • ImageId — (String)

        The ID of the AMI.

      • LaunchPermissions — (Array<map>)

        The launch permissions.

        • Group — (String)

          The name of the group.

          Possible values include:
          • "all"
        • UserId — (String)

          The Amazon Web Services account ID.

          Constraints: Up to 10 000 account IDs can be specified in a single request.

        • OrganizationArn — (String)

          The Amazon Resource Name (ARN) of an organization.

        • OrganizationalUnitArn — (String)

          The Amazon Resource Name (ARN) of an organizational unit (OU).

      • ProductCodes — (Array<map>)

        The product codes.

        • ProductCodeId — (String)

          The product code.

        • ProductCodeType — (String)

          The type of product code.

          Possible values include:
          • "devpay"
          • "marketplace"
      • Description — (map)

        A description for the AMI.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • KernelId — (map)

        The kernel ID.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • RamdiskId — (map)

        The RAM disk ID.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • SriovNetSupport — (map)

        Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • BootMode — (map)

        The boot mode.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • TpmSupport — (map)

        If the image is configured for NitroTPM support, the value is v2.0.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • UefiData — (map)

        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 in the Amazon EC2 User Guide.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • LastLaunchedTime — (map)

        The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

        Note: lastLaunchedTime data is available starting April 2017.
        • Value — (String)

          The attribute value. The value is case-sensitive.

      • ImdsSupport — (map)

        If v2.0, it indicates 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.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • DeregistrationProtection — (map)

        Indicates whether deregistration protection is enabled for the AMI.

        • Value — (String)

          The attribute value. The value is case-sensitive.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeImages(params = {}, callback) ⇒ AWS.Request

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.

Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.

We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
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.

Service Reference:

Examples:

To describe an AMI


/* This example describes the specified AMI. */

 var params = {
  ImageIds: [
     "ami-5731123e"
  ]
 };
 ec2.describeImages(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Images: [
       {
      Architecture: "x86_64", 
      BlockDeviceMappings: [
         {
        DeviceName: "/dev/sda1", 
        Ebs: {
         DeleteOnTermination: true, 
         SnapshotId: "snap-1234567890abcdef0", 
         VolumeSize: 8, 
         VolumeType: "standard"
        }
       }
      ], 
      Description: "An AMI for my server", 
      Hypervisor: "xen", 
      ImageId: "ami-5731123e", 
      ImageLocation: "123456789012/My server", 
      ImageType: "machine", 
      KernelId: "aki-88aa75e1", 
      Name: "My server", 
      OwnerId: "123456789012", 
      Public: false, 
      RootDeviceName: "/dev/sda1", 
      RootDeviceType: "ebs", 
      State: "available", 
      VirtualizationType: "paravirtual"
     }
    ]
   }
   */
 });

Calling the describeImages operation

var params = {
  DryRun: true || false,
  ExecutableUsers: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ImageIds: [
    'STRING_VALUE',
    /* more items */
  ],
  IncludeDeprecated: true || false,
  IncludeDisabled: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Owners: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeImages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ExecutableUsers — (Array<String>)

      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.

    • Filters — (Array<map>)

      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.

      • hypervisor - The hypervisor type (ovm | xen).

      • image-id - The ID of the image.

      • image-type - The image type (machine | kernel | ramdisk).

      • is-public - A Boolean that indicates whether the image is public.

      • kernel-id - The kernel ID.

      • manifest-location - The location of the image manifest.

      • name - The name of the AMI (provided during image creation).

      • owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the 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-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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • virtualization-type - The virtualization type (paravirtual | hvm).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • ImageIds — (Array<String>)

      The image IDs.

      Default: Describes all images available to you.

    • Owners — (Array<String>)

      Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.

    • 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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Images — (Array<map>)

        Information about the images.

        • Architecture — (String)

          The architecture of the image.

          Possible values include:
          • "i386"
          • "x86_64"
          • "arm64"
          • "x86_64_mac"
          • "arm64_mac"
        • CreationDate — (String)

          The date and time the image was created.

        • ImageId — (String)

          The ID of the AMI.

        • ImageLocation — (String)

          The location of the AMI.

        • ImageType — (String)

          The type of image.

          Possible values include:
          • "machine"
          • "kernel"
          • "ramdisk"
        • Public — (Boolean)

          Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

        • KernelId — (String)

          The kernel associated with the image, if any. Only applicable for machine images.

        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the image.

        • Platform — (String)

          This value is set to windows for Windows AMIs; otherwise, it is blank.

          Possible values include:
          • "Windows"
        • 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.

        • ProductCodes — (Array<map>)

          Any product codes associated with the AMI.

          • ProductCodeId — (String)

            The product code.

          • ProductCodeType — (String)

            The type of product code.

            Possible values include:
            • "devpay"
            • "marketplace"
        • RamdiskId — (String)

          The RAM disk associated with the image, if any. Only applicable for machine images.

        • 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.

          Possible values include:
          • "pending"
          • "available"
          • "invalid"
          • "deregistered"
          • "transient"
          • "failed"
          • "error"
          • "disabled"
        • BlockDeviceMappings — (Array<map>)

          Any block device mapping entries.

          • 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 — (map)

            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.

              Possible values include:
              • "standard"
              • "io1"
              • "io2"
              • "gp2"
              • "sc1"
              • "st1"
              • "gp3"
            • KmsKeyId — (String)

              Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

              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.

            • 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.

          • 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.

        • 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.

          Possible values include:
          • "ovm"
          • "xen"
        • ImageOwnerAlias — (String)

          The owner alias (amazon | 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.

          Possible values include:
          • "ebs"
          • "instance-store"
        • SriovNetSupport — (String)

          Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

        • StateReason — (map)

          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 — (Array<map>)

          Any tags assigned to the image.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "hvm"
          • "paravirtual"
        • BootMode — (String)

          The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.

          Possible values include:
          • "legacy-bios"
          • "uefi"
          • "uefi-preferred"
        • 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.

          Possible values include:
          • "v2.0"
        • DeprecationTime — (String)

          The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

        • ImdsSupport — (String)

          If v2.0, it indicates 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.

          Possible values include:
          • "v2.0"
        • SourceInstanceId — (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.

        • DeregistrationProtection — (String)

          Indicates whether deregistration protection is enabled for the AMI.

        • LastLaunchedTime — (String)

          The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

          Note: lastLaunchedTime data is available starting April 2017.
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeImportImageTasks(params = {}, callback) ⇒ AWS.Request

Displays details about an import virtual machine or import snapshot tasks that are already created.

Service Reference:

Examples:

Calling the describeImportImageTasks operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ImportTaskIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeImportImageTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • ImportTaskIds — (Array<String>)

      The IDs of the import image tasks.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

    • NextToken — (String)

      A token that indicates the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImportImageTasks — (Array<map>)

        A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

        • 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 — (Array<map>)

          Information about the snapshots.

          • 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 — (map)

            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 — (Array<map>)

          The tags for the import image task.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

          The ARNs of the license configurations that are associated with the import image task.

          • LicenseConfigurationArn — (String)

            The ARN of a license configuration.

        • UsageOperation — (String)

          The usage operation value.

        • BootMode — (String)

          The boot mode of the virtual machine.

          Possible values include:
          • "legacy-bios"
          • "uefi"
          • "uefi-preferred"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeImportSnapshotTasks(params = {}, callback) ⇒ AWS.Request

Describes your import snapshot tasks.

Service Reference:

Examples:

Calling the describeImportSnapshotTasks operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ImportTaskIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeImportSnapshotTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      The filters.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • ImportTaskIds — (Array<String>)

      A list of import snapshot task IDs.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImportSnapshotTasks — (Array<map>)

        A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

        • Description — (String)

          A description of the import snapshot task.

        • ImportTaskId — (String)

          The ID of the import snapshot task.

        • SnapshotTaskDetail — (map)

          Describes an import snapshot task.

          • Description — (String)

            The description of the snapshot.

          • 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 — (map)

            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 — (Array<map>)

          The tags for the import snapshot task.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeInstanceAttribute(params = {}, callback) ⇒ AWS.Request

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

Service Reference:

Examples:

To describe the instance type


/* This example describes the instance type of the specified instance.
*/

 var params = {
  Attribute: "instanceType", 
  InstanceId: "i-1234567890abcdef0"
 };
 ec2.describeInstanceAttribute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InstanceId: "i-1234567890abcdef0", 
    InstanceType: {
     Value: "t1.micro"
    }
   }
   */
 });

To describe the disableApiTermination attribute


/* This example describes the ``disableApiTermination`` attribute of the specified instance.
*/

 var params = {
  Attribute: "disableApiTermination", 
  InstanceId: "i-1234567890abcdef0"
 };
 ec2.describeInstanceAttribute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DisableApiTermination: {
     Value: false
    }, 
    InstanceId: "i-1234567890abcdef0"
   }
   */
 });

To describe the block device mapping for an instance


/* This example describes the ``blockDeviceMapping`` attribute of the specified instance.
*/

 var params = {
  Attribute: "blockDeviceMapping", 
  InstanceId: "i-1234567890abcdef0"
 };
 ec2.describeInstanceAttribute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    BlockDeviceMappings: [
       {
      DeviceName: "/dev/sda1", 
      Ebs: {
       AttachTime: <Date Representation>, 
       DeleteOnTermination: true, 
       Status: "attached", 
       VolumeId: "vol-049df61146c4d7901"
      }
     }, 
       {
      DeviceName: "/dev/sdf", 
      Ebs: {
       AttachTime: <Date Representation>, 
       DeleteOnTermination: false, 
       Status: "attached", 
       VolumeId: "vol-049df61146c4d7901"
      }
     }
    ], 
    InstanceId: "i-1234567890abcdef0"
   }
   */
 });

Calling the describeInstanceAttribute operation

var params = {
  Attribute: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | enclaveOptions | disableApiStop, /* required */
  InstanceId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.describeInstanceAttribute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Attribute — (String)

      The instance attribute.

      Note: The enaSupport attribute is not supported at this time.

      Possible values include:
      • "instanceType"
      • "kernel"
      • "ramdisk"
      • "userData"
      • "disableApiTermination"
      • "instanceInitiatedShutdownBehavior"
      • "rootDeviceName"
      • "blockDeviceMapping"
      • "productCodes"
      • "sourceDestCheck"
      • "groupSet"
      • "ebsOptimized"
      • "sriovNetSupport"
      • "enaSupport"
      • "enclaveOptions"
      • "disableApiStop"
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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)

      The ID of the instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Groups — (Array<map>)

        The security groups associated with the instance.

        • GroupName — (String)

          The name of the security group.

        • GroupId — (String)

          The ID of the security group.

      • BlockDeviceMappings — (Array<map>)

        The block device mapping of the instance.

        • DeviceName — (String)

          The device name (for example, /dev/sdh or xvdh).

        • Ebs — (map)

          Parameters used to automatically set up EBS volumes when the instance is launched.

          • AttachTime — (Date)

            The time stamp when the attachment initiated.

          • DeleteOnTermination — (Boolean)

            Indicates whether the volume is deleted on instance termination.

          • Status — (String)

            The attachment state.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • VolumeId — (String)

            The ID of the EBS volume.

          • AssociatedResource — (String)

            The ARN of the Amazon ECS or Fargate task 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 Fargate tasks.

      • DisableApiTermination — (map)

        If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

        • Value — (Boolean)

          The attribute value. The valid values are true or false.

      • EnaSupport — (map)

        Indicates whether enhanced networking with ENA is enabled.

        • Value — (Boolean)

          The attribute value. The valid values are true or false.

      • EnclaveOptions — (map)

        To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.

        • 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 — (map)

        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 — (map)

        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 — (map)

        The instance type.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • KernelId — (map)

        The kernel ID.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • ProductCodes — (Array<map>)

        A list of product codes.

        • ProductCodeId — (String)

          The product code.

        • ProductCodeType — (String)

          The type of product code.

          Possible values include:
          • "devpay"
          • "marketplace"
      • RamdiskId — (map)

        The RAM disk ID.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • RootDeviceName — (map)

        The device name of the root device volume (for example, /dev/sda1).

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • SourceDestCheck — (map)

        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.

      • SriovNetSupport — (map)

        Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • UserData — (map)

        The user data.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • DisableApiStop — (map)

        To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.

        • Value — (Boolean)

          The attribute value. The valid values are true or false.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInstanceConnectEndpoints(params = {}, callback) ⇒ AWS.Request

Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.

Service Reference:

Examples:

Calling the describeInstanceConnectEndpoints operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  InstanceConnectEndpointIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeInstanceConnectEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • 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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • InstanceConnectEndpointIds — (Array<String>)

      One or more EC2 Instance Connect Endpoint IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceConnectEndpoints — (Array<map>)

        Information about the EC2 Instance Connect Endpoints.

        • 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.

          Possible values include:
          • "create-in-progress"
          • "create-complete"
          • "create-failed"
          • "delete-in-progress"
          • "delete-complete"
          • "delete-failed"
        • 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)

        • NetworkInterfaceIds — (Array<String>)

          The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.

        • 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 — (Date)

          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 — (Array<String>)

          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.

        • Tags — (Array<map>)

          The tags assigned to the EC2 Instance Connect Endpoint.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 include in another request to get the next page of items. This value is null when there are no more items to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInstanceCreditSpecifications(params = {}, callback) ⇒ AWS.Request

Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.

If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the describeInstanceCreditSpecifications operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  InstanceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeInstanceCreditSpecifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      The filters.

      • instance-id - The ID of the instance.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • InstanceIds — (Array<String>)

      The instance IDs.

      Default: Describes all your instances.

      Constraints: Maximum 1000 explicitly specified instance IDs.

    • 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 call.

    • NextToken — (String)

      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceCreditSpecifications — (Array<map>)

        Information about the credit option for CPU usage of an instance.

        • InstanceId — (String)

          The ID of the instance.

        • CpuCredits — (String)

          The credit option for CPU usage of the instance.

          Valid values: standard | unlimited

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInstanceEventNotificationAttributes(params = {}, callback) ⇒ AWS.Request

Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.

Service Reference:

Examples:

Calling the describeInstanceEventNotificationAttributes operation

var params = {
  DryRun: true || false
};
ec2.describeInstanceEventNotificationAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceTagAttribute — (map)

        Information about the registered tag keys.

        • InstanceTagKeys — (Array<String>)

          The registered tag keys.

        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInstanceEventWindows(params = {}, callback) ⇒ AWS.Request

Describes the specified event windows or all event windows.

If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the describeInstanceEventWindows operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  InstanceEventWindowIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeInstanceEventWindows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • InstanceEventWindowIds — (Array<String>)

      The IDs of the event windows.

    • Filters — (Array<map>)

      One or more filters.

      • dedicated-host-id - The event windows associated with the specified Dedicated Host ID.

      • event-window-name - The event windows associated with the specified names.

      • instance-id - The event windows associated with the specified instance ID.

      • instance-tag - The event windows associated with the specified tag and value.

      • instance-tag-key - The event windows associated with the specified tag key, regardless of the value.

      • instance-tag-value - The event windows associated with the specified tag value, regardless of the key.

      • tag:<key> - 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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceEventWindows — (Array<map>)

        Information about the event windows.

        • InstanceEventWindowId — (String)

          The ID of the event window.

        • TimeRanges — (Array<map>)

          One or more time ranges defined for the event window.

          • StartWeekDay — (String)

            The day on which the time range begins.

            Possible values include:
            • "sunday"
            • "monday"
            • "tuesday"
            • "wednesday"
            • "thursday"
            • "friday"
            • "saturday"
          • StartHour — (Integer)

            The hour when the time range begins.

          • EndWeekDay — (String)

            The day on which the time range ends.

            Possible values include:
            • "sunday"
            • "monday"
            • "tuesday"
            • "wednesday"
            • "thursday"
            • "friday"
            • "saturday"
          • 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 — (map)

          One or more targets associated with the event window.

          • InstanceIds — (Array<String>)

            The IDs of the instances associated with the event window.

          • Tags — (Array<map>)

            The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window.

            • Key — (String)

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<String>)

            The IDs of the Dedicated Hosts associated with the event window.

        • State — (String)

          The current state of the event window.

          Possible values include:
          • "creating"
          • "deleting"
          • "active"
          • "deleted"
        • Tags — (Array<map>)

          The instance tags associated with the event window.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInstances(params = {}, callback) ⇒ AWS.Request

Describes the specified instances or all instances.

If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
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.

Service Reference:

Examples:

To describe an Amazon EC2 instance


/* This example describes the specified instance. */

 var params = {
  InstanceIds: [
     "i-1234567890abcdef0"
  ]
 };
 ec2.describeInstances(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To describe the instances with a specific instance type


/* This example describes the instances with the t2.micro instance type. */

 var params = {
  Filters: [
     {
    Name: "instance-type", 
    Values: [
       "t2.micro"
    ]
   }
  ]
 };
 ec2.describeInstances(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To describe the instances with a specific tag


/* This example describes the instances with the Purpose=test tag. */

 var params = {
  Filters: [
     {
    Name: "tag:Purpose", 
    Values: [
       "test"
    ]
   }
  ]
 };
 ec2.describeInstances(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the describeInstances operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  InstanceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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.

      • iam-instance-profile.name - The instance profile associated with the instance. Specified as an name.

      • 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.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.

      • 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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

      • 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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • InstanceIds — (Array<String>)

      The instance IDs.

      Default: Describes all your instances.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Reservations — (Array<map>)

        Information about the reservations.

        • Groups — (Array<map>)

          Not supported.

          • GroupName — (String)

            The name of the security group.

          • GroupId — (String)

            The ID of the security group.

        • Instances — (Array<map>)

          The instances.

          • AmiLaunchIndex — (Integer)

            The AMI launch index, which can be used to find this instance in the launch group.

          • ImageId — (String)

            The ID of the AMI used to launch the instance.

          • InstanceId — (String)

            The ID of the instance.

          • InstanceType — (String)

            The instance type.

            Possible values include:
            • "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"
          • KernelId — (String)

            The kernel associated with this instance, if applicable.

          • KeyName — (String)

            The name of the key pair, if this instance was launched with an associated key pair.

          • LaunchTime — (Date)

            The time the instance was launched.

          • Monitoring — (map)

            The monitoring for the instance.

            • State — (String)

              Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

              Possible values include:
              • "disabled"
              • "disabling"
              • "enabled"
              • "pending"
          • Placement — (map)

            The location where the instance launched, if applicable.

            • 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.

            • 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.

              Possible values include:
              • "default"
              • "dedicated"
              • "host"
            • 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.

          • Platform — (String)

            The platform. This value is windows for Windows instances; otherwise, it is empty.

            Possible values include:
            • "Windows"
          • 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.

          • PrivateIpAddress — (String)

            The private IPv4 address assigned to the instance.

          • ProductCodes — (Array<map>)

            The product codes attached to this instance, if applicable.

            • ProductCodeId — (String)

              The product code.

            • ProductCodeType — (String)

              The type of product code.

              Possible values include:
              • "devpay"
              • "marketplace"
          • PublicDnsName — (String)

            [IPv4 only] 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.

          • 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.

          • RamdiskId — (String)

            The RAM disk associated with this instance, if applicable.

          • State — (map)

            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 28 and (216)-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 20 and (28)-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 28 or 256 in decimal.

            • Name — (String)

              The current state of the instance.

              Possible values include:
              • "pending"
              • "running"
              • "shutting-down"
              • "terminated"
              • "stopping"
              • "stopped"
          • StateTransitionReason — (String)

            The reason for the most recent state transition. This might be an empty string.

          • 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.

          • Architecture — (String)

            The architecture of the image.

            Possible values include:
            • "i386"
            • "x86_64"
            • "arm64"
            • "x86_64_mac"
            • "arm64_mac"
          • BlockDeviceMappings — (Array<map>)

            Any block device mapping entries for the instance.

            • DeviceName — (String)

              The device name (for example, /dev/sdh or xvdh).

            • Ebs — (map)

              Parameters used to automatically set up EBS volumes when the instance is launched.

              • AttachTime — (Date)

                The time stamp when the attachment initiated.

              • DeleteOnTermination — (Boolean)

                Indicates whether the volume is deleted on instance termination.

              • Status — (String)

                The attachment state.

                Possible values include:
                • "attaching"
                • "attached"
                • "detaching"
                • "detached"
              • VolumeId — (String)

                The ID of the EBS volume.

              • AssociatedResource — (String)

                The ARN of the Amazon ECS or Fargate task 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 Fargate tasks.

          • 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.

            Possible values include:
            • "ovm"
            • "xen"
          • IamInstanceProfile — (map)

            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.

            Possible values include:
            • "spot"
            • "scheduled"
            • "capacity-block"
          • ElasticGpuAssociations — (Array<map>)

            Deprecated.

            Note: Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
            • 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 — (Array<map>)

            The elastic inference accelerator associated with the instance.

            • 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 — (Date)

              The time at which the elastic inference accelerator is associated with an instance.

          • NetworkInterfaces — (Array<map>)

            The network interfaces for the instance.

            • Association — (map)

              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 — (map)

              The network interface attachment.

              • AttachTime — (Date)

                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.

                Possible values include:
                • "attaching"
                • "attached"
                • "detaching"
                • "detached"
              • NetworkCardIndex — (Integer)

                The index of the network card.

              • EnaSrdSpecification — (map)

                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 — (map)

                  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.

            • Description — (String)

              The description.

            • Groups — (Array<map>)

              The security groups.

              • GroupName — (String)

                The name of the security group.

              • GroupId — (String)

                The ID of the security group.

            • Ipv6Addresses — (Array<map>)

              The IPv6 addresses associated with the network interface.

              • 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 — (Array<map>)

              The private IPv4 addresses associated with the network interface.

              • Association — (map)

                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.

              Possible values include:
              • "available"
              • "associated"
              • "attaching"
              • "in-use"
              • "detaching"
            • 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 | trunk

            • Ipv4Prefixes — (Array<map>)

              The IPv4 delegated prefixes that are assigned to the network interface.

              • Ipv4Prefix — (String)

                One or more IPv4 prefixes assigned to the network interface.

            • Ipv6Prefixes — (Array<map>)

              The IPv6 delegated prefixes that are assigned to the network interface.

              • Ipv6Prefix — (String)

                One or more IPv6 prefixes assigned to the network interface.

            • ConnectionTrackingConfiguration — (map)

              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.

          • 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.

            Possible values include:
            • "ebs"
            • "instance-store"
          • SecurityGroups — (Array<map>)

            The security groups for the instance.

            • GroupName — (String)

              The name of the security group.

            • GroupId — (String)

              The ID 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 — (map)

            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 — (Array<map>)

            Any tags assigned to the instance.

            • Key — (String)

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

            Possible values include:
            • "hvm"
            • "paravirtual"
          • CpuOptions — (map)

            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.

              Possible values include:
              • "enabled"
              • "disabled"
          • CapacityReservationId — (String)

            The ID of the Capacity Reservation.

          • CapacityReservationSpecification — (map)

            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.

              Possible values include:
              • "open"
              • "none"
            • CapacityReservationTarget — (map)

              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 — (map)

            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 — (Array<map>)

            The license configurations for the instance.

            • LicenseConfigurationArn — (String)

              The Amazon Resource Name (ARN) of the license configuration.

          • MetadataOptions — (map)

            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.

              Possible values include:
              • "pending"
              • "applied"
            • 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.

              Possible values include:
              • "optional"
              • "required"
            • 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.

              Possible values include:
              • "disabled"
              • "enabled"
            • HttpProtocolIpv6 — (String)

              Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

              Default: disabled

              Possible values include:
              • "disabled"
              • "enabled"
            • 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.

              Possible values include:
              • "disabled"
              • "enabled"
          • EnclaveOptions — (map)

            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.

            Possible values include:
            • "legacy-bios"
            • "uefi"
            • "uefi-preferred"
          • 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 — (Date)

            The time that the usage operation was last updated.

          • PrivateDnsNameOptions — (map)

            The options for the instance hostname.

            • HostnameType — (String)

              The type of hostname to assign to an instance.

              Possible values include:
              • "ip-name"
              • "resource-name"
            • 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 — (map)

            Provides information on the recovery and maintenance options of your instance.

            • AutoRecovery — (String)

              Provides information on the current automatic recovery behavior of your instance.

              Possible values include:
              • "disabled"
              • "default"
          • 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.

            Possible values include:
            • "legacy-bios"
            • "uefi"
        • 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).

        • ReservationId — (String)

          The ID of the reservation.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeInstanceStatus(params = {}, callback) ⇒ AWS.Request

Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.

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.

Service Reference:

Examples:

To describe the status of an instance


/* This example describes the current status of the specified instance. */

 var params = {
  InstanceIds: [
     "i-1234567890abcdef0"
  ]
 };
 ec2.describeInstanceStatus(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InstanceStatuses: [
       {
      AvailabilityZone: "us-east-1d", 
      InstanceId: "i-1234567890abcdef0", 
      InstanceState: {
       Code: 16, 
       Name: "running"
      }, 
      InstanceStatus: {
       Details: [
          {
         Name: "reachability", 
         Status: "passed"
        }
       ], 
       Status: "ok"
      }, 
      SystemStatus: {
       Details: [
          {
         Name: "reachability", 
         Status: "passed"
        }
       ], 
       Status: "ok"
      }
     }
    ]
   }
   */
 });

Calling the describeInstanceStatus operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludeAllInstances: true || false,
  InstanceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeInstanceStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      The filters.

      • availability-zone - The Availability Zone of the instance.

      • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

      • event.description - A description of the event.

      • event.instance-event-id - The ID of the event whose date and time you are modifying.

      • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

      • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

      • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

      • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

      • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

      • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

      • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

      • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

      • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

      • attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • InstanceIds — (Array<String>)

      The instance IDs.

      Default: Describes all your instances.

      Constraints: Maximum 100 explicitly specified instance IDs.

    • 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 action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • IncludeAllInstances — (Boolean)

      When true, includes the health status for all instances. When false, includes the health status for running instances only.

      Default: false

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceStatuses — (Array<map>)

        Information about the status of the instances.

        • AvailabilityZone — (String)

          The Availability Zone of the instance.

        • OutpostArn — (String)

          The Amazon Resource Name (ARN) of the Outpost.

        • Events — (Array<map>)

          Any scheduled events associated with the instance.

          • InstanceEventId — (String)

            The ID of the event.

          • Code — (String)

            The event code.

            Possible values include:
            • "instance-reboot"
            • "system-reboot"
            • "system-maintenance"
            • "instance-retirement"
            • "instance-stop"
          • 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 — (Date)

            The latest scheduled end time for the event.

          • NotBefore — (Date)

            The earliest scheduled start time for the event.

          • NotBeforeDeadline — (Date)

            The deadline for starting the event.

        • InstanceId — (String)

          The ID of the instance.

        • InstanceState — (map)

          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 28 and (216)-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 20 and (28)-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 28 or 256 in decimal.

          • Name — (String)

            The current state of the instance.

            Possible values include:
            • "pending"
            • "running"
            • "shutting-down"
            • "terminated"
            • "stopping"
            • "stopped"
        • InstanceStatus — (map)

          Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

          • Details — (Array<map>)

            The system instance health or application instance health.

            • ImpairedSince — (Date)

              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.

              Possible values include:
              • "reachability"
            • Status — (String)

              The status.

              Possible values include:
              • "passed"
              • "failed"
              • "insufficient-data"
              • "initializing"
          • Status — (String)

            The status.

            Possible values include:
            • "ok"
            • "impaired"
            • "insufficient-data"
            • "not-applicable"
            • "initializing"
        • SystemStatus — (map)

          Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

          • Details — (Array<map>)

            The system instance health or application instance health.

            • ImpairedSince — (Date)

              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.

              Possible values include:
              • "reachability"
            • Status — (String)

              The status.

              Possible values include:
              • "passed"
              • "failed"
              • "insufficient-data"
              • "initializing"
          • Status — (String)

            The status.

            Possible values include:
            • "ok"
            • "impaired"
            • "insufficient-data"
            • "not-applicable"
            • "initializing"
        • AttachedEbsStatus — (map)

          Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations.

          • Details — (Array<map>)

            Details about the attached EBS status check for an instance.

            • ImpairedSince — (Date)

              The date and time when the attached EBS status check failed.

            • Name — (String)

              The name of the attached EBS status check.

              Possible values include:
              • "reachability"
            • Status — (String)

              The result of the attached EBS status check.

              Possible values include:
              • "passed"
              • "failed"
              • "insufficient-data"
              • "initializing"
          • Status — (String)

            The current status.

            Possible values include:
            • "ok"
            • "impaired"
            • "insufficient-data"
            • "not-applicable"
            • "initializing"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeInstanceTopology(params = {}, callback) ⇒ AWS.Request

Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.

Limitations

  • Supported zones

    • Availability Zone

    • Local Zone

  • Supported instance types

    • hpc6a.48xlarge | hpc6id.32xlarge | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge

    • p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | p5.48xlarge

    • trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge

For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the describeInstanceTopology operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  GroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  InstanceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeInstanceTopology(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 can't specify this parameter and the instance IDs parameter in the same request.

      Default: 20

    • InstanceIds — (Array<String>)

      The instance IDs.

      Default: Describes all your instances.

      Constraints: Maximum 100 explicitly specified instance IDs.

    • GroupNames — (Array<String>)

      The name of the placement group that each instance is in.

      Constraints: Maximum 100 explicitly specified placement group names.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Instances — (Array<map>)

        Information about the topology of each instance.

        • InstanceId — (String)

          The instance ID.

        • InstanceType — (String)

          The instance type.

        • GroupName — (String)

          The name of the placement group that the instance is in.

        • NetworkNodes — (Array<String>)

          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.

        • 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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInstanceTypeOfferings(params = {}, callback) ⇒ AWS.Request

Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.

Service Reference:

Examples:

Calling the describeInstanceTypeOfferings operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LocationType: region | availability-zone | availability-zone-id | outpost,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeInstanceTypeOfferings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • LocationType — (String)

      The location type.

      • availability-zone - The Availability Zone. When you specify a location filter, it must be an Availability Zone for the current Region.

      • availability-zone-id - The AZ ID. When you specify a location filter, it must be an AZ ID for the current Region.

      • outpost - The Outpost ARN. When you specify a location filter, it must be an Outpost ARN for the current Region.

      • region - The current Region. If you specify a location filter, it must match the current Region.

      Possible values include:
      • "region"
      • "availability-zone"
      • "availability-zone-id"
      • "outpost"
    • Filters — (Array<map>)

      One or more filters. Filter names and values are case-sensitive.

      • instance-type - The instance type. For a list of possible values, see Instance.

      • location - The location. For a list of possible identifiers, see Regions and Zones.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceTypeOfferings — (Array<map>)

        The instance types offered in the location.

        • InstanceType — (String)

          The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

          Possible values include:
          • "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"
        • LocationType — (String)

          The location type.

          Possible values include:
          • "region"
          • "availability-zone"
          • "availability-zone-id"
          • "outpost"
        • Location — (String)

          The identifier for the location. This depends on the location type. For example, if the location type is region, the location is the Region code (for example, us-east-2.)

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInstanceTypes(params = {}, callback) ⇒ AWS.Request

Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.

Service Reference:

Examples:

Calling the describeInstanceTypes operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  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,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeInstanceTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The instance types.

    • Filters — (Array<map>)

      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).

      • 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 - Indicates whether the instance type is eligible to use in the 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.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.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).

      • 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).

      • 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".

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceTypes — (Array<map>)

        The instance type.

        • InstanceType — (String)

          The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

          Possible values include:
          • "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"
        • CurrentGeneration — (Boolean)

          Indicates whether the instance type is current generation.

        • FreeTierEligible — (Boolean)

          Indicates whether the instance type is eligible for the free tier.

        • SupportedUsageClasses — (Array<String>)

          Indicates whether the instance type is offered for spot or On-Demand.

        • SupportedRootDeviceTypes — (Array<String>)

          The supported root device types.

        • SupportedVirtualizationTypes — (Array<String>)

          The supported virtualization types.

        • BareMetal — (Boolean)

          Indicates whether the instance is a bare metal instance type.

        • Hypervisor — (String)

          The hypervisor for the instance type.

          Possible values include:
          • "nitro"
          • "xen"
        • ProcessorInfo — (map)

          Describes the processor.

          • SupportedArchitectures — (Array<String>)

            The architectures supported by the instance type.

          • SustainedClockSpeedInGhz — (Float)

            The speed of the processor, in GHz.

          • SupportedFeatures — (Array<String>)

            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.

          • Manufacturer — (String)

            The manufacturer of the processor.

        • VCpuInfo — (map)

          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 — (Array<Integer>)

            The valid number of cores that can be configured for the instance type.

          • ValidThreadsPerCore — (Array<Integer>)

            The valid number of threads per core that can be configured for the instance type.

        • MemoryInfo — (map)

          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 — (map)

          Describes the instance storage for the instance type.

          • TotalSizeInGB — (Integer)

            The total size of the disks, in GB.

          • Disks — (Array<map>)

            Describes the disks that are available for the instance type.

            • SizeInGB — (Integer)

              The size of the disk in GB.

            • Count — (Integer)

              The number of disks with this configuration.

            • Type — (String)

              The type of disk.

              Possible values include:
              • "hdd"
              • "ssd"
          • NvmeSupport — (String)

            Indicates whether non-volatile memory express (NVMe) is supported.

            Possible values include:
            • "unsupported"
            • "supported"
            • "required"
          • EncryptionSupport — (String)

            Indicates whether data is encrypted at rest.

            Possible values include:
            • "unsupported"
            • "required"
        • EbsInfo — (map)

          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.

            Possible values include:
            • "unsupported"
            • "supported"
            • "default"
          • EncryptionSupport — (String)

            Indicates whether Amazon EBS encryption is supported.

            Possible values include:
            • "unsupported"
            • "supported"
          • EbsOptimizedInfo — (map)

            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.

            Possible values include:
            • "unsupported"
            • "supported"
            • "required"
        • NetworkInfo — (map)

          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 — (Array<map>)

            Describes the network cards for 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.

          • 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.

            Possible values include:
            • "unsupported"
            • "supported"
            • "required"
          • EfaSupported — (Boolean)

            Indicates whether Elastic Fabric Adapter (EFA) is supported.

          • EfaInfo — (map)

            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.

        • GpuInfo — (map)

          Describes the GPU accelerator settings for the instance type.

          • Gpus — (Array<map>)

            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 — (map)

              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 — (map)

          Describes the FPGA accelerator settings for the instance type.

          • Fpgas — (Array<map>)

            Describes the FPGAs 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 — (map)

              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 — (map)

          Describes the placement group settings for the instance type.

          • SupportedStrategies — (Array<String>)

            The supported placement group types.

        • InferenceAcceleratorInfo — (map)

          Describes the Inference accelerator settings for the instance type.

          • Accelerators — (Array<map>)

            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 — (map)

              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 — (Array<String>)

          The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.

        • NitroEnclavesSupport — (String)

          Indicates whether Nitro Enclaves is supported.

          Possible values include:
          • "unsupported"
          • "supported"
        • NitroTpmSupport — (String)

          Indicates whether NitroTPM is supported.

          Possible values include:
          • "unsupported"
          • "supported"
        • NitroTpmInfo — (map)

          Describes the supported NitroTPM versions for the instance type.

          • SupportedVersions — (Array<String>)

            Indicates the supported NitroTPM versions.

        • MediaAcceleratorInfo — (map)

          Describes the media accelerator settings for the instance type.

          • Accelerators — (Array<map>)

            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 — (map)

              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 — (map)

          Describes the Neuron accelerator settings for the instance type.

          • NeuronDevices — (Array<map>)

            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 — (map)

              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 — (map)

              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.

          Possible values include:
          • "unsupported"
          • "supported"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInternetGateways(params = {}, callback) ⇒ AWS.Request

Describes your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria.

Service Reference:

Examples:

To describe the Internet gateway for a VPC


/* This example describes the Internet gateway for the specified VPC. */

 var params = {
  Filters: [
     {
    Name: "attachment.vpc-id", 
    Values: [
       "vpc-a01106c2"
    ]
   }
  ]
 };
 ec2.describeInternetGateways(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InternetGateways: [
       {
      Attachments: [
         {
        State: "attached", 
        VpcId: "vpc-a01106c2"
       }
      ], 
      InternetGatewayId: "igw-c0a643a9", 
      Tags: [
      ]
     }
    ]
   }
   */
 });

Calling the describeInternetGateways operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  InternetGatewayIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeInternetGateways(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the internet gateways.

      Default: Describes all your internet gateways.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InternetGateways — (Array<map>)

        Information about the internet gateways.

        • Attachments — (Array<map>)

          Any VPCs attached to the 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.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • VpcId — (String)

            The ID of the VPC.

        • InternetGatewayId — (String)

          The ID of the internet gateway.

        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the internet gateway.

        • Tags — (Array<map>)

          Any tags assigned to the internet gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 include in another request to get the next page of items. This value is null when there are no more items to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeIpamByoasn(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeIpamByoasn operation

var params = {
  DryRun: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeIpamByoasn(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Byoasns — (Array<map>)

        ASN and BYOIP CIDR associations.

        • 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.

          Possible values include:
          • "deprovisioned"
          • "failed-deprovision"
          • "failed-provision"
          • "pending-deprovision"
          • "pending-provision"
          • "provisioned"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIpamExternalResourceVerificationTokens(params = {}, callback) ⇒ AWS.Request

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).

Service Reference:

Examples:

Calling the describeIpamExternalResourceVerificationTokens operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IpamExternalResourceVerificationTokenIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeIpamExternalResourceVerificationTokens(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 — (Array<map>)

      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

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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 — (Array<String>)

      Verification token IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Verification tokens.

        • 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 — (Date)

          Token expiration.

        • Status — (String)

          Token status.

          Possible values include:
          • "valid"
          • "expired"
        • Tags — (Array<map>)

          Token tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "create-in-progress"
          • "create-complete"
          • "create-failed"
          • "delete-in-progress"
          • "delete-complete"
          • "delete-failed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIpamPools(params = {}, callback) ⇒ AWS.Request

Get information about your IPAM pools.

Service Reference:

Examples:

Calling the describeIpamPools operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IpamPoolIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeIpamPools(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 — (Array<map>)

      One or more filters for the request. For more information about filtering, see Filtering CLI output.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • MaxResults — (Integer)

      The maximum number of results to return in the request.

    • NextToken — (String)

      The token for the next page of results.

    • IpamPoolIds — (Array<String>)

      The IDs of the IPAM pools you would like information on.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

      • IpamPools — (Array<map>)

        Information about the IPAM pools.

        • 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.

          Possible values include:
          • "public"
          • "private"
        • 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.

          Possible values include:
          • "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)

          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.

          Possible values include:
          • "ipv4"
          • "ipv6"
        • 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 — (Array<map>)

          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.

          • 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 — (Array<map>)

          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 the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "ec2"
        • 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.

          Possible values include:
          • "amazon"
          • "byoip"
        • SourceResource — (map)

          The resource used to provision CIDRs to a resource planning pool.

          • ResourceId — (String)

            The source resource ID.

          • ResourceType — (String)

            The source resource type.

            Possible values include:
            • "vpc"
          • ResourceRegion — (String)

            The source resource Region.

          • ResourceOwner — (String)

            The source resource owner.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIpamResourceDiscoveries(params = {}, callback) ⇒ AWS.Request

Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Service Reference:

Examples:

Calling the describeIpamResourceDiscoveries operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IpamResourceDiscoveryIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeIpamResourceDiscoveries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 — (Array<String>)

      The IPAM resource discovery IDs.

    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of resource discoveries to return in one page of results.

    • Filters — (Array<map>)

      The resource discovery filters.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamResourceDiscoveries — (Array<map>)

        The resource discoveries.

        • 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 — (Array<map>)

          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.

          • 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.

          Possible values include:
          • "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 — (Array<map>)

          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.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIpamResourceDiscoveryAssociations(params = {}, callback) ⇒ AWS.Request

Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..

Service Reference:

Examples:

Calling the describeIpamResourceDiscoveryAssociations operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IpamResourceDiscoveryAssociationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeIpamResourceDiscoveryAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 — (Array<String>)

      The resource discovery association IDs.

    • 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 — (Array<map>)

      The resource discovery association filters.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IpamResourceDiscoveryAssociations — (Array<map>)

        The resource discovery associations.

        • 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.

          Possible values include:
          • "active"
          • "not-found"
        • 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.

          Possible values include:
          • "associate-in-progress"
          • "associate-complete"
          • "associate-failed"
          • "disassociate-in-progress"
          • "disassociate-complete"
          • "disassociate-failed"
          • "isolate-in-progress"
          • "isolate-complete"
          • "restore-in-progress"
        • Tags — (Array<map>)

          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.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIpams(params = {}, callback) ⇒ AWS.Request

Get information about your IPAM pools.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

Service Reference:

Examples:

Calling the describeIpams operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IpamIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeIpams(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 — (Array<map>)

      One or more filters for the request. For more information about filtering, see Filtering CLI output.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • MaxResults — (Integer)

      The maximum number of results to return in the request.

    • NextToken — (String)

      The token for the next page of results.

    • IpamIds — (Array<String>)

      The IDs of the IPAMs you want information on.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Information about the IPAMs.

        • 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 — (Array<map>)

          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.

          Possible values include:
          • "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 — (Array<map>)

          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 the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "free"
          • "advanced"
        • EnablePrivateGua — (Boolean)

          Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIpamScopes(params = {}, callback) ⇒ AWS.Request

Get information about your IPAM scopes.

Service Reference:

Examples:

Calling the describeIpamScopes operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IpamScopeIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeIpamScopes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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 — (Array<map>)

      One or more filters for the request. For more information about filtering, see Filtering CLI output.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • MaxResults — (Integer)

      The maximum number of results to return in the request.

    • NextToken — (String)

      The token for the next page of results.

    • IpamScopeIds — (Array<String>)

      The IDs of the scopes you want information on.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

      • IpamScopes — (Array<map>)

        The scopes you want information on.

        • 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.

          Possible values include:
          • "public"
          • "private"
        • 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.

          Possible values include:
          • "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 — (Array<map>)

          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 the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeIpv6Pools(params = {}, callback) ⇒ AWS.Request

Describes your IPv6 address pools.

Service Reference:

Examples:

Calling the describeIpv6Pools operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PoolIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeIpv6Pools(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PoolIds — (Array<String>)

      The IDs of the IPv6 address pools.

    • 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 — (Array<map>)

      One or more filters.

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Ipv6Pools — (Array<map>)

        Information about the IPv6 address pools.

        • PoolId — (String)

          The ID of the address pool.

        • Description — (String)

          The description for the address pool.

        • PoolCidrBlocks — (Array<map>)

          The CIDR blocks for the address pool.

          • Cidr — (String)

            The CIDR block.

        • Tags — (Array<map>)

          Any tags for the address pool.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeKeyPairs(params = {}, callback) ⇒ AWS.Request

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

Service Reference:

Examples:

To display a key pair


/* This example displays the fingerprint for the specified key. */

 var params = {
  KeyNames: [
     "my-key-pair"
  ]
 };
 ec2.describeKeyPairs(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
     }
    ]
   }
   */
 });

Calling the describeKeyPairs operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludePublicKey: true || false,
  KeyNames: [
    'STRING_VALUE',
    /* more items */
  ],
  KeyPairIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeKeyPairs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      The filters.

      • key-pair-id - The ID of the key pair.

      • fingerprint - The fingerprint of the key pair.

      • key-name - The name of the key pair.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • KeyNames — (Array<String>)

      The key pair names.

      Default: Describes all of your key pairs.

    • KeyPairIds — (Array<String>)

      The IDs of the key pairs.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • IncludePublicKey — (Boolean)

      If true, the public key material is included in the response.

      Default: false

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyPairs — (Array<map>)

        Information about the key pairs.

        • KeyPairId — (String)

          The ID 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.

        • KeyName — (String)

          The name of the key pair.

        • KeyType — (String)

          The type of key pair.

          Possible values include:
          • "rsa"
          • "ed25519"
        • Tags — (Array<map>)

          Any tags applied to the key pair.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Date)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeLaunchTemplates(params = {}, callback) ⇒ AWS.Request

Describes one or more launch templates.

Service Reference:

Examples:

To describe a launch template


/* This example describes the specified launch template. */

 var params = {
  LaunchTemplateIds: [
     "lt-01238c059e3466abc"
  ]
 };
 ec2.describeLaunchTemplates(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LaunchTemplates: [
       {
      CreateTime: <Date Representation>, 
      CreatedBy: "arn:aws:iam::123456789012:root", 
      DefaultVersionNumber: 1, 
      LatestVersionNumber: 1, 
      LaunchTemplateId: "lt-01238c059e3466abc", 
      LaunchTemplateName: "my-template"
     }
    ]
   }
   */
 });

Calling the describeLaunchTemplates operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LaunchTemplateIds: [
    'STRING_VALUE',
    /* more items */
  ],
  LaunchTemplateNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeLaunchTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      One or more launch template IDs.

    • LaunchTemplateNames — (Array<String>)

      One or more launch template names.

    • Filters — (Array<map>)

      One or more filters.

      • create-time - The time the launch template was created.

      • launch-template-name - The name of the launch template.

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LaunchTemplates — (Array<map>)

        Information about the launch templates.

        • LaunchTemplateId — (String)

          The ID of the launch template.

        • LaunchTemplateName — (String)

          The name of the launch template.

        • CreateTime — (Date)

          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 — (Array<map>)

          The tags for the launch template.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLaunchTemplateVersions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe the versions for a launch template


/* This example describes the versions for the specified launch template. */

 var params = {
  LaunchTemplateId: "068f72b72934aff71"
 };
 ec2.describeLaunchTemplateVersions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LaunchTemplateVersions: [
       {
      CreateTime: <Date Representation>, 
      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: <Date Representation>, 
      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
     }
    ]
   }
   */
 });

Calling the describeLaunchTemplateVersions operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LaunchTemplateId: 'STRING_VALUE',
  LaunchTemplateName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  MaxVersion: 'STRING_VALUE',
  MinVersion: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  ResolveAlias: true || false,
  Versions: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeLaunchTemplateVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      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.

    • 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 — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LaunchTemplateVersions — (Array<map>)

        Information about the launch template versions.

        • 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 — (Date)

          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 — (map)

          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 — (map)

            The IAM instance profile.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the instance profile.

            • Name — (String)

              The name of the instance profile.

          • BlockDeviceMappings — (Array<map>)

            The block device mappings.

            • DeviceName — (String)

              The device name.

            • VirtualName — (String)

              The virtual device name (ephemeralN).

            • Ebs — (map)

              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)

                The ARN of the Key Management Service (KMS) CMK used for encryption.

              • SnapshotId — (String)

                The ID of the snapshot.

              • VolumeSize — (Integer)

                The size of the volume, in GiB.

              • VolumeType — (String)

                The volume type.

                Possible values include:
                • "standard"
                • "io1"
                • "io2"
                • "gp2"
                • "sc1"
                • "st1"
                • "gp3"
              • Throughput — (Integer)

                The throughput that the volume supports, in MiB/s.

            • NoDevice — (String)

              To omit the device from the block device mapping, specify an empty string.

          • NetworkInterfaces — (Array<map>)

            The network interfaces.

            • 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 addresses 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 — (Array<String>)

              The IDs of one or more security groups.

            • InterfaceType — (String)

              The type of network interface.

            • Ipv6AddressCount — (Integer)

              The number of IPv6 addresses for the network interface.

            • Ipv6Addresses — (Array<map>)

              The IPv6 addresses for the network interface.

              • 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 — (Array<map>)

              One or more private IPv4 addresses.

              • 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 — (Array<map>)

              One or more IPv4 prefixes assigned to the 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 — (Array<map>)

              One or more IPv6 prefixes assigned to the 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 — (map)

              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 — (map)

                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 — (map)

              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.

          • 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.

            Possible values include:
            • "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"
          • KeyName — (String)

            The name of the key pair.

          • Monitoring — (map)

            The monitoring for the instance.

            • Enabled — (Boolean)

              Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

          • Placement — (map)

            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.

              Possible values include:
              • "default"
              • "dedicated"
              • "host"
            • 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).

            Possible values include:
            • "stop"
            • "terminate"
          • UserData — (String)

            The user data for the instance.

          • TagSpecifications — (Array<map>)

            The tags that are applied to the resources that are created during instance launch.

            • ResourceType — (String)

              The type of resource to tag.

              Possible values include:
              • "capacity-reservation"
              • "client-vpn-endpoint"
              • "customer-gateway"
              • "carrier-gateway"
              • "coip-pool"
              • "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"
              • "placement-group"
              • "prefix-list"
              • "replace-root-volume-task"
              • "reserved-instances"
              • "route-table"
              • "security-group"
              • "security-group-rule"
              • "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"
              • "ipam-resource-discovery"
              • "ipam-resource-discovery-association"
              • "instance-connect-endpoint"
              • "ipam-external-resource-verification-token"
            • Tags — (Array<map>)

              The tags for the resource.

              • Key — (String)

                The key of the tag.

                Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Array<map>)

            Deprecated.

            Note: Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
            • Type — (String)

              Deprecated.

              Note: Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
          • ElasticInferenceAccelerators — (Array<map>)

            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.

            Note: Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
            • 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 — (Array<String>)

            The security group IDs.

          • SecurityGroups — (Array<String>)

            The security group names.

          • InstanceMarketOptions — (map)

            The market (purchasing) option for the instances.

            • MarketType — (String)

              The market type.

              Possible values include:
              • "spot"
              • "capacity-block"
            • SpotOptions — (map)

              The options for Spot Instances.

              • MaxPrice — (String)

                The maximum hourly price you're willing to pay for the Spot Instances. 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 specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

              • SpotInstanceType — (String)

                The Spot Instance request type.

                Possible values include:
                • "one-time"
                • "persistent"
              • 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 — (Date)

                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.

                Possible values include:
                • "hibernate"
                • "stop"
                • "terminate"
          • CreditSpecification — (map)

            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 — (map)

            The CPU options for the instance. For more information, see Optimize CPU options 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.

              Possible values include:
              • "enabled"
              • "disabled"
          • CapacityReservationSpecification — (map)

            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.

              Possible values include:
              • "open"
              • "none"
            • CapacityReservationTarget — (map)

              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 — (Array<map>)

            The license configurations.

            • LicenseConfigurationArn — (String)

              The Amazon Resource Name (ARN) of the license configuration.

          • HibernationOptions — (map)

            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 — (map)

            The metadata options for the instance. For more information, see Instance metadata and user data 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.

              Possible values include:
              • "pending"
              • "applied"
            • 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.

              Possible values include:
              • "optional"
              • "required"
            • 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.
              Possible values include:
              • "disabled"
              • "enabled"
            • HttpProtocolIpv6 — (String)

              Enables or disables the IPv6 endpoint for the instance metadata service.

              Default: disabled

              Possible values include:
              • "disabled"
              • "enabled"
            • 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.

              Default: disabled

              Possible values include:
              • "disabled"
              • "enabled"
          • EnclaveOptions — (map)

            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 — (map)

            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 — (map)

              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 — (map)

              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 — (Array<String>)

              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.

              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

            • MemoryGiBPerVCpu — (map)

              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 — (Array<String>)

              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

            • InstanceGenerations — (Array<String>)

              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

            • 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

              Possible values include:
              • "included"
              • "required"
              • "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

              Possible values include:
              • "included"
              • "required"
              • "excluded"
            • RequireHibernateSupport — (Boolean)

              Indicates whether instance types must support hibernation for On-Demand Instances.

              This parameter is not supported for GetSpotPlacementScores.

              Default: false

            • NetworkInterfaceCount — (map)

              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

              Possible values include:
              • "included"
              • "required"
              • "excluded"
            • LocalStorageTypes — (Array<String>)

              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

            • TotalLocalStorageGB — (map)

              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 — (map)

              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 — (Array<String>)

              The accelerator types that must be on the instance type.

              • For instance types with GPU accelerators, specify gpu.

              • For instance types with FPGA accelerators, specify fpga.

              • For instance types with inference accelerators, specify inference.

              Default: Any accelerator type

            • AcceleratorCount — (map)

              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 — (Array<String>)

              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

            • AcceleratorNames — (Array<String>)

              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

            • AcceleratorTotalMemoryMiB — (map)

              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 — (map)

              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 — (Array<String>)

              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

            • 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.
          • PrivateDnsNameOptions — (map)

            The options for the instance hostname.

            • HostnameType — (String)

              The type of hostname to assign to an instance.

              Possible values include:
              • "ip-name"
              • "resource-name"
            • 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 — (map)

            The maintenance options for your instance.

            • AutoRecovery — (String)

              Disables the automatic recovery behavior of your instance or sets it to default.

              Possible values include:
              • "default"
              • "disabled"
          • DisableApiStop — (Boolean)

            Indicates whether the instance is enabled for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLocalGatewayRouteTables(params = {}, callback) ⇒ AWS.Request

Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.

Service Reference:

Examples:

Calling the describeLocalGatewayRouteTables operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LocalGatewayRouteTableIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeLocalGatewayRouteTables(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableIds — (Array<String>)

      The IDs of the local gateway route tables.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTables — (Array<map>)

        Information about the local gateway route tables.

        • 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 — (Array<map>)

          The tags assigned to the local gateway route table.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "direct-vpc-routing"
          • "coip"
        • StateReason — (map)

          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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations(params = {}, callback) ⇒ AWS.Request

Describes the associations between virtual interface groups and local gateway route tables.

Service Reference:

Examples:

Calling the describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds — (Array<String>)

      The IDs of the associations.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTableVirtualInterfaceGroupAssociations — (Array<map>)

        Information about the associations.

        • LocalGatewayRouteTableVirtualInterfaceGroupAssociationId — (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 — (Array<map>)

          The tags assigned to the association.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLocalGatewayRouteTableVpcAssociations(params = {}, callback) ⇒ AWS.Request

Describes the specified associations between VPCs and local gateway route tables.

Service Reference:

Examples:

Calling the describeLocalGatewayRouteTableVpcAssociations operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LocalGatewayRouteTableVpcAssociationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeLocalGatewayRouteTableVpcAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayRouteTableVpcAssociationIds — (Array<String>)

      The IDs of the associations.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayRouteTableVpcAssociations — (Array<map>)

        Information about the associations.

        • 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 — (Array<map>)

          The tags assigned to the association.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLocalGateways(params = {}, callback) ⇒ AWS.Request

Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.

Service Reference:

Examples:

Calling the describeLocalGateways operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LocalGatewayIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeLocalGateways(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayIds — (Array<String>)

      The IDs of the local gateways.

    • Filters — (Array<map>)

      One or more filters.

      • local-gateway-id - The ID of a local gateway.

      • 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.

      • state - The state of the association.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGateways — (Array<map>)

        Information about the local gateways.

        • 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.

        • State — (String)

          The state of the local gateway.

        • Tags — (Array<map>)

          The tags assigned to the local gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLocalGatewayVirtualInterfaceGroups(params = {}, callback) ⇒ AWS.Request

Describes the specified local gateway virtual interface groups.

Service Reference:

Examples:

Calling the describeLocalGatewayVirtualInterfaceGroups operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LocalGatewayVirtualInterfaceGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeLocalGatewayVirtualInterfaceGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayVirtualInterfaceGroupIds — (Array<String>)

      The IDs of the virtual interface groups.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayVirtualInterfaceGroups — (Array<map>)

        The virtual interface groups.

        • LocalGatewayVirtualInterfaceGroupId — (String)

          The ID of the virtual interface group.

        • LocalGatewayVirtualInterfaceIds — (Array<String>)

          The IDs of the virtual interfaces.

        • 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.

        • Tags — (Array<map>)

          The tags assigned to the virtual interface group.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLocalGatewayVirtualInterfaces(params = {}, callback) ⇒ AWS.Request

Describes the specified local gateway virtual interfaces.

Service Reference:

Examples:

Calling the describeLocalGatewayVirtualInterfaces operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LocalGatewayVirtualInterfaceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeLocalGatewayVirtualInterfaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LocalGatewayVirtualInterfaceIds — (Array<String>)

      The IDs of the virtual interfaces.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocalGatewayVirtualInterfaces — (Array<map>)

        Information about the virtual interfaces.

        • LocalGatewayVirtualInterfaceId — (String)

          The ID of the virtual interface.

        • LocalGatewayId — (String)

          The ID of the local gateway.

        • 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.

        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the local gateway virtual interface.

        • Tags — (Array<map>)

          The tags assigned to the virtual interface.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLockedSnapshots(params = {}, callback) ⇒ AWS.Request

Describes the lock status for a snapshot.

Service Reference:

Examples:

Calling the describeLockedSnapshots operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SnapshotIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeLockedSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      The filters.

      • lock-state - The state of the snapshot lock (compliance-cooloff | governance | compliance | expired).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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 — (Array<String>)

      The IDs of the snapshots for which to view the lock status.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshots — (Array<map>)

        Information about the snapshots.

        • 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.

          Possible values include:
          • "compliance"
          • "governance"
          • "compliance-cooloff"
          • "expired"
        • 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 — (Date)

          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 — (Date)

          The date and time at which the snapshot was locked, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

        • LockDurationStartTime — (Date)

          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 — (Date)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeMacHosts(params = {}, callback) ⇒ AWS.Request

Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.

Service Reference:

Examples:

Calling the describeMacHosts operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  HostIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeMacHosts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • HostIds — (Array<String>)

      The IDs of the EC2 Mac Dedicated Hosts.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MacHosts — (Array<map>)

        Information about the EC2 Mac Dedicated Hosts.

        • HostId — (String)

          The EC2 Mac Dedicated Host ID.

        • MacOSLatestSupportedVersions — (Array<String>)

          The latest macOS versions that the EC2 Mac Dedicated Host can launch without being upgraded.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeManagedPrefixLists(params = {}, callback) ⇒ AWS.Request

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

To view the entries for your prefix list, use GetManagedPrefixListEntries.

Service Reference:

Examples:

Calling the describeManagedPrefixLists operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PrefixListIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeManagedPrefixLists(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

    • PrefixListIds — (Array<String>)

      One or more prefix list IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

      • PrefixLists — (Array<map>)

        Information about the prefix lists.

        • PrefixListId — (String)

          The ID of the prefix list.

        • AddressFamily — (String)

          The IP address version.

        • State — (String)

          The current state of the prefix list.

          Possible values include:
          • "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)

          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 — (Array<map>)

          The tags for the prefix list.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeMovingAddresses(params = {}, callback) ⇒ AWS.Request

Note: This action is deprecated.

Describes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

Service Reference:

Examples:

To describe your moving addresses


/* This example describes all of your moving Elastic IP addresses. */

 var params = {
 };
 ec2.describeMovingAddresses(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    MovingAddressStatuses: [
       {
      MoveStatus: "movingToVpc", 
      PublicIp: "198.51.100.0"
     }
    ]
   }
   */
 });

Calling the describeMovingAddresses operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PublicIps: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeMovingAddresses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      One or more filters.

      • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

      Default: If no value is provided, the default is 1000.

    • NextToken — (String)

      The token for the next page of results.

    • PublicIps — (Array<String>)

      One or more Elastic IP addresses.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MovingAddressStatuses — (Array<map>)

        The status for each Elastic IP address.

        • MoveStatus — (String)

          The status of the Elastic IP address that's being moved or restored.

          Possible values include:
          • "movingToVpc"
          • "restoringToClassic"
        • PublicIp — (String)

          The Elastic IP address.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNatGateways(params = {}, callback) ⇒ AWS.Request

Describes your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria.

Service Reference:

Examples:

To describe a NAT gateway


/* This example describes the NAT gateway for the specified VPC. */

 var params = {
  Filter: [
     {
    Name: "vpc-id", 
    Values: [
       "vpc-1a2b3c4d"
    ]
   }
  ]
 };
 ec2.describeNatGateways(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NatGateways: [
       {
      CreateTime: <Date Representation>, 
      NatGatewayAddresses: [
         {
        AllocationId: "eipalloc-89c620ec", 
        NetworkInterfaceId: "eni-9dec76cd", 
        PrivateIp: "10.0.0.149", 
        PublicIp: "198.11.222.333"
       }
      ], 
      NatGatewayId: "nat-05dba92075d71c408", 
      State: "available", 
      SubnetId: "subnet-847e4dc2", 
      VpcId: "vpc-1a2b3c4d"
     }
    ]
   }
   */
 });

Calling the describeNatGateways operation

var params = {
  DryRun: true || false,
  Filter: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NatGatewayIds: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
ec2.describeNatGateways(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • Filter — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • vpc-id - The ID of the VPC in which the NAT gateway resides.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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 — (Array<String>)

      The IDs of the NAT gateways.

    • NextToken — (String)

      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NatGateways — (Array<map>)

        Information about the NAT gateways.

        • CreateTime — (Date)

          The date and time the NAT gateway was created.

        • DeleteTime — (Date)

          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 — (Array<map>)

          Information about the IP addresses and network interface associated with the 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.

            Possible values include:
            • "assigning"
            • "unassigning"
            • "associating"
            • "disassociating"
            • "succeeded"
            • "failed"
        • NatGatewayId — (String)

          The ID of the NAT gateway.

        • ProvisionedBandwidth — (map)

          Reserved. If you need to sustain traffic greater than the documented limits, contact Amazon Web Services Support.

          • ProvisionTime — (Date)

            Reserved.

          • Provisioned — (String)

            Reserved.

          • RequestTime — (Date)

            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.

          Possible values include:
          • "pending"
          • "failed"
          • "available"
          • "deleting"
          • "deleted"
        • 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 — (Array<map>)

          The tags for the NAT gateway.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "private"
          • "public"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeNetworkAcls(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe a network ACL


/* This example describes the specified network ACL. */

 var params = {
  NetworkAclIds: [
     "acl-5fb85d36"
  ]
 };
 ec2.describeNetworkAcls(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
     }
    ]
   }
   */
 });

Calling the describeNetworkAcls operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NetworkAclIds: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
ec2.describeNetworkAcls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • vpc-id - The ID of the VPC for the network ACL.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the network ACLs.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkAcls — (Array<map>)

        Information about the network ACLs.

        • Associations — (Array<map>)

          Any associations between the network ACL and your subnets

          • 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 — (Array<map>)

          The entries (rules) in the 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 — (map)

            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 — (map)

            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.

            Possible values include:
            • "allow"
            • "deny"
          • 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 — (Array<map>)

          Any tags assigned to the network ACL.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNetworkInsightsAccessScopeAnalyses(params = {}, callback) ⇒ AWS.Request

Describes the specified Network Access Scope analyses.

Service Reference:

Examples:

Calling the describeNetworkInsightsAccessScopeAnalyses operation

var params = {
  AnalysisStartTimeBegin: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  AnalysisStartTimeEnd: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NetworkInsightsAccessScopeAnalysisIds: [
    'STRING_VALUE',
    /* more items */
  ],
  NetworkInsightsAccessScopeId: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeNetworkInsightsAccessScopeAnalyses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInsightsAccessScopeAnalysisIds — (Array<String>)

      The IDs of the Network Access Scope analyses.

    • NetworkInsightsAccessScopeId — (String)

      The ID of the Network Access Scope.

    • AnalysisStartTimeBegin — (Date)

      Filters the results based on the start time. The analysis must have started on or after this time.

    • AnalysisStartTimeEnd — (Date)

      Filters the results based on the start time. The analysis must have started on or before this time.

    • Filters — (Array<map>)

      There are no supported filters.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsAccessScopeAnalyses — (Array<map>)

        The Network Access Scope analyses.

        • 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.

          Possible values include:
          • "running"
          • "succeeded"
          • "failed"
        • StatusMessage — (String)

          The status message.

        • WarningMessage — (String)

          The warning message.

        • StartDate — (Date)

          The analysis start date.

        • EndDate — (Date)

          The analysis end date.

        • FindingsFound — (String)

          Indicates whether there are findings.

          Possible values include:
          • "true"
          • "false"
          • "unknown"
        • AnalyzedEniCount — (Integer)

          The number of network interfaces analyzed.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNetworkInsightsAccessScopes(params = {}, callback) ⇒ AWS.Request

Describes the specified Network Access Scopes.

Service Reference:

Examples:

Calling the describeNetworkInsightsAccessScopes operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NetworkInsightsAccessScopeIds: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
ec2.describeNetworkInsightsAccessScopes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInsightsAccessScopeIds — (Array<String>)

      The IDs of the Network Access Scopes.

    • Filters — (Array<map>)

      There are no supported filters.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsAccessScopes — (Array<map>)

        The Network Access Scopes.

        • NetworkInsightsAccessScopeId — (String)

          The ID of the Network Access Scope.

        • NetworkInsightsAccessScopeArn — (String)

          The Amazon Resource Name (ARN) of the Network Access Scope.

        • CreatedDate — (Date)

          The creation date.

        • UpdatedDate — (Date)

          The last updated date.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNetworkInsightsAnalyses(params = {}, callback) ⇒ AWS.Request

Describes one or more of your network insights analyses.

Service Reference:

Examples:

Calling the describeNetworkInsightsAnalyses operation

var params = {
  AnalysisEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  AnalysisStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NetworkInsightsAnalysisIds: [
    'STRING_VALUE',
    /* more items */
  ],
  NetworkInsightsPathId: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeNetworkInsightsAnalyses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInsightsAnalysisIds — (Array<String>)

      The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

    • NetworkInsightsPathId — (String)

      The ID of the path. You must specify either a path ID or analysis IDs.

    • AnalysisStartTime — (Date)

      The time when the network insights analyses started.

    • AnalysisEndTime — (Date)

      The time when the network insights analyses ended.

    • Filters — (Array<map>)

      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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsAnalyses — (Array<map>)

        Information about the network insights analyses.

        • NetworkInsightsAnalysisId — (String)

          The ID of the network insights analysis.

        • NetworkInsightsAnalysisArn — (String)

          The Amazon Resource Name (ARN) of the network insights analysis.

        • NetworkInsightsPathId — (String)

          The ID of the path.

        • AdditionalAccounts — (Array<String>)

          The member accounts that contain resources that the path can traverse.

        • FilterInArns — (Array<String>)

          The Amazon Resource Names (ARN) of the resources that the path must traverse.

        • StartDate — (Date)

          The time the analysis started.

        • Status — (String)

          The status of the network insights analysis.

          Possible values include:
          • "running"
          • "succeeded"
          • "failed"
        • StatusMessage — (String)

          The status message, if the status is failed.

        • WarningMessage — (String)

          The warning message.

        • NetworkPathFound — (Boolean)

          Indicates whether the destination is reachable from the source.

        • ForwardPathComponents — (Array<map>)

          The components in the path from source to destination.

          • SequenceNumber — (Integer)

            The sequence number.

          • AclRule — (map)

            The network ACL rule.

            • Cidr — (String)

              The IPv4 address range, in CIDR notation.

            • Egress — (Boolean)

              Indicates whether the rule is an outbound rule.

            • PortRange — (map)

              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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            The outbound header.

            • DestinationAddresses — (Array<String>)

              The destination addresses.

            • DestinationPortRanges — (Array<map>)

              The destination port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • Protocol — (String)

              The protocol.

            • SourceAddresses — (Array<String>)

              The source addresses.

            • SourcePortRanges — (Array<map>)

              The source port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

          • InboundHeader — (map)

            The inbound header.

            • DestinationAddresses — (Array<String>)

              The destination addresses.

            • DestinationPortRanges — (Array<map>)

              The destination port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • Protocol — (String)

              The protocol.

            • SourceAddresses — (Array<String>)

              The source addresses.

            • SourcePortRanges — (Array<map>)

              The source port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

          • RouteTableRoute — (map)

            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 — (map)

            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 — (map)

              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 — (map)

            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 — (map)

            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 — (map)

            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 — (Array<map>)

            The additional details.

            • AdditionalDetailType — (String)

              The additional detail code.

            • Component — (map)

              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 — (map)

              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 — (Array<map>)

              The rule options.

              • Keyword — (String)

                The Suricata keyword.

              • Settings — (Array<String>)

                The settings for the keyword.

            • RuleGroupTypePairs — (Array<map>)

              The rule group type.

              • RuleGroupArn — (String)

                The ARN of the rule group.

              • RuleGroupType — (String)

                The rule group type. The possible values are Domain List and Suricata.

            • RuleGroupRuleOptionsPairs — (Array<map>)

              The rule options.

              • RuleGroupArn — (String)

                The ARN of the rule group.

              • RuleOptions — (Array<map>)

                The rule options.

                • Keyword — (String)

                  The Suricata keyword.

                • Settings — (Array<String>)

                  The settings for the keyword.

            • ServiceName — (String)

              The name of the VPC endpoint service.

            • LoadBalancers — (Array<map>)

              The load balancers.

              • 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 — (map)

            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 — (map)

            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 — (Array<map>)

            The explanation codes.

            • Acl — (map)

              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 — (map)

              The network ACL rule.

              • Cidr — (String)

                The IPv4 address range, in CIDR notation.

              • Egress — (Boolean)

                Indicates whether the rule is an outbound rule.

              • PortRange — (map)

                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 — (Array<String>)

              The IPv4 addresses, in CIDR notation.

            • AttachedTo — (map)

              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 — (Array<String>)

              The Availability Zones.

            • Cidrs — (Array<String>)

              The CIDR ranges.

            • Component — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              The target.

              • Address — (String)

                The IP address.

              • AvailabilityZone — (String)

                The Availability Zone.

              • Instance — (map)

                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 — (map)

              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 — (Array<map>)

              The target groups.

              • 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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (Array<map>)

              The port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • PrefixList — (map)

              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 — (Array<String>)

              The protocols.

            • RouteTableRoute — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

                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 — (Array<map>)

              The security groups.

              • 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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              The Network Firewall stateless rule.

              • RuleGroupArn — (String)

                The ARN of the stateless rule group.

              • Sources — (Array<String>)

                The source IP addresses, in CIDR notation.

              • Destinations — (Array<String>)

                The destination IP addresses, in CIDR notation.

              • SourcePorts — (Array<map>)

                The source ports.

                • From — (Integer)

                  The first port in the range.

                • To — (Integer)

                  The last port in the range.

              • DestinationPorts — (Array<map>)

                The destination ports.

                • From — (Integer)

                  The first port in the range.

                • To — (Integer)

                  The last port in the range.

              • Protocols — (Array<Integer>)

                The protocols.

              • RuleAction — (String)

                The rule action. The possible values are pass, drop, and forward_to_site.

              • Priority — (Integer)

                The rule priority.

            • FirewallStatefulRule — (map)

              The Network Firewall stateful rule.

              • RuleGroupArn — (String)

                The ARN of the stateful rule group.

              • Sources — (Array<String>)

                The source IP addresses, in CIDR notation.

              • Destinations — (Array<String>)

                The destination IP addresses, in CIDR notation.

              • SourcePorts — (Array<map>)

                The source ports.

                • From — (Integer)

                  The first port in the range.

                • To — (Integer)

                  The last port in the range.

              • DestinationPorts — (Array<map>)

                The destination 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 — (map)

            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 — (map)

            The Network Firewall stateless rule.

            • RuleGroupArn — (String)

              The ARN of the stateless rule group.

            • Sources — (Array<String>)

              The source IP addresses, in CIDR notation.

            • Destinations — (Array<String>)

              The destination IP addresses, in CIDR notation.

            • SourcePorts — (Array<map>)

              The source ports.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • DestinationPorts — (Array<map>)

              The destination ports.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • Protocols — (Array<Integer>)

              The protocols.

            • RuleAction — (String)

              The rule action. The possible values are pass, drop, and forward_to_site.

            • Priority — (Integer)

              The rule priority.

          • FirewallStatefulRule — (map)

            The Network Firewall stateful rule.

            • RuleGroupArn — (String)

              The ARN of the stateful rule group.

            • Sources — (Array<String>)

              The source IP addresses, in CIDR notation.

            • Destinations — (Array<String>)

              The destination IP addresses, in CIDR notation.

            • SourcePorts — (Array<map>)

              The source ports.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • DestinationPorts — (Array<map>)

              The destination 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.

        • ReturnPathComponents — (Array<map>)

          The components in the path from destination to source.

          • SequenceNumber — (Integer)

            The sequence number.

          • AclRule — (map)

            The network ACL rule.

            • Cidr — (String)

              The IPv4 address range, in CIDR notation.

            • Egress — (Boolean)

              Indicates whether the rule is an outbound rule.

            • PortRange — (map)

              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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            The outbound header.

            • DestinationAddresses — (Array<String>)

              The destination addresses.

            • DestinationPortRanges — (Array<map>)

              The destination port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • Protocol — (String)

              The protocol.

            • SourceAddresses — (Array<String>)

              The source addresses.

            • SourcePortRanges — (Array<map>)

              The source port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

          • InboundHeader — (map)

            The inbound header.

            • DestinationAddresses — (Array<String>)

              The destination addresses.

            • DestinationPortRanges — (Array<map>)

              The destination port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • Protocol — (String)

              The protocol.

            • SourceAddresses — (Array<String>)

              The source addresses.

            • SourcePortRanges — (Array<map>)

              The source port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

          • RouteTableRoute — (map)

            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 — (map)

            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 — (map)

              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 — (map)

            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 — (map)

            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 — (map)

            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 — (Array<map>)

            The additional details.

            • AdditionalDetailType — (String)

              The additional detail code.

            • Component — (map)

              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 — (map)

              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 — (Array<map>)

              The rule options.

              • Keyword — (String)

                The Suricata keyword.

              • Settings — (Array<String>)

                The settings for the keyword.

            • RuleGroupTypePairs — (Array<map>)

              The rule group type.

              • RuleGroupArn — (String)

                The ARN of the rule group.

              • RuleGroupType — (String)

                The rule group type. The possible values are Domain List and Suricata.

            • RuleGroupRuleOptionsPairs — (Array<map>)

              The rule options.

              • RuleGroupArn — (String)

                The ARN of the rule group.

              • RuleOptions — (Array<map>)

                The rule options.

                • Keyword — (String)

                  The Suricata keyword.

                • Settings — (Array<String>)

                  The settings for the keyword.

            • ServiceName — (String)

              The name of the VPC endpoint service.

            • LoadBalancers — (Array<map>)

              The load balancers.

              • 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 — (map)

            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 — (map)

            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 — (Array<map>)

            The explanation codes.

            • Acl — (map)

              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 — (map)

              The network ACL rule.

              • Cidr — (String)

                The IPv4 address range, in CIDR notation.

              • Egress — (Boolean)

                Indicates whether the rule is an outbound rule.

              • PortRange — (map)

                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 — (Array<String>)

              The IPv4 addresses, in CIDR notation.

            • AttachedTo — (map)

              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 — (Array<String>)

              The Availability Zones.

            • Cidrs — (Array<String>)

              The CIDR ranges.

            • Component — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              The target.

              • Address — (String)

                The IP address.

              • AvailabilityZone — (String)

                The Availability Zone.

              • Instance — (map)

                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 — (map)

              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 — (Array<map>)

              The target groups.

              • 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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (Array<map>)

              The port ranges.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • PrefixList — (map)

              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 — (Array<String>)

              The protocols.

            • RouteTableRoute — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

                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 — (Array<map>)

              The security groups.

              • 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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              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 — (map)

              The Network Firewall stateless rule.

              • RuleGroupArn — (String)

                The ARN of the stateless rule group.

              • Sources — (Array<String>)

                The source IP addresses, in CIDR notation.

              • Destinations — (Array<String>)

                The destination IP addresses, in CIDR notation.

              • SourcePorts — (Array<map>)

                The source ports.

                • From — (Integer)

                  The first port in the range.

                • To — (Integer)

                  The last port in the range.

              • DestinationPorts — (Array<map>)

                The destination ports.

                • From — (Integer)

                  The first port in the range.

                • To — (Integer)

                  The last port in the range.

              • Protocols — (Array<Integer>)

                The protocols.

              • RuleAction — (String)

                The rule action. The possible values are pass, drop, and forward_to_site.

              • Priority — (Integer)

                The rule priority.

            • FirewallStatefulRule — (map)

              The Network Firewall stateful rule.

              • RuleGroupArn — (String)

                The ARN of the stateful rule group.

              • Sources — (Array<String>)

                The source IP addresses, in CIDR notation.

              • Destinations — (Array<String>)

                The destination IP addresses, in CIDR notation.

              • SourcePorts — (Array<map>)

                The source ports.

                • From — (Integer)

                  The first port in the range.

                • To — (Integer)

                  The last port in the range.

              • DestinationPorts — (Array<map>)

                The destination 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 — (map)

            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 — (map)

            The Network Firewall stateless rule.

            • RuleGroupArn — (String)

              The ARN of the stateless rule group.

            • Sources — (Array<String>)

              The source IP addresses, in CIDR notation.

            • Destinations — (Array<String>)

              The destination IP addresses, in CIDR notation.

            • SourcePorts — (Array<map>)

              The source ports.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • DestinationPorts — (Array<map>)

              The destination ports.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • Protocols — (Array<Integer>)

              The protocols.

            • RuleAction — (String)

              The rule action. The possible values are pass, drop, and forward_to_site.

            • Priority — (Integer)

              The rule priority.

          • FirewallStatefulRule — (map)

            The Network Firewall stateful rule.

            • RuleGroupArn — (String)

              The ARN of the stateful rule group.

            • Sources — (Array<String>)

              The source IP addresses, in CIDR notation.

            • Destinations — (Array<String>)

              The destination IP addresses, in CIDR notation.

            • SourcePorts — (Array<map>)

              The source ports.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • DestinationPorts — (Array<map>)

              The destination 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.

        • Explanations — (Array<map>)

          The explanations. For more information, see Reachability Analyzer explanation codes.

          • Acl — (map)

            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 — (map)

            The network ACL rule.

            • Cidr — (String)

              The IPv4 address range, in CIDR notation.

            • Egress — (Boolean)

              Indicates whether the rule is an outbound rule.

            • PortRange — (map)

              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 — (Array<String>)

            The IPv4 addresses, in CIDR notation.

          • AttachedTo — (map)

            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 — (Array<String>)

            The Availability Zones.

          • Cidrs — (Array<String>)

            The CIDR ranges.

          • Component — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            The target.

            • Address — (String)

              The IP address.

            • AvailabilityZone — (String)

              The Availability Zone.

            • Instance — (map)

              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 — (map)

            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 — (Array<map>)

            The target groups.

            • 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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (Array<map>)

            The port ranges.

            • From — (Integer)

              The first port in the range.

            • To — (Integer)

              The last port in the range.

          • PrefixList — (map)

            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 — (Array<String>)

            The protocols.

          • RouteTableRoute — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

              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 — (Array<map>)

            The security groups.

            • 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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            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 — (map)

            The Network Firewall stateless rule.

            • RuleGroupArn — (String)

              The ARN of the stateless rule group.

            • Sources — (Array<String>)

              The source IP addresses, in CIDR notation.

            • Destinations — (Array<String>)

              The destination IP addresses, in CIDR notation.

            • SourcePorts — (Array<map>)

              The source ports.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • DestinationPorts — (Array<map>)

              The destination ports.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • Protocols — (Array<Integer>)

              The protocols.

            • RuleAction — (String)

              The rule action. The possible values are pass, drop, and forward_to_site.

            • Priority — (Integer)

              The rule priority.

          • FirewallStatefulRule — (map)

            The Network Firewall stateful rule.

            • RuleGroupArn — (String)

              The ARN of the stateful rule group.

            • Sources — (Array<String>)

              The source IP addresses, in CIDR notation.

            • Destinations — (Array<String>)

              The destination IP addresses, in CIDR notation.

            • SourcePorts — (Array<map>)

              The source ports.

              • From — (Integer)

                The first port in the range.

              • To — (Integer)

                The last port in the range.

            • DestinationPorts — (Array<map>)

              The destination 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.

        • AlternatePathHints — (Array<map>)

          Potential intermediate components.

          • ComponentId — (String)

            The ID of the component.

          • ComponentArn — (String)

            The Amazon Resource Name (ARN) of the component.

        • SuggestedAccounts — (Array<String>)

          Potential intermediate accounts.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNetworkInsightsPaths(params = {}, callback) ⇒ AWS.Request

Describes one or more of your paths.

Service Reference:

Examples:

Calling the describeNetworkInsightsPaths operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NetworkInsightsPathIds: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
ec2.describeNetworkInsightsPaths(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInsightsPathIds — (Array<String>)

      The IDs of the paths.

    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInsightsPaths — (Array<map>)

        Information about the paths.

        • NetworkInsightsPathId — (String)

          The ID of the path.

        • NetworkInsightsPathArn — (String)

          The Amazon Resource Name (ARN) of the path.

        • CreatedDate — (Date)

          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.

          Possible values include:
          • "tcp"
          • "udp"
        • DestinationPort — (Integer)

          The destination port.

        • Tags — (Array<map>)

          The tags associated with the path.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (map)

          Scopes the analysis to network paths that match specific filters at the source.

          • SourceAddress — (String)

            The source IPv4 address.

          • SourcePortRange — (map)

            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 — (map)

            The destination port range.

            • FromPort — (Integer)

              The first port in the range.

            • ToPort — (Integer)

              The last port in the range.

        • FilterAtDestination — (map)

          Scopes the analysis to network paths that match specific filters at the destination.

          • SourceAddress — (String)

            The source IPv4 address.

          • SourcePortRange — (map)

            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 — (map)

            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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNetworkInterfaceAttribute(params = {}, callback) ⇒ AWS.Request

Describes a network interface attribute. You can specify only one attribute at a time.

Service Reference:

Examples:

To describe the attachment attribute of a network interface


/* This example describes the attachment attribute of the specified network interface. */

 var params = {
  Attribute: "attachment", 
  NetworkInterfaceId: "eni-686ea200"
 };
 ec2.describeNetworkInterfaceAttribute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Attachment: {
     AttachTime: <Date Representation>, 
     AttachmentId: "eni-attach-43348162", 
     DeleteOnTermination: true, 
     DeviceIndex: 0, 
     InstanceId: "i-1234567890abcdef0", 
     InstanceOwnerId: "123456789012", 
     Status: "attached"
    }, 
    NetworkInterfaceId: "eni-686ea200"
   }
   */
 });

To describe the description attribute of a network interface


/* This example describes the description attribute of the specified network interface. */

 var params = {
  Attribute: "description", 
  NetworkInterfaceId: "eni-686ea200"
 };
 ec2.describeNetworkInterfaceAttribute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Description: {
     Value: "My description"
    }, 
    NetworkInterfaceId: "eni-686ea200"
   }
   */
 });

To describe the groupSet attribute of a network interface


/* This example describes the groupSet attribute of the specified network interface. */

 var params = {
  Attribute: "groupSet", 
  NetworkInterfaceId: "eni-686ea200"
 };
 ec2.describeNetworkInterfaceAttribute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Groups: [
       {
      GroupId: "sg-903004f8", 
      GroupName: "my-security-group"
     }
    ], 
    NetworkInterfaceId: "eni-686ea200"
   }
   */
 });

To describe the sourceDestCheck attribute of a network interface


/* This example describes the sourceDestCheck attribute of the specified network interface. */

 var params = {
  Attribute: "sourceDestCheck", 
  NetworkInterfaceId: "eni-686ea200"
 };
 ec2.describeNetworkInterfaceAttribute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NetworkInterfaceId: "eni-686ea200", 
    SourceDestCheck: {
     Value: true
    }
   }
   */
 });

Calling the describeNetworkInterfaceAttribute operation

var params = {
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  Attribute: description | groupSet | sourceDestCheck | attachment | associatePublicIpAddress,
  DryRun: true || false
};
ec2.describeNetworkInterfaceAttribute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Attribute — (String)

      The attribute of the network interface. This parameter is required.

      Possible values include:
      • "description"
      • "groupSet"
      • "sourceDestCheck"
      • "attachment"
      • "associatePublicIpAddress"
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attachment — (map)

        The attachment (if any) of the network interface.

        • AttachTime — (Date)

          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.

          Possible values include:
          • "attaching"
          • "attached"
          • "detaching"
          • "detached"
        • EnaSrdSpecification — (map)

          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 — (map)

            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.

      • Description — (map)

        The description of the network interface.

        • Value — (String)

          The attribute value. The value is case-sensitive.

      • Groups — (Array<map>)

        The security groups associated with the network interface.

        • GroupName — (String)

          The name of the security group.

        • GroupId — (String)

          The ID of the security group.

      • NetworkInterfaceId — (String)

        The ID of the network interface.

      • SourceDestCheck — (map)

        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).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNetworkInterfacePermissions(params = {}, callback) ⇒ AWS.Request

Describes the permissions for your network interfaces.

Service Reference:

Examples:

Calling the describeNetworkInterfacePermissions operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NetworkInterfacePermissionIds: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
ec2.describeNetworkInterfacePermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NetworkInterfacePermissionIds — (Array<String>)

      The network interface permission IDs.

    • Filters — (Array<map>)

      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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInterfacePermissions — (Array<map>)

        The network interface permissions.

        • 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.

          Possible values include:
          • "INSTANCE-ATTACH"
          • "EIP-ASSOCIATE"
        • PermissionState — (map)

          Information about the state of the permission.

          • State — (String)

            The state of the permission.

            Possible values include:
            • "pending"
            • "granted"
            • "revoking"
            • "revoked"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNetworkInterfaces(params = {}, callback) ⇒ AWS.Request

Describes one or more of 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, private-dns-name, subnet-id, or vpc-id.

We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.

Service Reference:

Examples:

To describe a network interface


/*  */

 var params = {
  NetworkInterfaceIds: [
     "eni-e5aa89a3"
  ]
 };
 ec2.describeNetworkInterfaces(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NetworkInterfaces: [
       {
      Association: {
       AssociationId: "eipassoc-0fbb766a", 
       IpOwnerId: "123456789012", 
       PublicDnsName: "ec2-203-0-113-12.compute-1.amazonaws.com", 
       PublicIp: "203.0.113.12"
      }, 
      Attachment: {
       AttachTime: <Date Representation>, 
       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"
     }
    ]
   }
   */
 });

Calling the describeNetworkInterfaces operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NetworkInterfaceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
ec2.describeNetworkInterfaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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 | efs | 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.

      • 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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • vpc-id - The ID of the VPC for the network interface.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The network interface IDs.

      Default: Describes all your network interfaces.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkInterfaces — (Array<map>)

        Information about the network interfaces.

        • Association — (map)

          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 — (map)

          The network interface attachment.

          • AttachTime — (Date)

            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.

            Possible values include:
            • "attaching"
            • "attached"
            • "detaching"
            • "detached"
          • EnaSrdSpecification — (map)

            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 — (map)

              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.

        • AvailabilityZone — (String)

          The Availability Zone.

        • ConnectionTrackingConfiguration — (map)

          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 — (Array<map>)

          Any security groups for the network interface.

          • GroupName — (String)

            The name of the security group.

          • GroupId — (String)

            The ID of the security group.

        • InterfaceType — (String)

          The type of network interface.

          Possible values include:
          • "interface"
          • "natGateway"
          • "efa"
          • "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 — (Array<map>)

          The IPv6 addresses associated with the network interface.

          • 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 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 DNS name.

        • PrivateIpAddress — (String)

          The IPv4 address of the network interface within the subnet.

        • PrivateIpAddresses — (Array<map>)

          The private IPv4 addresses associated with the network interface.

          • Association — (map)

            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 — (Array<map>)

          The IPv4 prefixes that are assigned to the network interface.

        • Ipv6Prefixes — (Array<map>)

          The IPv6 prefixes that are assigned to the network interface.

          • 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.

          Possible values include:
          • "available"
          • "associated"
          • "attaching"
          • "in-use"
          • "detaching"
        • SubnetId — (String)

          The ID of the subnet.

        • TagSet — (Array<map>)

          Any tags assigned to the network interface.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describePlacementGroups(params = {}, callback) ⇒ AWS.Request

Describes the specified placement groups or all of your placement groups.

Note: To describe a specific placement group that is shared with your account, you must specify the ID of the placement group using the GroupId parameter. Specifying the name of a shared placement group using the GroupNames parameter will result in an error.

For more information, see Placement groups in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the describePlacementGroups operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  GroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  GroupNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describePlacementGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      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.

    • GroupIds — (Array<String>)

      The IDs of the placement groups.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlacementGroups — (Array<map>)

        Information about the placement groups.

        • GroupName — (String)

          The name of the placement group.

        • State — (String)

          The state of the placement group.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • Strategy — (String)

          The placement strategy.

          Possible values include:
          • "cluster"
          • "spread"
          • "partition"
        • PartitionCount — (Integer)

          The number of partitions. Valid only if strategy is set to partition.

        • GroupId — (String)

          The ID of the placement group.

        • Tags — (Array<map>)

          Any tags applied to the placement group.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "host"
          • "rack"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePrefixLists(params = {}, callback) ⇒ AWS.Request

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.

We recommend that you use DescribeManagedPrefixLists instead.

Service Reference:

Examples:

Calling the describePrefixLists operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PrefixListIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describePrefixLists(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      One or more filters.

      • prefix-list-id: The ID of a prefix list.

      • prefix-list-name: The name of a prefix list.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

    • PrefixListIds — (Array<String>)

      One or more prefix list IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

      • PrefixLists — (Array<map>)

        All available prefix lists.

        • Cidrs — (Array<String>)

          The IP address range of the Amazon Web Services service.

        • PrefixListId — (String)

          The ID of the prefix.

        • PrefixListName — (String)

          The name of the prefix.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePrincipalIdFormat(params = {}, callback) ⇒ AWS.Request

Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

Service Reference:

Examples:

Calling the describePrincipalIdFormat operation

var params = {
  DryRun: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Resources: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describePrincipalIdFormat(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<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

    • 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)

      The token to request the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Principals — (Array<map>)

        Information about the ID format settings for the ARN.

        • Arn — (String)

          PrincipalIdFormatARN description

        • Statuses — (Array<map>)

          PrincipalIdFormatStatuses description

          • Deadline — (Date)

            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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePublicIpv4Pools(params = {}, callback) ⇒ AWS.Request

Describes the specified IPv4 address pools.

Service Reference:

Examples:

Calling the describePublicIpv4Pools operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PoolIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describePublicIpv4Pools(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PoolIds — (Array<String>)

      The IDs of the address pools.

    • 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.

    • Filters — (Array<map>)

      One or more filters.

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PublicIpv4Pools — (Array<map>)

        Information about the address pools.

        • PoolId — (String)

          The ID of the address pool.

        • Description — (String)

          A description of the address pool.

        • PoolAddressRanges — (Array<map>)

          The address ranges.

          • 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 — (Array<map>)

          Any tags for the address pool.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeRegions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe your regions


/* This example describes all the regions that are available to you. */

 var params = {
 };
 ec2.describeRegions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
     }
    ]
   }
   */
 });

Calling the describeRegions operation

var params = {
  AllRegions: true || false,
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  RegionNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeRegions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • RegionNames — (Array<String>)

      The names of the Regions. You can specify any Regions, whether they are enabled and 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.

    • AllRegions — (Boolean)

      Indicates whether to display all Regions, including Regions that are disabled for your account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Regions — (Array<map>)

        Information about the Regions.

        • Endpoint — (String)

          The Region service endpoint.

        • RegionName — (String)

          The name of the Region.

        • OptInStatus — (String)

          The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReplaceRootVolumeTasks(params = {}, callback) ⇒ AWS.Request

Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the describeReplaceRootVolumeTasks operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ReplaceRootVolumeTaskIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeReplaceRootVolumeTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReplaceRootVolumeTaskIds — (Array<String>)

      The ID of the root volume replacement task to view.

    • Filters — (Array<map>)

      Filter to use:

      • instance-id - The ID of the instance for which the root volume replacement task was created.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReplaceRootVolumeTasks — (Array<map>)

        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.

          Possible values include:
          • "pending"
          • "in-progress"
          • "failing"
          • "succeeded"
          • "failed"
          • "failed-detached"
        • StartTime — (String)

          The time the task was started.

        • CompleteTime — (String)

          The time the task completed.

        • Tags — (Array<map>)

          The tags assigned to the task.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReservedInstances(params = {}, callback) ⇒ AWS.Request

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.

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.

Service Reference:

Examples:

Calling the describeReservedInstances operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  OfferingClass: standard | convertible,
  OfferingType: Heavy Utilization | Medium Utilization | Light Utilization | No Upfront | Partial Upfront | All Upfront,
  ReservedInstancesIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeReservedInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      One or more filters.

      • availability-zone - The Availability Zone where the Reserved Instance can be used.

      • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

      • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

      • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

      • instance-type - The instance type that is covered by the reservation.

      • scope - The scope of the Reserved Instance (Region or Availability Zone).

      • product-description - The Reserved Instance product platform description (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-id - The ID of the Reserved Instance.

      • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

      • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • OfferingClass — (String)

      Describes whether the Reserved Instance is Standard or Convertible.

      Possible values include:
      • "standard"
      • "convertible"
    • ReservedInstancesIds — (Array<String>)

      One or more Reserved Instance IDs.

      Default: Describes all your Reserved Instances, or only those otherwise specified.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • OfferingType — (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.

      Possible values include:
      • "Heavy Utilization"
      • "Medium Utilization"
      • "Light Utilization"
      • "No Upfront"
      • "Partial Upfront"
      • "All Upfront"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReservedInstances — (Array<map>)

        A list of Reserved Instances.

        • AvailabilityZone — (String)

          The Availability Zone in which the Reserved Instance can be used.

        • Duration — (Integer)

          The duration of the Reserved Instance, in seconds.

        • End — (Date)

          The time when the Reserved Instance expires.

        • FixedPrice — (Float)

          The purchase price of the Reserved Instance.

        • InstanceCount — (Integer)

          The number of reservations purchased.

        • InstanceType — (String)

          The instance type on which the Reserved Instance can be used.

          Possible values include:
          • "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"
        • ProductDescription — (String)

          The Reserved Instance product platform description.

          Possible values include:
          • "Linux/UNIX"
          • "Linux/UNIX (Amazon VPC)"
          • "Windows"
          • "Windows (Amazon VPC)"
        • ReservedInstancesId — (String)

          The ID of the Reserved Instance.

        • Start — (Date)

          The date and time the Reserved Instance started.

        • State — (String)

          The state of the Reserved Instance purchase.

          Possible values include:
          • "payment-pending"
          • "active"
          • "payment-failed"
          • "retired"
          • "queued"
          • "queued-deleted"
        • UsagePrice — (Float)

          The usage price of the Reserved Instance, per hour.

        • 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.

          Possible values include:
          • "USD"
        • InstanceTenancy — (String)

          The tenancy of the instance.

          Possible values include:
          • "default"
          • "dedicated"
          • "host"
        • OfferingClass — (String)

          The offering class of the Reserved Instance.

          Possible values include:
          • "standard"
          • "convertible"
        • OfferingType — (String)

          The Reserved Instance offering type.

          Possible values include:
          • "Heavy Utilization"
          • "Medium Utilization"
          • "Light Utilization"
          • "No Upfront"
          • "Partial Upfront"
          • "All Upfront"
        • RecurringCharges — (Array<map>)

          The recurring charge tag assigned to the resource.

          • Amount — (Float)

            The amount of the recurring charge.

          • Frequency — (String)

            The frequency of the recurring charge.

            Possible values include:
            • "Hourly"
        • Scope — (String)

          The scope of the Reserved Instance.

          Possible values include:
          • "Availability Zone"
          • "Region"
        • Tags — (Array<map>)

          Any tags assigned to the resource.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReservedInstancesListings(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeReservedInstancesListings operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ReservedInstancesId: 'STRING_VALUE',
  ReservedInstancesListingId: 'STRING_VALUE'
};
ec2.describeReservedInstancesListings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • ReservedInstancesId — (String)

      One or more Reserved Instance IDs.

    • ReservedInstancesListingId — (String)

      One or more Reserved Instance listing IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReservedInstancesListings — (Array<map>)

        Information about the 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 — (Date)

          The time the listing was created.

        • InstanceCounts — (Array<map>)

          The number of instances in this 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.

            Possible values include:
            • "available"
            • "sold"
            • "cancelled"
            • "pending"
        • PriceSchedules — (Array<map>)

          The price of the Reserved Instance listing.

          • 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.

            Possible values include:
            • "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.

          Possible values include:
          • "active"
          • "pending"
          • "cancelled"
          • "closed"
        • StatusMessage — (String)

          The reason for the current status of the Reserved Instance listing. The response can be blank.

        • Tags — (Array<map>)

          Any tags assigned to the resource.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 — (Date)

          The last modified timestamp of the listing.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReservedInstancesModifications(params = {}, callback) ⇒ AWS.Request

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modify Reserved Instances in the Amazon EC2 User Guide.

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.

Service Reference:

Examples:

Calling the describeReservedInstancesModifications operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  NextToken: 'STRING_VALUE',
  ReservedInstancesModificationIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeReservedInstancesModifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      One or more filters.

      • client-token - The idempotency token for the modification request.

      • create-date - The time when the modification request was created.

      • effective-date - The time when the modification becomes effective.

      • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

      • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

      • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

      • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

      • 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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • ReservedInstancesModificationIds — (Array<String>)

      IDs for the submitted modification request.

    • NextToken — (String)

      The token to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

      • ReservedInstancesModifications — (Array<map>)

        The Reserved Instance modification information.

        • 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 — (Date)

          The time when the modification request was created.

        • EffectiveDate — (Date)

          The time for the modification to become effective.

        • ModificationResults — (Array<map>)

          Contains target configurations along with their corresponding new Reserved Instance IDs.

          • 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 — (map)

            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.

              Possible values include:
              • "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"
            • 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.

              Possible values include:
              • "Availability Zone"
              • "Region"
        • ReservedInstancesIds — (Array<map>)

          The IDs of one or more Reserved Instances.

          • 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 — (Date)

          The time when the modification request was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReservedInstancesOfferings(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeReservedInstancesOfferings operation

var params = {
  AvailabilityZone: 'STRING_VALUE',
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludeMarketplace: true || false,
  InstanceTenancy: default | dedicated | host,
  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,
  MaxDuration: 'NUMBER_VALUE',
  MaxInstanceCount: 'NUMBER_VALUE',
  MaxResults: 'NUMBER_VALUE',
  MinDuration: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OfferingClass: standard | convertible,
  OfferingType: Heavy Utilization | Medium Utilization | Light Utilization | No Upfront | Partial Upfront | All Upfront,
  ProductDescription: Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC),
  ReservedInstancesOfferingIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeReservedInstancesOfferings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AvailabilityZone — (String)

      The Availability Zone in which the Reserved Instance can be used.

    • Filters — (Array<map>)

      One or more filters.

      • availability-zone - The Availability Zone where the Reserved Instance can be used.

      • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

      • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

      • instance-type - The instance type that is covered by the reservation.

      • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both 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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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.

      Possible values include:
      • "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"
    • 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.

      Possible values include:
      • "standard"
      • "convertible"
    • ProductDescription — (String)

      The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

      Possible values include:
      • "Linux/UNIX"
      • "Linux/UNIX (Amazon VPC)"
      • "Windows"
      • "Windows (Amazon VPC)"
    • ReservedInstancesOfferingIds — (Array<String>)

      One or more Reserved Instances offering IDs.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 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

      Possible values include:
      • "default"
      • "dedicated"
      • "host"
    • 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

    • NextToken — (String)

      The token to retrieve the next page of results.

    • 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.

      Possible values include:
      • "Heavy Utilization"
      • "Medium Utilization"
      • "Light Utilization"
      • "No Upfront"
      • "Partial Upfront"
      • "All Upfront"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReservedInstancesOfferings — (Array<map>)

        A list of Reserved Instances offerings.

        • AvailabilityZone — (String)

          The Availability Zone in which the Reserved Instance can be used.

        • Duration — (Integer)

          The duration of the Reserved Instance, in seconds.

        • FixedPrice — (Float)

          The purchase price of the Reserved Instance.

        • InstanceType — (String)

          The instance type on which the Reserved Instance can be used.

          Possible values include:
          • "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"
        • ProductDescription — (String)

          The Reserved Instance product platform description.

          Possible values include:
          • "Linux/UNIX"
          • "Linux/UNIX (Amazon VPC)"
          • "Windows"
          • "Windows (Amazon VPC)"
        • 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.

        • UsagePrice — (Float)

          The usage price of the Reserved Instance, per hour.

        • 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.

          Possible values include:
          • "USD"
        • InstanceTenancy — (String)

          The tenancy of the instance.

          Possible values include:
          • "default"
          • "dedicated"
          • "host"
        • 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.

          Possible values include:
          • "standard"
          • "convertible"
        • OfferingType — (String)

          The Reserved Instance offering type.

          Possible values include:
          • "Heavy Utilization"
          • "Medium Utilization"
          • "Light Utilization"
          • "No Upfront"
          • "Partial Upfront"
          • "All Upfront"
        • PricingDetails — (Array<map>)

          The pricing details of the Reserved Instance offering.

          • Count — (Integer)

            The number of reservations available for the price.

          • Price — (Float)

            The price per instance.

        • RecurringCharges — (Array<map>)

          The recurring charge tag assigned to the resource.

          • Amount — (Float)

            The amount of the recurring charge.

          • Frequency — (String)

            The frequency of the recurring charge.

            Possible values include:
            • "Hourly"
        • Scope — (String)

          Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

          Possible values include:
          • "Availability Zone"
          • "Region"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeRouteTables(params = {}, callback) ⇒ AWS.Request

Describes your route tables. The default is to describe all your route tables. Alternatively, you can specify specific route table IDs or filter the results to include only the route tables that match specific criteria.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information, see Route tables in the Amazon VPC User Guide.

Service Reference:

Examples:

To describe a route table


/* This example describes the specified route table. */

 var params = {
  RouteTableIds: [
     "rtb-1f382e7d"
  ]
 };
 ec2.describeRouteTables(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    RouteTables: [
       {
      Associations: [
         {
        Main: true, 
        RouteTableAssociationId: "rtbassoc-d8ccddba", 
        RouteTableId: "rtb-1f382e7d"
       }
      ], 
      PropagatingVgws: [
      ], 
      RouteTableId: "rtb-1f382e7d", 
      Routes: [
         {
        DestinationCidrBlock: "10.0.0.0/16", 
        GatewayId: "local", 
        State: "active"
       }
      ], 
      Tags: [
      ], 
      VpcId: "vpc-a01106c2"
     }
    ]
   }
   */
 });

Calling the describeRouteTables operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RouteTableIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeRouteTables(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • vpc-id - The ID of the VPC for the route table.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the route tables.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RouteTables — (Array<map>)

        Information about the route tables.

        • Associations — (Array<map>)

          The associations between the route table and your subnets or gateways.

          • 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 — (map)

            The state of the association.

            • State — (String)

              The state of the association.

              Possible values include:
              • "associating"
              • "associated"
              • "disassociating"
              • "disassociated"
              • "failed"
            • StatusMessage — (String)

              The status message, if applicable.

        • PropagatingVgws — (Array<map>)

          Any virtual private gateway (VGW) propagating routes.

          • GatewayId — (String)

            The ID of the virtual private gateway.

        • RouteTableId — (String)

          The ID of the route table.

        • Routes — (Array<map>)

          The routes in the 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.

            Possible values include:
            • "CreateRouteTable"
            • "CreateRoute"
            • "EnableVgwRoutePropagation"
          • 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).

            Possible values include:
            • "active"
            • "blackhole"
          • VpcPeeringConnectionId — (String)

            The ID of a VPC peering connection.

          • CoreNetworkArn — (String)

            The Amazon Resource Name (ARN) of the core network.

        • Tags — (Array<map>)

          Any tags assigned to the route table.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the route table.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeScheduledInstanceAvailability(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeScheduledInstanceAvailability operation

var params = {
  FirstSlotStartTimeRange: { /* required */
    EarliestTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    LatestTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
  },
  Recurrence: { /* required */
    Frequency: 'STRING_VALUE',
    Interval: 'NUMBER_VALUE',
    OccurrenceDays: [
      'NUMBER_VALUE',
      /* more items */
    ],
    OccurrenceRelativeToEnd: true || false,
    OccurrenceUnit: 'STRING_VALUE'
  },
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  MaxSlotDurationInHours: 'NUMBER_VALUE',
  MinSlotDurationInHours: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeScheduledInstanceAvailability(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • FirstSlotStartTimeRange — (map)

      The time period for the first schedule to start.

      • EarliestTime — required — (Date)

        The earliest date and time, in UTC, for the Scheduled Instance to start.

      • LatestTime — required — (Date)

        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 — (map)

      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 — (Array<Integer>)

        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.

      • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Information about the available Scheduled Instances.

        • AvailabilityZone — (String)

          The Availability Zone.

        • AvailableInstanceCount — (Integer)

          The number of available instances.

        • FirstSlotStartTime — (Date)

          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 — (map)

          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 — (Array<Integer>)

            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).

          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeScheduledInstances(params = {}, callback) ⇒ AWS.Request

Describes the specified Scheduled Instances or all your Scheduled Instances.

Service Reference:

Examples:

Calling the describeScheduledInstances operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ScheduledInstanceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SlotStartTimeRange: {
    EarliestTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    LatestTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  }
};
ec2.describeScheduledInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<map>)

      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).

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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 100. To retrieve the remaining results, make another call with the returned NextToken value.

    • NextToken — (String)

      The token for the next set of results.

    • ScheduledInstanceIds — (Array<String>)

      The Scheduled Instance IDs.

    • SlotStartTimeRange — (map)

      The time period for the first schedule to start.

      • EarliestTime — (Date)

        The earliest date and time, in UTC, for the Scheduled Instance to start.

      • LatestTime — (Date)

        The latest date and time, in UTC, for the Scheduled Instance to start.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The token required to retrieve the next set of results. This value is null when there are no more results to return.

      • ScheduledInstanceSet — (Array<map>)

        Information about the Scheduled Instances.

        • AvailabilityZone — (String)

          The Availability Zone.

        • CreateDate — (Date)

          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 — (Date)

          The time for the next schedule to start.

        • Platform — (String)

          The platform (Linux/UNIX or Windows).

        • PreviousSlotEndTime — (Date)

          The time that the previous schedule ended or will end.

        • Recurrence — (map)

          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 — (Array<Integer>)

            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).

          • 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 — (Date)

          The end date for the Scheduled Instance.

        • TermStartDate — (Date)

          The start date for the Scheduled Instance.

        • TotalScheduledInstanceHours — (Integer)

          The total number of hours for a single instance for the entire term.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSecurityGroupReferences(params = {}, callback) ⇒ AWS.Request

Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

Service Reference:

Examples:

To describe security group references


/* This example describes the security group references for the specified security group. */

 var params = {
  GroupId: [
     "sg-903004f8"
  ]
 };
 ec2.describeSecurityGroupReferences(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SecurityGroupReferenceSet: [
       {
      GroupId: "sg-903004f8", 
      ReferencingVpcId: "vpc-1a2b3c4d", 
      VpcPeeringConnectionId: "pcx-b04deed9"
     }
    ]
   }
   */
 });

Calling the describeSecurityGroupReferences operation

var params = {
  GroupId: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DryRun: true || false
};
ec2.describeSecurityGroupReferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 — (Array<String>)

      The IDs of the security groups in your account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecurityGroupReferenceSet — (Array<map>)

        Information about the VPCs with the referencing security groups.

        • GroupId — (String)

          The ID of your security group.

        • ReferencingVpcId — (String)

          The ID of the VPC with the referencing security group.

        • VpcPeeringConnectionId — (String)

          The ID of the VPC peering connection (if applicable). For more information about security group referencing for peering connections, see Update your security groups to reference peer security groups in the VPC Peering Guide.

        • TransitGatewayId — (String)
          Note: This parameter is in preview and may not be available for your account.

          The ID of the transit gateway (if applicable).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSecurityGroupRules(params = {}, callback) ⇒ AWS.Request

Describes one or more of your security group rules.

Service Reference:

Examples:

Calling the describeSecurityGroupRules operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SecurityGroupRuleIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeSecurityGroupRules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      One or more filters.

      • group-id - The ID of the security group.

      • security-group-rule-id - The ID of the security group rule.

      • 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.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • SecurityGroupRuleIds — (Array<String>)

      The IDs of the security group rules.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecurityGroupRules — (Array<map>)

        Information about security group rules.

        • 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 — (map)

          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 — (Array<map>)

          The tags applied to the security group rule.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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 include in another request to get the next page of items. This value is null when there are no more items to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSecurityGroups(params = {}, callback) ⇒ AWS.Request

Describes the specified security groups or all of your security groups.

Service Reference:

Examples:

To describe a security group


/* This example describes the specified security group. */

 var params = {
  GroupIds: [
     "sg-903004f8"
  ]
 };
 ec2.describeSecurityGroups(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To describe a tagged security group


/* This example describes the security groups that include the specified tag (Purpose=test). */

 var params = {
  Filters: [
     {
    Name: "tag:Purpose", 
    Values: [
       "test"
    ]
   }
  ]
 };
 ec2.describeSecurityGroups(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the describeSecurityGroups operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  GroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  GroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeSecurityGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • vpc-id - The ID of the VPC specified when the security group was created.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • GroupIds — (Array<String>)

      The IDs of the security groups. Required for security groups in a nondefault VPC.

      Default: Describes all of your security groups.

    • GroupNames — (Array<String>)

      [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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecurityGroups — (Array<map>)

        Information about the security groups.

        • Description — (String)

          A description of the security group.

        • GroupName — (String)

          The name of the security group.

        • IpPermissions — (Array<map>)

          The inbound rules associated with the security group.

          • 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).

          • 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.

          • IpRanges — (Array<map>)

            The IPv4 address ranges.

            • 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.

            • 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 ._-:/()#,@[]+=&;{}!$*

          • Ipv6Ranges — (Array<map>)

            The IPv6 address ranges.

            • 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.

            • 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 ._-:/()#,@[]+=&;{}!$*

          • PrefixListIds — (Array<map>)

            The prefix list IDs.

            • 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.

          • 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 — (Array<map>)

            The security group and Amazon Web Services account ID pairs.

            • 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 ._-:/()#,@[]+=;{}!$*

            • GroupId — (String)

              The ID of the security group.

            • 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.

            • PeeringStatus — (String)

              The status of a VPC peering connection, if applicable.

            • 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.

            • 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.

        • OwnerId — (String)

          The Amazon Web Services account ID of the owner of the security group.

        • GroupId — (String)

          The ID of the security group.

        • IpPermissionsEgress — (Array<map>)

          The outbound rules associated with the security group.

          • 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).

          • 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.

          • IpRanges — (Array<map>)

            The IPv4 address ranges.

            • 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.

            • 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 ._-:/()#,@[]+=&;{}!$*

          • Ipv6Ranges — (Array<map>)

            The IPv6 address ranges.

            • 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.

            • 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 ._-:/()#,@[]+=&;{}!$*

          • PrefixListIds — (Array<map>)

            The prefix list IDs.

            • 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.

          • 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 — (Array<map>)

            The security group and Amazon Web Services account ID pairs.

            • 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 ._-:/()#,@[]+=;{}!$*

            • GroupId — (String)

              The ID of the security group.

            • 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.

            • PeeringStatus — (String)

              The status of a VPC peering connection, if applicable.

            • 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.

            • 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.

        • Tags — (Array<map>)

          Any tags assigned to the security group.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeSnapshotAttribute(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe snapshot attributes


/* This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``. */

 var params = {
  Attribute: "createVolumePermission", 
  SnapshotId: "snap-066877671789bd71b"
 };
 ec2.describeSnapshotAttribute(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CreateVolumePermissions: [
    ], 
    SnapshotId: "snap-066877671789bd71b"
   }
   */
 });

Calling the describeSnapshotAttribute operation

var params = {
  Attribute: productCodes | createVolumePermission, /* required */
  SnapshotId: 'STRING_VALUE', /* required */
  DryRun: true || false
};
ec2.describeSnapshotAttribute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Attribute — (String)

      The snapshot attribute you would like to view.

      Possible values include:
      • "productCodes"
      • "createVolumePermission"
    • SnapshotId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CreateVolumePermissions — (Array<map>)

        The users and groups that have the permissions for creating volumes from the snapshot.

        • Group — (String)

          The group to be added or removed. The possible value is all.

          Possible values include:
          • "all"
        • UserId — (String)

          The ID of the Amazon Web Services account to be added or removed.

      • ProductCodes — (Array<map>)

        The product codes.

        • ProductCodeId — (String)

          The product code.

        • ProductCodeType — (String)

          The type of product code.

          Possible values include:
          • "devpay"
          • "marketplace"
      • SnapshotId — (String)

        The ID of the EBS snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSnapshots(params = {}, callback) ⇒ AWS.Request

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.

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.

We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.

Service Reference:

Examples:

To describe a snapshot


/* This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. */

 var params = {
  SnapshotIds: [
     "snap-1234567890abcdef0"
  ]
 };
 ec2.describeSnapshots(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NextToken: "", 
    Snapshots: [
       {
      Description: "This is my snapshot.", 
      OwnerId: "012345678910", 
      Progress: "100%", 
      SnapshotId: "snap-1234567890abcdef0", 
      StartTime: <Date Representation>, 
      State: "completed", 
      VolumeId: "vol-049df61146c4d7901", 
      VolumeSize: 8
     }
    ]
   }
   */
 });

To describe snapshots using filters


/* This example describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status. */

 var params = {
  Filters: [
     {
    Name: "status", 
    Values: [
       "pending"
    ]
   }
  ], 
  OwnerIds: [
     "012345678910"
  ]
 };
 ec2.describeSnapshots(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NextToken: "", 
    Snapshots: [
       {
      Description: "This is my copied snapshot.", 
      OwnerId: "012345678910", 
      Progress: "87%", 
      SnapshotId: "snap-066877671789bd71b", 
      StartTime: <Date Representation>, 
      State: "pending", 
      VolumeId: "vol-1234567890abcdef0", 
      VolumeSize: 8
     }
    ]
   }
   */
 });

Calling the describeSnapshots operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OwnerIds: [
    'STRING_VALUE',
    /* more items */
  ],
  RestorableByUserIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SnapshotIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      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).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      • volume-id - The ID of the volume the snapshot is for.

      • volume-size - The size of the volume, in GiB.

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • 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 — (Array<String>)

      Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.

    • RestorableByUserIds — (Array<String>)

      The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

    • SnapshotIds — (Array<String>)

      The snapshot IDs.

      Default: Describes the snapshots for which you have create volume permissions.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshots — (Array<map>)

        Information about the snapshots.

        • 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.

        • Description — (String)

          The description for the snapshot.

        • 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.

        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the EBS snapshot.

        • Progress — (String)

          The progress of the snapshot, as a percentage.

        • SnapshotId — (String)

          The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

        • StartTime — (Date)

          The time stamp when the snapshot was initiated.

        • State — (String)

          The snapshot state.

          Possible values include:
          • "pending"
          • "completed"
          • "error"
          • "recoverable"
          • "recovering"
        • 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.

        • VolumeId — (String)

          The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

        • VolumeSize — (Integer)

          The size of the volume, in GiB.

        • 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 — (Array<map>)

          Any tags assigned to the snapshot.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "archive"
          • "standard"
        • RestoreExpiryTime — (Date)

          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.

          Possible values include:
          • "sse-ebs"
          • "sse-kms"
          • "none"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeSnapshotTierStatus(params = {}, callback) ⇒ AWS.Request

Describes the storage tier status of one or more Amazon EBS snapshots.

Service Reference:

Examples:

Calling the describeSnapshotTierStatus operation

var params = {
  DryRun: true || false,
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeSnapshotTierStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      The filters.

      • snapshot-id - The snapshot ID.

      • volume-id - The ID of the volume the snapshot is for.

      • last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)

      • Name — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        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.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotTierStatuses — (Array<map>)

        Information about the snapshot's storage tier.

        • SnapshotId — (String)

          The ID of the snapshot.

        • VolumeId — (String)

          The ID of the volume from which the snapshot was created.

        • Status — (String)

          The state of the snapshot.

          Possible values include:
          • "pending"
          • "completed"
          • "error"
          • "recoverable"
          • "recovering"
        • OwnerId — (String)

          The ID of the Amazon Web Services account that owns the snapshot.

        • Tags — (Array<map>)

          The tags that are assigned to the snapshot.

          • Key — (String)

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not 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.

          Possible values include:
          • "archive"
          • "standard"
        • LastTieringStartTime — (Date)

          The date and time when the last archive or restore process was started.

        • LastTieringProgress — (Integer)

          The progress of the last archive or restore process, as a percentage.

        • LastTieringOperationStatus — (String)

          The status of the last archive or restore process.

          Possible values include:
          • "archival-in-progress"
          • "archival-completed"
          • "archival-failed"
          • "temporary-restore-in-progress"
          • "temporary-restore-completed"
          • "temporary-restore-failed"
          • "permanent-restore-in-progress"
          • "permanent-restore-completed"
          • "permanent-restore-failed"
        • LastTieringOperationStatusDetail — (String)

          A message describing the status of the last archive or restore process.

        • ArchivalCompleteTime — (Date)

          The date and time when the last archive process was completed.

        • RestoreExpiryTime — (Date)

          Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSpotDatafeedSubscription(params = {}, callback) ⇒ AWS.Request

Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide.

Service Reference:

Examples:

To describe the datafeed for your AWS account


/* This example describes the Spot Instance datafeed subscription for your AWS account. */

 var params = {
 };
 ec2.describeSpotDatafeedSubscription(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SpotDatafeedSubscription: {
     Bucket: "my-s3-bucket", 
     OwnerId: "123456789012", 
     Prefix: "spotdata", 
     State: "Active"
    }
   }
   */
 });

Calling the describeSpotDatafeedSubscription operation

var params = {
  DryRun: true || false
};
ec2.describeSpotDatafeedSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SpotDatafeedSubscription — (map)

        The Spot Instance data feed subscription.

        • Bucket — (String)

          The name of the Amazon S3 bucket where the Spot Instance data feed is located.

        • Fault — (map)

          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.

          Possible values include:
          • "Active"
          • "Inactive"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSpotFleetInstances(params = {}, callback) ⇒ AWS.Request

Describes the running instances for the specified Spot Fleet.

Service Reference:

Examples:

To describe the Spot Instances associated with a Spot fleet


/* This example lists the Spot Instances associated with the specified Spot fleet. */

 var params = {
  SpotFleetRequestId: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
 };
 ec2.describeSpotFleetInstances(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ActiveInstances: [
       {
      InstanceId: "i-1234567890abcdef0", 
      InstanceType: "m3.medium", 
      SpotInstanceRequestId: "sir-08b93456"
     }
    ], 
    SpotFleetRequestId: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
   }
   */
 });

Calling the describeSpotFleetInstances operation

var params = {
  SpotFleetRequestId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeSpotFleetInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 to include in another request to get the next page of items. This value is null when there are no more items to return.

    • SpotFleetRequestId — (String)

      The ID of the Spot Fleet request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ActiveInstances — (Array<map>)

        The running instances. This list is refreshed periodically and might be out of date.

        • InstanceId — (String)

          The ID of the instance.

        • InstanceType — (String)

          The instance type.

        • SpotInstanceRequestId — (String)

          The ID of the Spot Instance request.

        • InstanceHealth — (String)

          The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.

          Possible values include:
          • "healthy"
          • "unhealthy"
      • 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.

      • SpotFleetRequestId — (String)

        The ID of the Spot Fleet request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSpotFleetRequestHistory(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe Spot fleet history


/* This example returns the history for the specified Spot fleet starting at the specified time. */

 var params = {
  SpotFleetRequestId: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
  StartTime: <Date Representation>
 };
 ec2.describeSpotFleetRequestHistory(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    HistoryRecords: [
       {
      EventInformation: {
       EventSubType: "submitted"
      }, 
      EventType: "fleetRequestChange", 
      Timestamp: <Date Representation>
     }, 
       {
      EventInformation: {
       EventSubType: "active"
      }, 
      EventType: "fleetRequestChange", 
      Timestamp: <Date Representation>
     }, 
       {
      EventInformation: {
       EventSubType: "launched", 
       InstanceId: "i-1234567890abcdef0"
      }, 
      EventType: "instanceChange", 
      Timestamp: <Date Representation>
     }, 
       {
      EventInformation: {
       EventSubType: "launched", 
       InstanceId: "i-1234567890abcdef1"
      }, 
      EventType: "instanceChange", 
      Timestamp: <Date Representation>
     }
    ], 
    NextToken: "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=", 
    SpotFleetRequestId: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
    StartTime: <Date Representation>
   }
   */
 });

Calling the describeSpotFleetRequestHistory operation

var params = {
  SpotFleetRequestId: 'STRING_VALUE', /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  DryRun: true || false,
  EventType: instanceChange | fleetRequestChange | error | information,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ec2.describeSpotFleetRequestHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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.

      Possible values include:
      • "instanceChange"
      • "fleetRequestChange"
      • "error"
      • "information"
    • 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 include in another request to get the next page of items. This value is null when there are no more items to return.

    • SpotFleetRequestId — (String)

      The ID of the Spot Fleet request.

    • StartTime — (Date)

      The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HistoryRecords — (Array<map>)

        Information about the events in the history of the Spot Fleet request.

        • EventInformation — (map)

          Information about the event.

          • EventDescription — (String)

            The description of the event.

          • EventSubType — (String)

            The event.

            error events:

            • iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.

            • allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.

            • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot Instances that you can launch.

            • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

            fleetRequestChange events:

            • active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.

            • deleted (EC2 Fleet) / cancelled (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.

            • deleted_running (EC2 Fleet) / cancelled_running (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.

            • deleted_terminating (EC2 Fleet) / cancelled_terminating (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.

            • expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.

            • modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.

            • modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.

            • submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.

            • progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.

            instanceChange events:

            • launched - A new instance was launched.

            • terminated - An instance was terminated by the user.

            • termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.

            Information events:

            • fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.

            • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

            • launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.

            • registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.

          • InstanceId — (String)

            The ID of the instance. This information is available only for instanceChange events.

        • EventType — (String)

          The event type.

          • error - An error with the Spot Fleet request.

          • fleetRequestChange - A change in the status or configuration of the Spot Fleet request.

          • instanceChange - An instance was launched or terminated.

          • Information - An informational event.

          Possible values include:
          • "instanceChange"
          • "fleetRequestChange"
          • "error"
          • "information"
        • Timestamp — (Date)

          The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

      • LastEvaluatedTime — (Date)

        The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

        If nextToken indicates that there are more items, this value is not present.

      • 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.

      • SpotFleetRequestId — (String)

        The ID of the Spot Fleet request.

      • StartTime — (Date)

        The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSpotFleetRequests(params = {}, callback) ⇒ AWS.Request

Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

Service Reference:

Examples:

To describe a Spot fleet request


/* This example describes the specified Spot fleet request. */

 var params = {
  SpotFleetRequestIds: [
     "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
  ]
 };
 ec2.describeSpotFleetRequests(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SpotFleetRequestConfigs: [
       {
      SpotFleetRequestConfig: {
       IamFleetRole: "arn:aws:iam::123456789012:role/my-spot-fleet-role", 
       LaunchSpecifications: [
          {
         EbsOptimized: false, 
         ImageId: "ami-1a2b3c4d", 
         InstanceType: "cc2.8xlarge", 
         NetworkInterfaces: [
            {
           AssociatePublicIpAddress: true, 
           DeleteOnTermination: false, 
           DeviceIndex: 0, 
           SecondaryPrivateIpAddressCount: 0, 
           SubnetId: "subnet-a61dafcf"
          }
         ]
        }, 
          {
         EbsOptimized: false, 
         ImageId: "ami-1a2b3c4d", 
         InstanceType: "r3.8xlarge", 
         NetworkInterfaces: [
            {
           AssociatePublicIpAddress: true, 
           DeleteOnTermination: false, 
           DeviceIndex: 0, 
           SecondaryPrivateIpAddressCount: 0, 
           SubnetId: "subnet-a61dafcf"
          }
         ]
        }
       ], 
       SpotPrice: "0.05", 
       TargetCapacity: 20
      }, 
      SpotFleetRequestId: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
      SpotFleetRequestState: "active"
     }
    ]
   }
   */
 });

Calling the describeSpotFleetRequests operation

var params = {
  DryRun: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SpotFleetRequestIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ec2.describeSpotFleetRequests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without 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 to include in another request to get the next page of items. This value is null when there are no more items to return.

    • SpotFleetRequestIds — (Array<String>)

      The IDs of the Spot Fleet requests.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Information about the configuration of your Spot Fleet.

        • 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.

          Possible values include:
          • "error"
          • "pending_fulfillment"
          • "pending_termination"
          • "fulfilled"
        • CreateTime — (Date)

          The creation date and time of the request.

        • SpotFleetRequestConfig — (map)

          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)

            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

            Possible values include:
            • "lowestPrice"
            • "diversified"
            • "capacityOptimized"
            • "capacityOptimizedPrioritized"
            • "priceCapacityOptimized"
          • 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.

            Possible values include:
            • "lowestPrice"
            • "prioritized"
          • SpotMaintenanceStrategies — (map)

            The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

            • CapacityRebalance — (map)

              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.

                Possible values include:
                • "launch"
                • "launch-before-terminate"
              • 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.

            Possible values include:
            • "noTermination"
            • "default"
          • 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 — required — (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 — (Array<map>)

            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.
            • SecurityGroups — (Array<map>)

              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.

              • GroupName — (String)

                The name of the security group.

              • GroupId — (String)

                The ID of the security group.

            • AddressingType — (String)

              Deprecated.

            • BlockDeviceMappings — (Array<map>)

              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.

              • 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 — (map)

                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.

                  Possible values include:
                  • "standard"
                  • "io1"
                  • "io2"
                  • "gp2"
                  • "sc1"
                  • "st1"
                  • "gp3"
                • KmsKeyId — (String)

                  Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

                  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.

                • 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.

              • 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.

            • 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 — (map)

              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.

              Possible values include:
              • "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"<