Class: Aws::EC2::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-ec2/client.rb

Overview

An API client for EC2. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::EC2::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::EC2::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::EC2::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



448
449
450
 
# File 'lib/aws-sdk-ec2/client.rb', line 448

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



60667
60668
60669
 
# File 'lib/aws-sdk-ec2/client.rb', line 60667

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



60670
60671
60672
 
# File 'lib/aws-sdk-ec2/client.rb', line 60670

def errors_module
  Errors
end

Instance Method Details

#accept_address_transfer(params = {}) ⇒ Types::AcceptAddressTransferResult

Accepts an Elastic IP address transfer. For more information, see

Accept a transferred Elastic IP address][1

in the *Amazon VPC User

Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#using-instance-addressing-eips-transfer-accept

Examples:

Request syntax with placeholder values


resp = client.accept_address_transfer({
  address: "String", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.address_transfer.public_ip #=> String
resp.address_transfer.allocation_id #=> String
resp.address_transfer. #=> String
resp.address_transfer.transfer_offer_expiration_timestamp #=> Time
resp.address_transfer.transfer_offer_accepted_timestamp #=> Time
resp.address_transfer.address_transfer_status #=> String, one of "pending", "disabled", "accepted"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :address (required, String) —

    The Elastic IP address you are accepting for transfer.

  • :tag_specifications (Array<Types::TagSpecification>) —

    ‘tag`:&lt;key&gt; - 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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



513
514
515
516
 
# File 'lib/aws-sdk-ec2/client.rb', line 513

def accept_address_transfer(params = {}, options = {})
  req = build_request(:accept_address_transfer, params)
  req.send_request(options)
end

#accept_capacity_reservation_billing_ownership(params = {}) ⇒ Types::AcceptCapacityReservationBillingOwnershipResult

Accepts a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see [ Billing assignment for shared Amazon EC2 Capacity Reservations].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html

Examples:

Request syntax with placeholder values


resp = client.accept_capacity_reservation_billing_ownership({
  dry_run: false,
  capacity_reservation_id: "CapacityReservationId", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation for which to accept the request.

Returns:

See Also:



554
555
556
557
 
# File 'lib/aws-sdk-ec2/client.rb', line 554

def accept_capacity_reservation_billing_ownership(params = {}, options = {})
  req = build_request(:accept_capacity_reservation_billing_ownership, params)
  req.send_request(options)
end

#accept_reserved_instances_exchange_quote(params = {}) ⇒ Types::AcceptReservedInstancesExchangeQuoteResult

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

Examples:

Request syntax with placeholder values


resp = client.accept_reserved_instances_exchange_quote({
  dry_run: false,
  reserved_instance_ids: ["ReservationId"], # required
  target_configurations: [
    {
      instance_count: 1,
      offering_id: "ReservedInstancesOfferingId", # required
    },
  ],
})

Response structure


resp.exchange_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :reserved_instance_ids (required, Array<String>) —

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

  • :target_configurations (Array<Types::TargetConfigurationRequest>) —

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

Returns:

See Also:



601
602
603
604
 
# File 'lib/aws-sdk-ec2/client.rb', line 601

def accept_reserved_instances_exchange_quote(params = {}, options = {})
  req = build_request(:accept_reserved_instances_exchange_quote, params)
  req.send_request(options)
end

#accept_transit_gateway_multicast_domain_associations(params = {}) ⇒ Types::AcceptTransitGatewayMulticastDomainAssociationsResult

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

Examples:

Request syntax with placeholder values


resp = client.accept_transit_gateway_multicast_domain_associations({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId",
  transit_gateway_attachment_id: "TransitGatewayAttachmentId",
  subnet_ids: ["String"],
  dry_run: false,
})

Response structure


resp.associations.transit_gateway_multicast_domain_id #=> String
resp.associations.transit_gateway_attachment_id #=> String
resp.associations.resource_id #=> String
resp.associations.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.associations.resource_owner_id #=> String
resp.associations.subnets #=> Array
resp.associations.subnets[0].subnet_id #=> String
resp.associations.subnets[0].state #=> String, one of "pendingAcceptance", "associating", "associated", "disassociating", "disassociated", "rejected", "failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (String) —

    The ID of the transit gateway multicast domain.

  • :transit_gateway_attachment_id (String) —

    The ID of the transit gateway attachment.

  • :subnet_ids (Array<String>) —

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

  • :dry_run (Boolean) —

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

Returns:

See Also:



653
654
655
656
 
# File 'lib/aws-sdk-ec2/client.rb', line 653

def accept_transit_gateway_multicast_domain_associations(params = {}, options = {})
  req = build_request(:accept_transit_gateway_multicast_domain_associations, params)
  req.send_request(options)
end

#accept_transit_gateway_peering_attachment(params = {}) ⇒ Types::AcceptTransitGatewayPeeringAttachmentResult

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

Examples:

Request syntax with placeholder values


resp = client.accept_transit_gateway_peering_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_peering_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachment.accepter_transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.region #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.region #=> String
resp.transit_gateway_peering_attachment.options.dynamic_routing #=> String, one of "enable", "disable"
resp.transit_gateway_peering_attachment.status.code #=> String
resp.transit_gateway_peering_attachment.status.message #=> String
resp.transit_gateway_peering_attachment.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_peering_attachment.creation_time #=> Time
resp.transit_gateway_peering_attachment.tags #=> Array
resp.transit_gateway_peering_attachment.tags[0].key #=> String
resp.transit_gateway_peering_attachment.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the transit gateway attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



706
707
708
709
 
# File 'lib/aws-sdk-ec2/client.rb', line 706

def accept_transit_gateway_peering_attachment(params = {}, options = {})
  req = build_request(:accept_transit_gateway_peering_attachment, params)
  req.send_request(options)
end

#accept_transit_gateway_vpc_attachment(params = {}) ⇒ Types::AcceptTransitGatewayVpcAttachmentResult

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.

Examples:

Request syntax with placeholder values


resp = client.accept_transit_gateway_vpc_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_vpc_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_vpc_attachment.transit_gateway_id #=> String
resp.transit_gateway_vpc_attachment.vpc_id #=> String
resp.transit_gateway_vpc_attachment.vpc_owner_id #=> String
resp.transit_gateway_vpc_attachment.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_vpc_attachment.subnet_ids #=> Array
resp.transit_gateway_vpc_attachment.subnet_ids[0] #=> String
resp.transit_gateway_vpc_attachment.creation_time #=> Time
resp.transit_gateway_vpc_attachment.options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.ipv_6_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.appliance_mode_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.tags #=> Array
resp.transit_gateway_vpc_attachment.tags[0].key #=> String
resp.transit_gateway_vpc_attachment.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



760
761
762
763
 
# File 'lib/aws-sdk-ec2/client.rb', line 760

def accept_transit_gateway_vpc_attachment(params = {}, options = {})
  req = build_request(:accept_transit_gateway_vpc_attachment, params)
  req.send_request(options)
end

#accept_vpc_endpoint_connections(params = {}) ⇒ Types::AcceptVpcEndpointConnectionsResult

Accepts connection requests to your VPC endpoint service.

Examples:

Request syntax with placeholder values


resp = client.accept_vpc_endpoint_connections({
  dry_run: false,
  service_id: "VpcEndpointServiceId", # required
  vpc_endpoint_ids: ["VpcEndpointId"], # required
})

Response structure


resp.unsuccessful #=> Array
resp.unsuccessful[0].error.code #=> String
resp.unsuccessful[0].error.message #=> String
resp.unsuccessful[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_id (required, String) —

    The ID of the VPC endpoint service.

  • :vpc_endpoint_ids (required, Array<String>) —

    The IDs of the interface VPC endpoints.

Returns:

See Also:



802
803
804
805
 
# File 'lib/aws-sdk-ec2/client.rb', line 802

def accept_vpc_endpoint_connections(params = {}, options = {})
  req = build_request(:accept_vpc_endpoint_connections, params)
  req.send_request(options)
end

#accept_vpc_peering_connection(params = {}) ⇒ Types::AcceptVpcPeeringConnectionResult

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.

Examples:

Request syntax with placeholder values


resp = client.accept_vpc_peering_connection({
  dry_run: false,
  vpc_peering_connection_id: "VpcPeeringConnectionIdWithResolver", # required
})

Response structure


resp.vpc_peering_connection.accepter_vpc_info.cidr_block #=> String
resp.vpc_peering_connection.accepter_vpc_info.ipv_6_cidr_block_set #=> Array
resp.vpc_peering_connection.accepter_vpc_info.ipv_6_cidr_block_set[0].ipv_6_cidr_block #=> String
resp.vpc_peering_connection.accepter_vpc_info.cidr_block_set #=> Array
resp.vpc_peering_connection.accepter_vpc_info.cidr_block_set[0].cidr_block #=> String
resp.vpc_peering_connection.accepter_vpc_info.owner_id #=> String
resp.vpc_peering_connection.accepter_vpc_info.peering_options.allow_dns_resolution_from_remote_vpc #=> Boolean
resp.vpc_peering_connection.accepter_vpc_info.peering_options.allow_egress_from_local_classic_link_to_remote_vpc #=> Boolean
resp.vpc_peering_connection.accepter_vpc_info.peering_options.allow_egress_from_local_vpc_to_remote_classic_link #=> Boolean
resp.vpc_peering_connection.accepter_vpc_info.vpc_id #=> String
resp.vpc_peering_connection.accepter_vpc_info.region #=> String
resp.vpc_peering_connection.expiration_time #=> Time
resp.vpc_peering_connection.requester_vpc_info.cidr_block #=> String
resp.vpc_peering_connection.requester_vpc_info.ipv_6_cidr_block_set #=> Array
resp.vpc_peering_connection.requester_vpc_info.ipv_6_cidr_block_set[0].ipv_6_cidr_block #=> String
resp.vpc_peering_connection.requester_vpc_info.cidr_block_set #=> Array
resp.vpc_peering_connection.requester_vpc_info.cidr_block_set[0].cidr_block #=> String
resp.vpc_peering_connection.requester_vpc_info.owner_id #=> String
resp.vpc_peering_connection.requester_vpc_info.peering_options.allow_dns_resolution_from_remote_vpc #=> Boolean
resp.vpc_peering_connection.requester_vpc_info.peering_options.allow_egress_from_local_classic_link_to_remote_vpc #=> Boolean
resp.vpc_peering_connection.requester_vpc_info.peering_options.allow_egress_from_local_vpc_to_remote_classic_link #=> Boolean
resp.vpc_peering_connection.requester_vpc_info.vpc_id #=> String
resp.vpc_peering_connection.requester_vpc_info.region #=> String
resp.vpc_peering_connection.status.code #=> String, one of "initiating-request", "pending-acceptance", "active", "deleted", "rejected", "failed", "expired", "provisioning", "deleting"
resp.vpc_peering_connection.status.message #=> String
resp.vpc_peering_connection.tags #=> Array
resp.vpc_peering_connection.tags[0].key #=> String
resp.vpc_peering_connection.tags[0].value #=> String
resp.vpc_peering_connection.vpc_peering_connection_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_peering_connection_id (required, String) —

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

Returns:

See Also:



872
873
874
875
 
# File 'lib/aws-sdk-ec2/client.rb', line 872

def accept_vpc_peering_connection(params = {}, options = {})
  req = build_request(:accept_vpc_peering_connection, params)
  req.send_request(options)
end

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.

Examples:

Request syntax with placeholder values


resp = client.advertise_byoip_cidr({
  cidr: "String", # required
  asn: "String",
  dry_run: false,
  network_border_group: "String",
})

Response structure


resp.byoip_cidr.cidr #=> String
resp.byoip_cidr.description #=> String
resp.byoip_cidr.asn_associations #=> Array
resp.byoip_cidr.asn_associations[0].asn #=> String
resp.byoip_cidr.asn_associations[0].cidr #=> String
resp.byoip_cidr.asn_associations[0].status_message #=> String
resp.byoip_cidr.asn_associations[0].state #=> String, one of "disassociated", "failed-disassociation", "failed-association", "pending-disassociation", "pending-association", "associated"
resp.byoip_cidr.status_message #=> String
resp.byoip_cidr.state #=> String, one of "advertised", "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned", "provisioned-not-publicly-advertisable"
resp.byoip_cidr.network_border_group #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr (required, 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.

  • :dry_run (Boolean) —

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

  • :network_border_group (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 markdown=“1”> You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

    </note>

    [1]: docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html

Returns:

See Also:



966
967
968
969
 
# File 'lib/aws-sdk-ec2/client.rb', line 966

def advertise_byoip_cidr(params = {}, options = {})
  req = build_request(:advertise_byoip_cidr, params)
  req.send_request(options)
end

#allocate_address(params = {}) ⇒ Types::AllocateAddressResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html

Examples:

Example: To allocate an Elastic IP address


# This example allocates an Elastic IP address.

resp = client.allocate_address({
})

resp.to_h outputs the following:
{
  allocation_id: "eipalloc-64d5890a", 
  domain: "vpc", 
  network_border_group: "us-east-1", 
  public_ip: "203.0.113.0", 
  public_ipv_4_pool: "amazon", 
}

Request syntax with placeholder values


resp = client.allocate_address({
  domain: "vpc", # accepts vpc, standard
  address: "PublicIpAddress",
  public_ipv_4_pool: "Ipv4PoolEc2Id",
  network_border_group: "String",
  customer_owned_ipv_4_pool: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  ipam_pool_id: "IpamPoolId",
  dry_run: false,
})

Response structure


resp.allocation_id #=> String
resp.public_ipv_4_pool #=> String
resp.network_border_group #=> String
resp.domain #=> String, one of "vpc", "standard"
resp.customer_owned_ip #=> String
resp.customer_owned_ipv_4_pool #=> String
resp.carrier_ip #=> String
resp.public_ip #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain (String) —

    The network (‘vpc`).

  • :address (String) —

    The Elastic IP address to recover or an IPv4 address from an address pool.

  • :public_ipv_4_pool (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.

  • :network_border_group (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.

  • :customer_owned_ipv_4_pool (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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the Elastic IP address.

  • :ipam_pool_id (String) —

    The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see [Allocate sequential Elastic IP addresses from an IPAM pool] in the *Amazon VPC IPAM User Guide*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/tutorials-eip-pool.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



1111
1112
1113
1114
 
# File 'lib/aws-sdk-ec2/client.rb', line 1111

def allocate_address(params = {}, options = {})
  req = build_request(:allocate_address, params)
  req.send_request(options)
end

#allocate_hosts(params = {}) ⇒ Types::AllocateHostsResult

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.

Examples:

Request syntax with placeholder values


resp = client.allocate_hosts({
  instance_family: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  host_recovery: "on", # accepts on, off
  outpost_arn: "String",
  host_maintenance: "on", # accepts on, off
  asset_ids: ["AssetId"],
  auto_placement: "on", # accepts on, off
  client_token: "String",
  instance_type: "String",
  quantity: 1,
  availability_zone: "String", # required
})

Response structure


resp.host_ids #=> Array
resp.host_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_family (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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the Dedicated Host during creation.

  • :host_recovery (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][1

    in the *Amazon EC2 User Guide*.

    Default: ‘off`

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html

  • :outpost_arn (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.

  • :host_maintenance (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html

  • :asset_ids (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.

  • :auto_placement (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`

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :instance_type (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.

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

  • :availability_zone (required, String) —

    The Availability Zone in which to allocate the Dedicated Host.

Returns:

See Also:



1258
1259
1260
1261
 
# File 'lib/aws-sdk-ec2/client.rb', line 1258

def allocate_hosts(params = {}, options = {})
  req = build_request(:allocate_hosts, params)
  req.send_request(options)
end

#allocate_ipam_pool_cidr(params = {}) ⇒ Types::AllocateIpamPoolCidrResult

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][1

in the *Amazon VPC IPAM User Guide*.

<note markdown=“1”> This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.

</note>

[1]: docs.aws.amazon.com/vpc/latest/ipam/allocate-cidrs-ipam.html

Examples:

Request syntax with placeholder values


resp = client.allocate_ipam_pool_cidr({
  dry_run: false,
  ipam_pool_id: "IpamPoolId", # required
  cidr: "String",
  netmask_length: 1,
  client_token: "String",
  description: "String",
  preview_next_cidr: false,
  allowed_cidrs: ["String"],
  disallowed_cidrs: ["String"],
})

Response structure


resp.ipam_pool_allocation.cidr #=> String
resp.ipam_pool_allocation.ipam_pool_allocation_id #=> String
resp.ipam_pool_allocation.description #=> String
resp.ipam_pool_allocation.resource_id #=> String
resp.ipam_pool_allocation.resource_type #=> String, one of "ipam-pool", "vpc", "ec2-public-ipv4-pool", "custom", "subnet", "eip"
resp.ipam_pool_allocation.resource_region #=> String
resp.ipam_pool_allocation.resource_owner #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_pool_id (required, 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.

  • :netmask_length (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.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :description (String) —

    A description for the allocation.

  • :preview_next_cidr (Boolean) —

    A preview of the next available CIDR in a pool.

  • :allowed_cidrs (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.

  • :disallowed_cidrs (Array<String>) —

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

Returns:

See Also:



1376
1377
1378
1379
 
# File 'lib/aws-sdk-ec2/client.rb', line 1376

def allocate_ipam_pool_cidr(params = {}, options = {})
  req = build_request(:allocate_ipam_pool_cidr, params)
  req.send_request(options)
end

#apply_security_groups_to_client_vpn_target_network(params = {}) ⇒ Types::ApplySecurityGroupsToClientVpnTargetNetworkResult

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.

Examples:

Request syntax with placeholder values


resp = client.apply_security_groups_to_client_vpn_target_network({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  vpc_id: "VpcId", # required
  security_group_ids: ["SecurityGroupId"], # required
  dry_run: false,
})

Response structure


resp.security_group_ids #=> Array
resp.security_group_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint.

  • :vpc_id (required, String) —

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

  • :security_group_ids (required, 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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



1424
1425
1426
1427
 
# File 'lib/aws-sdk-ec2/client.rb', line 1424

def apply_security_groups_to_client_vpn_target_network(params = {}, options = {})
  req = build_request(:apply_security_groups_to_client_vpn_target_network, params)
  req.send_request(options)
end

#assign_ipv_6_addresses(params = {}) ⇒ Types::AssignIpv6AddressesResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html

Examples:

Request syntax with placeholder values


resp = client.assign_ipv_6_addresses({
  ipv_6_prefix_count: 1,
  ipv_6_prefixes: ["String"],
  network_interface_id: "NetworkInterfaceId", # required
  ipv_6_addresses: ["String"],
  ipv_6_address_count: 1,
})

Response structure


resp.assigned_ipv_6_addresses #=> Array
resp.assigned_ipv_6_addresses[0] #=> String
resp.assigned_ipv_6_prefixes #=> Array
resp.assigned_ipv_6_prefixes[0] #=> String
resp.network_interface_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ipv_6_prefix_count (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.

  • :ipv_6_prefixes (Array<String>) —

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

  • :network_interface_id (required, String) —

    The ID of the network interface.

  • :ipv_6_addresses (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.

  • :ipv_6_address_count (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.

Returns:

See Also:



1500
1501
1502
1503
 
# File 'lib/aws-sdk-ec2/client.rb', line 1500

def assign_ipv_6_addresses(params = {}, options = {})
  req = build_request(:assign_ipv_6_addresses, params)
  req.send_request(options)
end

#assign_private_ip_addresses(params = {}) ⇒ Types::AssignPrivateIpAddressesResult

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][1

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html

Examples:

Example: 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.

resp = client.assign_private_ip_addresses({
  network_interface_id: "eni-e5aa89a3", 
  private_ip_addresses: [
    "10.0.0.82", 
  ], 
})

Example: 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.

resp = client.assign_private_ip_addresses({
  network_interface_id: "eni-e5aa89a3", 
  secondary_private_ip_address_count: 2, 
})

Request syntax with placeholder values


resp = client.assign_private_ip_addresses({
  ipv_4_prefixes: ["String"],
  ipv_4_prefix_count: 1,
  network_interface_id: "NetworkInterfaceId", # required
  private_ip_addresses: ["String"],
  secondary_private_ip_address_count: 1,
  allow_reassignment: false,
})

Response structure


resp.network_interface_id #=> String
resp.assigned_private_ip_addresses #=> Array
resp.assigned_private_ip_addresses[0].private_ip_address #=> String
resp.assigned_ipv_4_prefixes #=> Array
resp.assigned_ipv_4_prefixes[0].ipv_4_prefix #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ipv_4_prefixes (Array<String>) —

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

  • :ipv_4_prefix_count (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.

  • :network_interface_id (required, String) —

    The ID of the network interface.

  • :private_ip_addresses (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.

  • :secondary_private_ip_address_count (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.

  • :allow_reassignment (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.

Returns:

See Also:



1619
1620
1621
1622
 
# File 'lib/aws-sdk-ec2/client.rb', line 1619

def assign_private_ip_addresses(params = {}, options = {})
  req = build_request(:assign_private_ip_addresses, params)
  req.send_request(options)
end

#assign_private_nat_gateway_address(params = {}) ⇒ Types::AssignPrivateNatGatewayAddressResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-working-with

Examples:

Request syntax with placeholder values


resp = client.assign_private_nat_gateway_address({
  nat_gateway_id: "NatGatewayId", # required
  private_ip_addresses: ["String"],
  private_ip_address_count: 1,
  dry_run: false,
})

Response structure


resp.nat_gateway_id #=> String
resp.nat_gateway_addresses #=> Array
resp.nat_gateway_addresses[0].allocation_id #=> String
resp.nat_gateway_addresses[0].network_interface_id #=> String
resp.nat_gateway_addresses[0].private_ip #=> String
resp.nat_gateway_addresses[0].public_ip #=> String
resp.nat_gateway_addresses[0].association_id #=> String
resp.nat_gateway_addresses[0].is_primary #=> Boolean
resp.nat_gateway_addresses[0].failure_message #=> String
resp.nat_gateway_addresses[0].status #=> String, one of "assigning", "unassigning", "associating", "disassociating", "succeeded", "failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :nat_gateway_id (required, String) —

    The ID of the NAT gateway.

  • :private_ip_addresses (Array<String>) —

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

  • :private_ip_address_count (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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



1681
1682
1683
1684
 
# File 'lib/aws-sdk-ec2/client.rb', line 1681

def assign_private_nat_gateway_address(params = {}, options = {})
  req = build_request(:assign_private_nat_gateway_address, params)
  req.send_request(options)
end

#associate_address(params = {}) ⇒ Types::AssociateAddressResult

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

[1]: aws.amazon.com/ec2/pricing/

Examples:

Example: To associate an Elastic IP address


# This example associates the specified Elastic IP address with the specified instance.

resp = client.associate_address({
  allocation_id: "eipalloc-64d5890a", 
  instance_id: "i-0b263919b6498b123", 
})

resp.to_h outputs the following:
{
  association_id: "eipassoc-2bebb745", 
}

Example: To associate an Elastic IP address with a network interface


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

resp = client.associate_address({
  allocation_id: "eipalloc-64d5890a", 
  network_interface_id: "eni-1a2b3c4d", 
})

resp.to_h outputs the following:
{
  association_id: "eipassoc-2bebb745", 
}

Request syntax with placeholder values


resp = client.associate_address({
  allocation_id: "AllocationId",
  instance_id: "InstanceId",
  public_ip: "EipAllocationPublicIp",
  dry_run: false,
  network_interface_id: "NetworkInterfaceId",
  private_ip_address: "String",
  allow_reassociation: false,
})

Response structure


resp.association_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_id (String) —

    The allocation ID. This is required.

  • :instance_id (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.

  • :public_ip (String) —

    Deprecated.

  • :dry_run (Boolean) —

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

  • :network_interface_id (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.

  • :private_ip_address (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.

  • :allow_reassociation (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.

Returns:

See Also:



1801
1802
1803
1804
 
# File 'lib/aws-sdk-ec2/client.rb', line 1801

def associate_address(params = {}, options = {})
  req = build_request(:associate_address, params)
  req.send_request(options)
end

#associate_capacity_reservation_billing_owner(params = {}) ⇒ Types::AssociateCapacityReservationBillingOwnerResult

Initiates a request to assign billing of the unused capacity of a shared Capacity Reservation to a consumer account that is consolidated under the same Amazon Web Services organizations payer account. For more information, see [Billing assignment for shared Amazon EC2 Capacity Reservations].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html

Examples:

Request syntax with placeholder values


resp = client.associate_capacity_reservation_billing_owner({
  dry_run: false,
  capacity_reservation_id: "CapacityReservationId", # required
  unused_reservation_billing_owner_id: "AccountID", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation.

  • :unused_reservation_billing_owner_id (required, String) —

    The ID of the consumer account to which assign billing.

Returns:

See Also:



1848
1849
1850
1851
 
# File 'lib/aws-sdk-ec2/client.rb', line 1848

def associate_capacity_reservation_billing_owner(params = {}, options = {})
  req = build_request(:associate_capacity_reservation_billing_owner, params)
  req.send_request(options)
end

#associate_client_vpn_target_network(params = {}) ⇒ Types::AssociateClientVpnTargetNetworkResult

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.

Examples:

Request syntax with placeholder values


resp = client.associate_client_vpn_target_network({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  subnet_id: "SubnetId", # required
  client_token: "String",
  dry_run: false,
})

Response structure


resp.association_id #=> String
resp.status.code #=> String, one of "associating", "associated", "association-failed", "disassociating", "disassociated"
resp.status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint.

  • :subnet_id (required, String) —

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



1913
1914
1915
1916
 
# File 'lib/aws-sdk-ec2/client.rb', line 1913

def associate_client_vpn_target_network(params = {}, options = {})
  req = build_request(:associate_client_vpn_target_network, params)
  req.send_request(options)
end

#associate_dhcp_options(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html

Examples:

Example: To associate a DHCP options set with a VPC


# This example associates the specified DHCP options set with the specified VPC.

resp = client.associate_dhcp_options({
  dhcp_options_id: "dopt-d9070ebb", 
  vpc_id: "vpc-a01106c2", 
})

Example: To associate the default DHCP options set with a VPC


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

resp = client.associate_dhcp_options({
  dhcp_options_id: "default", 
  vpc_id: "vpc-a01106c2", 
})

Request syntax with placeholder values


resp = client.associate_dhcp_options({
  dhcp_options_id: "DefaultingDhcpOptionsId", # required
  vpc_id: "VpcId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dhcp_options_id (required, String) —

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

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1981
1982
1983
1984
 
# File 'lib/aws-sdk-ec2/client.rb', line 1981

def associate_dhcp_options(params = {}, options = {})
  req = build_request(:associate_dhcp_options, params)
  req.send_request(options)
end

#associate_enclave_certificate_iam_role(params = {}) ⇒ Types::AssociateEnclaveCertificateIamRoleResult

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

[1]: docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html [2]: docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html#add-policy

Examples:

Request syntax with placeholder values


resp = client.associate_enclave_certificate_iam_role({
  certificate_arn: "CertificateId", # required
  role_arn: "RoleId", # required
  dry_run: false,
})

Response structure


resp.certificate_s3_bucket_name #=> String
resp.certificate_s3_object_key #=> String
resp.encryption_kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :certificate_arn (required, String) —

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

  • :role_arn (required, 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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



2049
2050
2051
2052
 
# File 'lib/aws-sdk-ec2/client.rb', line 2049

def associate_enclave_certificate_iam_role(params = {}, options = {})
  req = build_request(:associate_enclave_certificate_iam_role, params)
  req.send_request(options)
end

#associate_iam_instance_profile(params = {}) ⇒ Types::AssociateIamInstanceProfileResult

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

Examples:

Example: To associate an IAM instance profile with an instance


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

resp = client.associate_iam_instance_profile({
  iam_instance_profile: {
    name: "admin-role", 
  }, 
  instance_id: "i-123456789abcde123", 
})

resp.to_h outputs the following:
{
  iam_instance_profile_association: {
    association_id: "iip-assoc-0e7736511a163c209", 
    iam_instance_profile: {
      arn: "arn:aws:iam::123456789012:instance-profile/admin-role", 
      id: "AIPAJBLK7RKJKWDXVHIEC", 
    }, 
    instance_id: "i-123456789abcde123", 
    state: "associating", 
  }, 
}

Request syntax with placeholder values


resp = client.associate_iam_instance_profile({
  iam_instance_profile: { # required
    arn: "String",
    name: "String",
  },
  instance_id: "InstanceId", # required
})

Response structure


resp.iam_instance_profile_association.association_id #=> String
resp.iam_instance_profile_association.instance_id #=> String
resp.iam_instance_profile_association.iam_instance_profile.arn #=> String
resp.iam_instance_profile_association.iam_instance_profile.id #=> String
resp.iam_instance_profile_association.state #=> String, one of "associating", "associated", "disassociating", "disassociated"
resp.iam_instance_profile_association.timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



2116
2117
2118
2119
 
# File 'lib/aws-sdk-ec2/client.rb', line 2116

def associate_iam_instance_profile(params = {}, options = {})
  req = build_request(:associate_iam_instance_profile, params)
  req.send_request(options)
end

#associate_instance_event_window(params = {}) ⇒ Types::AssociateInstanceEventWindowResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html

Examples:

Request syntax with placeholder values


resp = client.associate_instance_event_window({
  dry_run: false,
  instance_event_window_id: "InstanceEventWindowId", # required
  association_target: { # required
    instance_ids: ["InstanceId"],
    instance_tags: [
      {
        key: "String",
        value: "String",
      },
    ],
    dedicated_host_ids: ["DedicatedHostId"],
  },
})

Response structure


resp.instance_event_window.instance_event_window_id #=> String
resp.instance_event_window.time_ranges #=> Array
resp.instance_event_window.time_ranges[0].start_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_window.time_ranges[0].start_hour #=> Integer
resp.instance_event_window.time_ranges[0].end_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_window.time_ranges[0].end_hour #=> Integer
resp.instance_event_window.name #=> String
resp.instance_event_window.cron_expression #=> String
resp.instance_event_window.association_target.instance_ids #=> Array
resp.instance_event_window.association_target.instance_ids[0] #=> String
resp.instance_event_window.association_target.tags #=> Array
resp.instance_event_window.association_target.tags[0].key #=> String
resp.instance_event_window.association_target.tags[0].value #=> String
resp.instance_event_window.association_target.dedicated_host_ids #=> Array
resp.instance_event_window.association_target.dedicated_host_ids[0] #=> String
resp.instance_event_window.state #=> String, one of "creating", "deleting", "active", "deleted"
resp.instance_event_window.tags #=> Array
resp.instance_event_window.tags[0].key #=> String
resp.instance_event_window.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_event_window_id (required, String) —

    The ID of the event window.

  • :association_target (required, Types::InstanceEventWindowAssociationRequest) —

    One or more targets associated with the specified event window.

Returns:

See Also:



2191
2192
2193
2194
 
# File 'lib/aws-sdk-ec2/client.rb', line 2191

def associate_instance_event_window(params = {}, options = {})
  req = build_request(:associate_instance_event_window, params)
  req.send_request(options)
end

#associate_ipam_byoasn(params = {}) ⇒ Types::AssociateIpamByoasnResult

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

[1]: docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeByoipCidrs.html [3]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AdvertiseByoipCidr.html

Examples:

Request syntax with placeholder values


resp = client.associate_ipam_byoasn({
  dry_run: false,
  asn: "String", # required
  cidr: "String", # required
})

Response structure


resp.asn_association.asn #=> String
resp.asn_association.cidr #=> String
resp.asn_association.status_message #=> String
resp.asn_association.state #=> String, one of "disassociated", "failed-disassociation", "failed-association", "pending-disassociation", "pending-association", "associated"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    A public 2-byte or 4-byte ASN.

  • :cidr (required, String) —

    The BYOIP CIDR you want to associate with an ASN.

Returns:

See Also:



2246
2247
2248
2249
 
# File 'lib/aws-sdk-ec2/client.rb', line 2246

def associate_ipam_byoasn(params = {}, options = {})
  req = build_request(:associate_ipam_byoasn, params)
  req.send_request(options)
end

#associate_ipam_resource_discovery(params = {}) ⇒ Types::AssociateIpamResourceDiscoveryResult

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.

Examples:

Request syntax with placeholder values


resp = client.associate_ipam_resource_discovery({
  dry_run: false,
  ipam_id: "IpamId", # required
  ipam_resource_discovery_id: "IpamResourceDiscoveryId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
})

Response structure


resp.ipam_resource_discovery_association.owner_id #=> String
resp.ipam_resource_discovery_association.ipam_resource_discovery_association_id #=> String
resp.ipam_resource_discovery_association.ipam_resource_discovery_association_arn #=> String
resp.ipam_resource_discovery_association.ipam_resource_discovery_id #=> String
resp.ipam_resource_discovery_association.ipam_id #=> String
resp.ipam_resource_discovery_association.ipam_arn #=> String
resp.ipam_resource_discovery_association.ipam_region #=> String
resp.ipam_resource_discovery_association.is_default #=> Boolean
resp.ipam_resource_discovery_association.resource_discovery_status #=> String, one of "active", "not-found"
resp.ipam_resource_discovery_association.state #=> String, one of "associate-in-progress", "associate-complete", "associate-failed", "disassociate-in-progress", "disassociate-complete", "disassociate-failed", "isolate-in-progress", "isolate-complete", "restore-in-progress"
resp.ipam_resource_discovery_association.tags #=> Array
resp.ipam_resource_discovery_association.tags[0].key #=> String
resp.ipam_resource_discovery_association.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_id (required, String) —

    An IPAM ID.

  • :ipam_resource_discovery_id (required, String) —

    A resource discovery ID.

  • :tag_specifications (Array<Types::TagSpecification>) —

    Tag specifications.

  • :client_token (String) —

    A client token.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



2320
2321
2322
2323
 
# File 'lib/aws-sdk-ec2/client.rb', line 2320

def associate_ipam_resource_discovery(params = {}, options = {})
  req = build_request(:associate_ipam_resource_discovery, params)
  req.send_request(options)
end

#associate_nat_gateway_address(params = {}) ⇒ Types::AssociateNatGatewayAddressResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-working-with [2]: docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-eips [3]: docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip

Examples:

Request syntax with placeholder values


resp = client.associate_nat_gateway_address({
  nat_gateway_id: "NatGatewayId", # required
  allocation_ids: ["AllocationId"], # required
  private_ip_addresses: ["String"],
  dry_run: false,
})

Response structure


resp.nat_gateway_id #=> String
resp.nat_gateway_addresses #=> Array
resp.nat_gateway_addresses[0].allocation_id #=> String
resp.nat_gateway_addresses[0].network_interface_id #=> String
resp.nat_gateway_addresses[0].private_ip #=> String
resp.nat_gateway_addresses[0].public_ip #=> String
resp.nat_gateway_addresses[0].association_id #=> String
resp.nat_gateway_addresses[0].is_primary #=> Boolean
resp.nat_gateway_addresses[0].failure_message #=> String
resp.nat_gateway_addresses[0].status #=> String, one of "assigning", "unassigning", "associating", "disassociating", "succeeded", "failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :nat_gateway_id (required, String) —

    The ID of the NAT gateway.

  • :allocation_ids (required, Array<String>) —

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

  • :private_ip_addresses (Array<String>) —

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

  • :dry_run (Boolean) —

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

Returns:

See Also:



2397
2398
2399
2400
 
# File 'lib/aws-sdk-ec2/client.rb', line 2397

def associate_nat_gateway_address(params = {}, options = {})
  req = build_request(:associate_nat_gateway_address, params)
  req.send_request(options)
end

#associate_route_table(params = {}) ⇒ Types::AssociateRouteTableResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html

Examples:

Example: To associate a route table with a subnet


# This example associates the specified route table with the specified subnet.

resp = client.associate_route_table({
  route_table_id: "rtb-22574640", 
  subnet_id: "subnet-9d4a7b6", 
})

resp.to_h outputs the following:
{
  association_id: "rtbassoc-781d0d1a", 
}

Request syntax with placeholder values


resp = client.associate_route_table({
  gateway_id: "RouteGatewayId",
  dry_run: false,
  subnet_id: "SubnetId",
  route_table_id: "RouteTableId", # required
})

Response structure


resp.association_id #=> String
resp.association_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failed"
resp.association_state.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :gateway_id (String) —

    The ID of the internet gateway or virtual private gateway.

  • :dry_run (Boolean) —

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

  • :subnet_id (String) —

    The ID of the subnet.

  • :route_table_id (required, String) —

    The ID of the route table.

Returns:

See Also:



2470
2471
2472
2473
 
# File 'lib/aws-sdk-ec2/client.rb', line 2470

def associate_route_table(params = {}, options = {})
  req = build_request(:associate_route_table, params)
  req.send_request(options)
end

#associate_subnet_cidr_block(params = {}) ⇒ Types::AssociateSubnetCidrBlockResult

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

Examples:

Request syntax with placeholder values


resp = client.associate_subnet_cidr_block({
  ipv_6_ipam_pool_id: "IpamPoolId",
  ipv_6_netmask_length: 1,
  subnet_id: "SubnetId", # required
  ipv_6_cidr_block: "String",
})

Response structure


resp.ipv_6_cidr_block_association.association_id #=> String
resp.ipv_6_cidr_block_association.ipv_6_cidr_block #=> String
resp.ipv_6_cidr_block_association.ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.ipv_6_cidr_block_association.ipv_6_cidr_block_state.status_message #=> String
resp.ipv_6_cidr_block_association.ipv_6_address_attribute #=> String, one of "public", "private"
resp.ipv_6_cidr_block_association.ip_source #=> String, one of "amazon", "byoip", "none"
resp.subnet_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ipv_6_ipam_pool_id (String) —

    An IPv6 IPAM pool ID.

  • :ipv_6_netmask_length (Integer) —

    An IPv6 netmask length.

  • :subnet_id (required, String) —

    The ID of your subnet.

  • :ipv_6_cidr_block (String) —

    The IPv6 CIDR block for your subnet.

Returns:

See Also:



2518
2519
2520
2521
 
# File 'lib/aws-sdk-ec2/client.rb', line 2518

def associate_subnet_cidr_block(params = {}, options = {})
  req = build_request(:associate_subnet_cidr_block, params)
  req.send_request(options)
end

#associate_transit_gateway_multicast_domain(params = {}) ⇒ Types::AssociateTransitGatewayMulticastDomainResult

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html

Examples:

Request syntax with placeholder values


resp = client.associate_transit_gateway_multicast_domain({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  subnet_ids: ["SubnetId"], # required
  dry_run: false,
})

Response structure


resp.associations.transit_gateway_multicast_domain_id #=> String
resp.associations.transit_gateway_attachment_id #=> String
resp.associations.resource_id #=> String
resp.associations.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.associations.resource_owner_id #=> String
resp.associations.subnets #=> Array
resp.associations.subnets[0].subnet_id #=> String
resp.associations.subnets[0].state #=> String, one of "pendingAcceptance", "associating", "associated", "disassociating", "disassociated", "rejected", "failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (required, String) —

    The ID of the transit gateway multicast domain.

  • :transit_gateway_attachment_id (required, String) —

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

  • :subnet_ids (required, Array<String>) —

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

  • :dry_run (Boolean) —

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

Returns:

See Also:



2579
2580
2581
2582
 
# File 'lib/aws-sdk-ec2/client.rb', line 2579

def associate_transit_gateway_multicast_domain(params = {}, options = {})
  req = build_request(:associate_transit_gateway_multicast_domain, params)
  req.send_request(options)
end

#associate_transit_gateway_policy_table(params = {}) ⇒ Types::AssociateTransitGatewayPolicyTableResult

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

Examples:

Request syntax with placeholder values


resp = client.associate_transit_gateway_policy_table({
  transit_gateway_policy_table_id: "TransitGatewayPolicyTableId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.association.transit_gateway_policy_table_id #=> String
resp.association.transit_gateway_attachment_id #=> String
resp.association.resource_id #=> String
resp.association.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.association.state #=> String, one of "associating", "associated", "disassociating", "disassociated"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_policy_table_id (required, String) —

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

  • :transit_gateway_attachment_id (required, String) —

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

  • :dry_run (Boolean) —

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

Returns:

See Also:



2625
2626
2627
2628
 
# File 'lib/aws-sdk-ec2/client.rb', line 2625

def associate_transit_gateway_policy_table(params = {}, options = {})
  req = build_request(:associate_transit_gateway_policy_table, params)
  req.send_request(options)
end

#associate_transit_gateway_route_table(params = {}) ⇒ Types::AssociateTransitGatewayRouteTableResult

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

Examples:

Request syntax with placeholder values


resp = client.associate_transit_gateway_route_table({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.association.transit_gateway_route_table_id #=> String
resp.association.transit_gateway_attachment_id #=> String
resp.association.resource_id #=> String
resp.association.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.association.state #=> String, one of "associating", "associated", "disassociating", "disassociated"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :transit_gateway_attachment_id (required, String) —

    The ID of the attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



2670
2671
2672
2673
 
# File 'lib/aws-sdk-ec2/client.rb', line 2670

def associate_transit_gateway_route_table(params = {}, options = {})
  req = build_request(:associate_transit_gateway_route_table, params)
  req.send_request(options)
end

#associate_trunk_interface(params = {}) ⇒ Types::AssociateTrunkInterfaceResult

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html

Examples:

Request syntax with placeholder values


resp = client.associate_trunk_interface({
  branch_interface_id: "NetworkInterfaceId", # required
  trunk_interface_id: "NetworkInterfaceId", # required
  vlan_id: 1,
  gre_key: 1,
  client_token: "String",
  dry_run: false,
})

Response structure


resp.interface_association.association_id #=> String
resp.interface_association.branch_interface_id #=> String
resp.interface_association.trunk_interface_id #=> String
resp.interface_association.interface_protocol #=> String, one of "VLAN", "GRE"
resp.interface_association.vlan_id #=> Integer
resp.interface_association.gre_key #=> Integer
resp.interface_association.tags #=> Array
resp.interface_association.tags[0].key #=> String
resp.interface_association.tags[0].value #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :branch_interface_id (required, String) —

    The ID of the branch network interface.

  • :trunk_interface_id (required, String) —

    The ID of the trunk network interface.

  • :vlan_id (Integer) —

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

  • :gre_key (Integer) —

    The application key. This applies to the GRE protocol.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



2749
2750
2751
2752
 
# File 'lib/aws-sdk-ec2/client.rb', line 2749

def associate_trunk_interface(params = {}, options = {})
  req = build_request(:associate_trunk_interface, params)
  req.send_request(options)
end

#associate_vpc_cidr_block(params = {}) ⇒ Types::AssociateVpcCidrBlockResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html [2]: docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html

Examples:

Request syntax with placeholder values


resp = client.associate_vpc_cidr_block({
  cidr_block: "String",
  ipv_6_cidr_block_network_border_group: "String",
  ipv_6_pool: "Ipv6PoolEc2Id",
  ipv_6_cidr_block: "String",
  ipv_4_ipam_pool_id: "IpamPoolId",
  ipv_4_netmask_length: 1,
  ipv_6_ipam_pool_id: "IpamPoolId",
  ipv_6_netmask_length: 1,
  vpc_id: "VpcId", # required
  amazon_provided_ipv_6_cidr_block: false,
})

Response structure


resp.ipv_6_cidr_block_association.association_id #=> String
resp.ipv_6_cidr_block_association.ipv_6_cidr_block #=> String
resp.ipv_6_cidr_block_association.ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.ipv_6_cidr_block_association.ipv_6_cidr_block_state.status_message #=> String
resp.ipv_6_cidr_block_association.network_border_group #=> String
resp.ipv_6_cidr_block_association.ipv_6_pool #=> String
resp.ipv_6_cidr_block_association.ipv_6_address_attribute #=> String, one of "public", "private"
resp.ipv_6_cidr_block_association.ip_source #=> String, one of "amazon", "byoip", "none"
resp.cidr_block_association.association_id #=> String
resp.cidr_block_association.cidr_block #=> String
resp.cidr_block_association.cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.cidr_block_association.cidr_block_state.status_message #=> String
resp.vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr_block (String) —

    An IPv4 CIDR block to associate with the VPC.

  • :ipv_6_cidr_block_network_border_group (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.

  • :ipv_6_pool (String) —

    The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

  • :ipv_6_cidr_block (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.

  • :ipv_4_ipam_pool_id (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*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

  • :ipv_4_netmask_length (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*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

  • :ipv_6_ipam_pool_id (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*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

  • :ipv_6_netmask_length (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*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :amazon_provided_ipv_6_cidr_block (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.

Returns:

See Also:



2880
2881
2882
2883
 
# File 'lib/aws-sdk-ec2/client.rb', line 2880

def associate_vpc_cidr_block(params = {}, options = {})
  req = build_request(:associate_vpc_cidr_block, params)
  req.send_request(options)
end

#attach_classic_link_vpc(params = {}) ⇒ Types::AttachClassicLinkVpcResult

<note markdown=“1”> This action is deprecated.

</note>

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.

Examples:

Request syntax with placeholder values


resp = client.attach_classic_link_vpc({
  dry_run: false,
  instance_id: "InstanceId", # required
  vpc_id: "VpcId", # required
  groups: ["SecurityGroupId"], # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the EC2-Classic instance.

  • :vpc_id (required, String) —

    The ID of the ClassicLink-enabled VPC.

  • :groups (required, Array<String>) —

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

Returns:

See Also:



2940
2941
2942
2943
 
# File 'lib/aws-sdk-ec2/client.rb', line 2940

def attach_classic_link_vpc(params = {}, options = {})
  req = build_request(:attach_classic_link_vpc, params)
  req.send_request(options)
end

#attach_internet_gateway(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html

Examples:

Example: To attach an Internet gateway to a VPC


# This example attaches the specified Internet gateway to the specified VPC.

resp = client.attach_internet_gateway({
  internet_gateway_id: "igw-c0a643a9", 
  vpc_id: "vpc-a01106c2", 
})

Request syntax with placeholder values


resp = client.attach_internet_gateway({
  dry_run: false,
  internet_gateway_id: "InternetGatewayId", # required
  vpc_id: "VpcId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :internet_gateway_id (required, String) —

    The ID of the internet gateway.

  • :vpc_id (required, String) —

    The ID of the VPC.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2990
2991
2992
2993
 
# File 'lib/aws-sdk-ec2/client.rb', line 2990

def attach_internet_gateway(params = {}, options = {})
  req = build_request(:attach_internet_gateway, params)
  req.send_request(options)
end

#attach_network_interface(params = {}) ⇒ Types::AttachNetworkInterfaceResult

Attaches a network interface to an instance.

Examples:

Example: To attach a network interface to an instance


# This example attaches the specified network interface to the specified instance.

resp = client.attach_network_interface({
  device_index: 1, 
  instance_id: "i-1234567890abcdef0", 
  network_interface_id: "eni-e5aa89a3", 
})

resp.to_h outputs the following:
{
  attachment_id: "eni-attach-66c4350a", 
}

Request syntax with placeholder values


resp = client.attach_network_interface({
  network_card_index: 1,
  ena_srd_specification: {
    ena_srd_enabled: false,
    ena_srd_udp_specification: {
      ena_srd_udp_enabled: false,
    },
  },
  dry_run: false,
  network_interface_id: "NetworkInterfaceId", # required
  instance_id: "InstanceId", # required
  device_index: 1, # required
})

Response structure


resp.attachment_id #=> String
resp.network_card_index #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_card_index (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.

  • :ena_srd_specification (Types::EnaSrdSpecification) —

    Configures ENA Express for the network interface that this action attaches to the instance.

  • :dry_run (Boolean) —

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

  • :network_interface_id (required, String) —

    The ID of the network interface.

  • :instance_id (required, String) —

    The ID of the instance.

  • :device_index (required, Integer) —

    The index of the device for the network interface attachment.

Returns:

See Also:



3067
3068
3069
3070
 
# File 'lib/aws-sdk-ec2/client.rb', line 3067

def attach_network_interface(params = {}, options = {})
  req = build_request(:attach_network_interface, params)
  req.send_request(options)
end

#attach_verified_access_trust_provider(params = {}) ⇒ Types::AttachVerifiedAccessTrustProviderResult

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

Examples:

Request syntax with placeholder values


resp = client.attach_verified_access_trust_provider({
  verified_access_instance_id: "VerifiedAccessInstanceId", # required
  verified_access_trust_provider_id: "VerifiedAccessTrustProviderId", # required
  client_token: "String",
  dry_run: false,
})

Response structure


resp.verified_access_trust_provider.verified_access_trust_provider_id #=> String
resp.verified_access_trust_provider.description #=> String
resp.verified_access_trust_provider.trust_provider_type #=> String, one of "user", "device"
resp.verified_access_trust_provider.user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_trust_provider.device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_trust_provider.oidc_options.issuer #=> String
resp.verified_access_trust_provider.oidc_options.authorization_endpoint #=> String
resp.verified_access_trust_provider.oidc_options.token_endpoint #=> String
resp.verified_access_trust_provider.oidc_options. #=> String
resp.verified_access_trust_provider.oidc_options.client_id #=> String
resp.verified_access_trust_provider.oidc_options.client_secret #=> String
resp.verified_access_trust_provider.oidc_options.scope #=> String
resp.verified_access_trust_provider.device_options.tenant_id #=> String
resp.verified_access_trust_provider.device_options.public_signing_key_url #=> String
resp.verified_access_trust_provider.policy_reference_name #=> String
resp.verified_access_trust_provider.creation_time #=> String
resp.verified_access_trust_provider.last_updated_time #=> String
resp.verified_access_trust_provider.tags #=> Array
resp.verified_access_trust_provider.tags[0].key #=> String
resp.verified_access_trust_provider.tags[0].value #=> String
resp.verified_access_trust_provider.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_trust_provider.sse_specification.kms_key_arn #=> String
resp.verified_access_instance.verified_access_instance_id #=> String
resp.verified_access_instance.description #=> String
resp.verified_access_instance.verified_access_trust_providers #=> Array
resp.verified_access_instance.verified_access_trust_providers[0].verified_access_trust_provider_id #=> String
resp.verified_access_instance.verified_access_trust_providers[0].description #=> String
resp.verified_access_instance.verified_access_trust_providers[0].trust_provider_type #=> String, one of "user", "device"
resp.verified_access_instance.verified_access_trust_providers[0].user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_instance.verified_access_trust_providers[0].device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_instance.creation_time #=> String
resp.verified_access_instance.last_updated_time #=> String
resp.verified_access_instance.tags #=> Array
resp.verified_access_instance.tags[0].key #=> String
resp.verified_access_instance.tags[0].value #=> String
resp.verified_access_instance.fips_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_instance_id (required, String) —

    The ID of the Verified Access instance.

  • :verified_access_trust_provider_id (required, String) —

    The ID of the Verified Access trust provider.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



3157
3158
3159
3160
 
# File 'lib/aws-sdk-ec2/client.rb', line 3157

def attach_verified_access_trust_provider(params = {}, options = {})
  req = build_request(:attach_verified_access_trust_provider, params)
  req.send_request(options)
end

#attach_volume(params = {}) ⇒ Types::VolumeAttachment

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

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html [2]: docs.aws.amazon.com/ebs/latest/userguide/ebs-using-volumes.html [3]: docs.aws.amazon.com/ebs/latest/userguide/ebs-attaching-volume.html

Examples:

Example: To attach a volume to an instance


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

resp = client.attach_volume({
  device: "/dev/sdf", 
  instance_id: "i-01474ef662b89480", 
  volume_id: "vol-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
  attach_time: Time.parse("2016-08-29T18:52:32.724Z"), 
  device: "/dev/sdf", 
  instance_id: "i-01474ef662b89480", 
  state: "attaching", 
  volume_id: "vol-1234567890abcdef0", 
}

Request syntax with placeholder values


resp = client.attach_volume({
  device: "String", # required
  instance_id: "InstanceId", # required
  volume_id: "VolumeId", # required
  dry_run: false,
})

Response structure


resp.delete_on_termination #=> Boolean
resp.associated_resource #=> String
resp.instance_owning_service #=> String
resp.volume_id #=> String
resp.instance_id #=> String
resp.device #=> String
resp.state #=> String, one of "attaching", "attached", "detaching", "detached", "busy"
resp.attach_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device (required, String) —

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

  • :instance_id (required, String) —

    The ID of the instance.

  • :volume_id (required, String) —

    The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

  • :dry_run (Boolean) —

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

Returns:

See Also:



3265
3266
3267
3268
 
# File 'lib/aws-sdk-ec2/client.rb', line 3265

def attach_volume(params = {}, options = {})
  req = build_request(:attach_volume, params)
  req.send_request(options)
end

#attach_vpn_gateway(params = {}) ⇒ Types::AttachVpnGatewayResult

Attaches an available 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*.

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html

Examples:

Request syntax with placeholder values


resp = client.attach_vpn_gateway({
  vpc_id: "VpcId", # required
  vpn_gateway_id: "VpnGatewayId", # required
  dry_run: false,
})

Response structure


resp.vpc_attachment.vpc_id #=> String
resp.vpc_attachment.state #=> String, one of "attaching", "attached", "detaching", "detached"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :vpn_gateway_id (required, String) —

    The ID of the virtual private gateway.

  • :dry_run (Boolean) —

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

Returns:

See Also:



3313
3314
3315
3316
 
# File 'lib/aws-sdk-ec2/client.rb', line 3313

def attach_vpn_gateway(params = {}, options = {})
  req = build_request(:attach_vpn_gateway, params)
  req.send_request(options)
end

#authorize_client_vpn_ingress(params = {}) ⇒ Types::AuthorizeClientVpnIngressResult

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.

Examples:

Request syntax with placeholder values


resp = client.authorize_client_vpn_ingress({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  target_network_cidr: "String", # required
  access_group_id: "String",
  authorize_all_groups: false,
  description: "String",
  client_token: "String",
  dry_run: false,
})

Response structure


resp.status.code #=> String, one of "authorizing", "active", "failed", "revoking"
resp.status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint.

  • :target_network_cidr (required, String) —

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

  • :access_group_id (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.

  • :authorize_all_groups (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.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



3388
3389
3390
3391
 
# File 'lib/aws-sdk-ec2/client.rb', line 3388

def authorize_client_vpn_ingress(params = {}, options = {})
  req = build_request(:authorize_client_vpn_ingress, params)
  req.send_request(options)
end

#authorize_security_group_egress(params = {}) ⇒ Types::AuthorizeSecurityGroupEgressResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html [3]: docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html

Examples:

Example: 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.

resp = client.authorize_security_group_egress({
  group_id: "sg-1a2b3c4d", 
  ip_permissions: [
    {
      from_port: 80, 
      ip_protocol: "tcp", 
      ip_ranges: [
        {
          cidr_ip: "10.0.0.0/16", 
        }, 
      ], 
      to_port: 80, 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Example: 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.

resp = client.authorize_security_group_egress({
  group_id: "sg-1a2b3c4d", 
  ip_permissions: [
    {
      from_port: 80, 
      ip_protocol: "tcp", 
      to_port: 80, 
      user_id_group_pairs: [
        {
          group_id: "sg-4b51a32f", 
        }, 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.authorize_security_group_egress({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  group_id: "SecurityGroupId", # required
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
  ip_protocol: "String",
  from_port: 1,
  to_port: 1,
  cidr_ip: "String",
  ip_permissions: [
    {
      ip_protocol: "String",
      from_port: 1,
      to_port: 1,
      user_id_group_pairs: [
        {
          description: "String",
          user_id: "String",
          group_name: "String",
          group_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
          peering_status: "String",
        },
      ],
      ip_ranges: [
        {
          description: "String",
          cidr_ip: "String",
        },
      ],
      ipv_6_ranges: [
        {
          description: "String",
          cidr_ipv_6: "String",
        },
      ],
      prefix_list_ids: [
        {
          description: "String",
          prefix_list_id: "String",
        },
      ],
    },
  ],
})

Response structure


resp.return #=> Boolean
resp.security_group_rules #=> Array
resp.security_group_rules[0].security_group_rule_id #=> String
resp.security_group_rules[0].group_id #=> String
resp.security_group_rules[0].group_owner_id #=> String
resp.security_group_rules[0].is_egress #=> Boolean
resp.security_group_rules[0].ip_protocol #=> String
resp.security_group_rules[0].from_port #=> Integer
resp.security_group_rules[0].to_port #=> Integer
resp.security_group_rules[0].cidr_ipv_4 #=> String
resp.security_group_rules[0].cidr_ipv_6 #=> String
resp.security_group_rules[0].prefix_list_id #=> String
resp.security_group_rules[0].referenced_group_info.group_id #=> String
resp.security_group_rules[0].referenced_group_info.peering_status #=> String
resp.security_group_rules[0].referenced_group_info.user_id #=> String
resp.security_group_rules[0].referenced_group_info.vpc_id #=> String
resp.security_group_rules[0].referenced_group_info.vpc_peering_connection_id #=> String
resp.security_group_rules[0].description #=> String
resp.security_group_rules[0].tags #=> Array
resp.security_group_rules[0].tags[0].key #=> String
resp.security_group_rules[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags applied to the security group rule.

  • :dry_run (Boolean) —

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

  • :group_id (required, String) —

    The ID of the security group.

  • :source_security_group_name (String) —

    Not supported. Use IP permissions instead.

  • :source_security_group_owner_id (String) —

    Not supported. Use IP permissions instead.

  • :ip_protocol (String) —

    Not supported. Use IP permissions instead.

  • :from_port (Integer) —

    Not supported. Use IP permissions instead.

  • :to_port (Integer) —

    Not supported. Use IP permissions instead.

  • :cidr_ip (String) —

    Not supported. Use IP permissions instead.

  • :ip_permissions (Array<Types::IpPermission>) —

    The permissions for the security group rules.

Returns:

See Also:



3598
3599
3600
3601
 
# File 'lib/aws-sdk-ec2/client.rb', line 3598

def authorize_security_group_egress(params = {}, options = {})
  req = build_request(:authorize_security_group_egress, params)
  req.send_request(options)
end

#authorize_security_group_ingress(params = {}) ⇒ Types::AuthorizeSecurityGroupIngressResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html [3]: docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html

Examples:

Example: 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.

resp = client.authorize_security_group_ingress({
  group_id: "sg-903004f8", 
  ip_permissions: [
    {
      from_port: 22, 
      ip_protocol: "tcp", 
      ip_ranges: [
        {
          cidr_ip: "203.0.113.0/24", 
          description: "SSH access from the LA office", 
        }, 
      ], 
      to_port: 22, 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Example: 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.

resp = client.authorize_security_group_ingress({
  group_id: "sg-111aaa22", 
  ip_permissions: [
    {
      from_port: 80, 
      ip_protocol: "tcp", 
      to_port: 80, 
      user_id_group_pairs: [
        {
          description: "HTTP access from other instances", 
          group_id: "sg-1a2b3c4d", 
        }, 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Example: 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.

resp = client.authorize_security_group_ingress({
  group_id: "sg-123abc12 ", 
  ip_permissions: [
    {
      from_port: 3389, 
      ip_protocol: "tcp", 
      ipv_6_ranges: [
        {
          cidr_ipv_6: "2001:db8:1234:1a00::/64", 
          description: "RDP access from the NY office", 
        }, 
      ], 
      to_port: 3389, 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.authorize_security_group_ingress({
  cidr_ip: "String",
  from_port: 1,
  group_id: "SecurityGroupId",
  group_name: "SecurityGroupName",
  ip_permissions: [
    {
      ip_protocol: "String",
      from_port: 1,
      to_port: 1,
      user_id_group_pairs: [
        {
          description: "String",
          user_id: "String",
          group_name: "String",
          group_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
          peering_status: "String",
        },
      ],
      ip_ranges: [
        {
          description: "String",
          cidr_ip: "String",
        },
      ],
      ipv_6_ranges: [
        {
          description: "String",
          cidr_ipv_6: "String",
        },
      ],
      prefix_list_ids: [
        {
          description: "String",
          prefix_list_id: "String",
        },
      ],
    },
  ],
  ip_protocol: "String",
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
  to_port: 1,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.return #=> Boolean
resp.security_group_rules #=> Array
resp.security_group_rules[0].security_group_rule_id #=> String
resp.security_group_rules[0].group_id #=> String
resp.security_group_rules[0].group_owner_id #=> String
resp.security_group_rules[0].is_egress #=> Boolean
resp.security_group_rules[0].ip_protocol #=> String
resp.security_group_rules[0].from_port #=> Integer
resp.security_group_rules[0].to_port #=> Integer
resp.security_group_rules[0].cidr_ipv_4 #=> String
resp.security_group_rules[0].cidr_ipv_6 #=> String
resp.security_group_rules[0].prefix_list_id #=> String
resp.security_group_rules[0].referenced_group_info.group_id #=> String
resp.security_group_rules[0].referenced_group_info.peering_status #=> String
resp.security_group_rules[0].referenced_group_info.user_id #=> String
resp.security_group_rules[0].referenced_group_info.vpc_id #=> String
resp.security_group_rules[0].referenced_group_info.vpc_peering_connection_id #=> String
resp.security_group_rules[0].description #=> String
resp.security_group_rules[0].tags #=> Array
resp.security_group_rules[0].tags[0].key #=> String
resp.security_group_rules[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr_ip (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.

  • :from_port (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.

  • :group_id (String) —

    The ID of the security group.

  • :group_name (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.

  • :ip_permissions (Array<Types::IpPermission>) —

    The permissions for the security group rules.

  • :ip_protocol (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.

    [1]: www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml

  • :source_security_group_name (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.

  • :source_security_group_owner_id (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.

  • :to_port (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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags applied to the security group rule.

  • :dry_run (Boolean) —

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

Returns:

See Also:



3883
3884
3885
3886
 
# File 'lib/aws-sdk-ec2/client.rb', line 3883

def authorize_security_group_ingress(params = {}, options = {})
  req = build_request(:authorize_security_group_ingress, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


60457
60458
60459
60460
60461
60462
60463
60464
60465
60466
60467
60468
60469
60470
60471
60472
60473
 
# File 'lib/aws-sdk-ec2/client.rb', line 60457

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::EC2')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-ec2'
  context[:gem_version] = '1.481.0'
  Seahorse::Client::Request.new(handlers, context)
end

#bundle_instance(params = {}) ⇒ Types::BundleInstanceResult

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 markdown=“1”> This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

</note>

Examples:

Request syntax with placeholder values


resp = client.bundle_instance({
  instance_id: "InstanceId", # required
  storage: { # required
    s3: {
      aws_access_key_id: "String",
      bucket: "String",
      prefix: "String",
      upload_policy: "data",
      upload_policy_signature: "S3StorageUploadPolicySignature",
    },
  },
  dry_run: false,
})

Response structure


resp.bundle_task.instance_id #=> String
resp.bundle_task.bundle_id #=> String
resp.bundle_task.state #=> String, one of "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed"
resp.bundle_task.start_time #=> Time
resp.bundle_task.update_time #=> Time
resp.bundle_task.storage.s3.aws_access_key_id #=> String
resp.bundle_task.storage.s3.bucket #=> String
resp.bundle_task.storage.s3.prefix #=> String
resp.bundle_task.storage.s3.upload_policy #=> String
resp.bundle_task.storage.s3.upload_policy_signature #=> String
resp.bundle_task.progress #=> String
resp.bundle_task.bundle_task_error.code #=> String
resp.bundle_task.bundle_task_error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance to bundle.

    Default: None

  • :storage (required, Types::Storage) —

    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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



3955
3956
3957
3958
 
# File 'lib/aws-sdk-ec2/client.rb', line 3955

def bundle_instance(params = {}, options = {})
  req = build_request(:bundle_instance, params)
  req.send_request(options)
end

#cancel_bundle_task(params = {}) ⇒ Types::CancelBundleTaskResult

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

Examples:

Request syntax with placeholder values


resp = client.cancel_bundle_task({
  bundle_id: "BundleId", # required
  dry_run: false,
})

Response structure


resp.bundle_task.instance_id #=> String
resp.bundle_task.bundle_id #=> String
resp.bundle_task.state #=> String, one of "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed"
resp.bundle_task.start_time #=> Time
resp.bundle_task.update_time #=> Time
resp.bundle_task.storage.s3.aws_access_key_id #=> String
resp.bundle_task.storage.s3.bucket #=> String
resp.bundle_task.storage.s3.prefix #=> String
resp.bundle_task.storage.s3.upload_policy #=> String
resp.bundle_task.storage.s3.upload_policy_signature #=> String
resp.bundle_task.progress #=> String
resp.bundle_task.bundle_task_error.code #=> String
resp.bundle_task.bundle_task_error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bundle_id (required, String) —

    The ID of the bundle task.

  • :dry_run (Boolean) —

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

Returns:

See Also:



4003
4004
4005
4006
 
# File 'lib/aws-sdk-ec2/client.rb', line 4003

def cancel_bundle_task(params = {}, options = {})
  req = build_request(:cancel_bundle_task, params)
  req.send_request(options)
end

#cancel_capacity_reservation(params = {}) ⇒ Types::CancelCapacityReservationResult

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.

Examples:

Request syntax with placeholder values


resp = client.cancel_capacity_reservation({
  capacity_reservation_id: "CapacityReservationId", # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation to be cancelled.

  • :dry_run (Boolean) —

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

Returns:

See Also:



4047
4048
4049
4050
 
# File 'lib/aws-sdk-ec2/client.rb', line 4047

def cancel_capacity_reservation(params = {}, options = {})
  req = build_request(:cancel_capacity_reservation, params)
  req.send_request(options)
end

#cancel_capacity_reservation_fleets(params = {}) ⇒ Types::CancelCapacityReservationFleetsResult

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.

Examples:

Request syntax with placeholder values


resp = client.cancel_capacity_reservation_fleets({
  dry_run: false,
  capacity_reservation_fleet_ids: ["CapacityReservationFleetId"], # required
})

Response structure


resp.successful_fleet_cancellations #=> Array
resp.successful_fleet_cancellations[0].current_fleet_state #=> String, one of "submitted", "modifying", "active", "partially_fulfilled", "expiring", "expired", "cancelling", "cancelled", "failed"
resp.successful_fleet_cancellations[0].previous_fleet_state #=> String, one of "submitted", "modifying", "active", "partially_fulfilled", "expiring", "expired", "cancelling", "cancelled", "failed"
resp.successful_fleet_cancellations[0].capacity_reservation_fleet_id #=> String
resp.failed_fleet_cancellations #=> Array
resp.failed_fleet_cancellations[0].capacity_reservation_fleet_id #=> String
resp.failed_fleet_cancellations[0].cancel_capacity_reservation_fleet_error.code #=> String
resp.failed_fleet_cancellations[0].cancel_capacity_reservation_fleet_error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :capacity_reservation_fleet_ids (required, Array<String>) —

    The IDs of the Capacity Reservation Fleets to cancel.

Returns:

See Also:



4099
4100
4101
4102
 
# File 'lib/aws-sdk-ec2/client.rb', line 4099

def cancel_capacity_reservation_fleets(params = {}, options = {})
  req = build_request(:cancel_capacity_reservation_fleets, params)
  req.send_request(options)
end

#cancel_conversion_task(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.cancel_conversion_task({
  dry_run: false,
  conversion_task_id: "ConversionTaskId", # required
  reason_message: "String",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :conversion_task_id (required, String) —

    The ID of the conversion task.

  • :reason_message (String) —

    The reason for canceling the conversion task.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4136
4137
4138
4139
 
# File 'lib/aws-sdk-ec2/client.rb', line 4136

def cancel_conversion_task(params = {}, options = {})
  req = build_request(:cancel_conversion_task, params)
  req.send_request(options)
end

#cancel_export_task(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.cancel_export_task({
  export_task_id: "ExportVmTaskId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :export_task_id (required, String) —

    The ID of the export task. This is the ID returned by the ‘CreateInstanceExportTask` and `ExportImage` operations.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4162
4163
4164
4165
 
# File 'lib/aws-sdk-ec2/client.rb', line 4162

def cancel_export_task(params = {}, options = {})
  req = build_request(:cancel_export_task, params)
  req.send_request(options)
end

#cancel_image_launch_permission(params = {}) ⇒ Types::CancelImageLaunchPermissionResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html

Examples:

Request syntax with placeholder values


resp = client.cancel_image_launch_permission({
  image_id: "ImageId", # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI that was shared with your Amazon Web Services account.

  • :dry_run (Boolean) —

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

Returns:

See Also:



4205
4206
4207
4208
 
# File 'lib/aws-sdk-ec2/client.rb', line 4205

def cancel_image_launch_permission(params = {}, options = {})
  req = build_request(:cancel_image_launch_permission, params)
  req.send_request(options)
end

#cancel_import_task(params = {}) ⇒ Types::CancelImportTaskResult

Cancels an in-process import virtual machine or import snapshot task.

Examples:

Request syntax with placeholder values


resp = client.cancel_import_task({
  cancel_reason: "String",
  dry_run: false,
  import_task_id: "ImportTaskId",
})

Response structure


resp.import_task_id #=> String
resp.previous_state #=> String
resp.state #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cancel_reason (String) —

    The reason for canceling the task.

  • :dry_run (Boolean) —

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

  • :import_task_id (String) —

    The ID of the import image or import snapshot task to be canceled.

Returns:

See Also:



4248
4249
4250
4251
 
# File 'lib/aws-sdk-ec2/client.rb', line 4248

def cancel_import_task(params = {}, options = {})
  req = build_request(:cancel_import_task, params)
  req.send_request(options)
end

#cancel_reserved_instances_listing(params = {}) ⇒ Types::CancelReservedInstancesListingResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html

Examples:

Request syntax with placeholder values


resp = client.cancel_reserved_instances_listing({
  reserved_instances_listing_id: "ReservedInstancesListingId", # required
})

Response structure


resp.reserved_instances_listings #=> Array
resp.reserved_instances_listings[0].client_token #=> String
resp.reserved_instances_listings[0].create_date #=> Time
resp.reserved_instances_listings[0].instance_counts #=> Array
resp.reserved_instances_listings[0].instance_counts[0].instance_count #=> Integer
resp.reserved_instances_listings[0].instance_counts[0].state #=> String, one of "available", "sold", "cancelled", "pending"
resp.reserved_instances_listings[0].price_schedules #=> Array
resp.reserved_instances_listings[0].price_schedules[0].active #=> Boolean
resp.reserved_instances_listings[0].price_schedules[0].currency_code #=> String, one of "USD"
resp.reserved_instances_listings[0].price_schedules[0].price #=> Float
resp.reserved_instances_listings[0].price_schedules[0].term #=> Integer
resp.reserved_instances_listings[0].reserved_instances_id #=> String
resp.reserved_instances_listings[0].reserved_instances_listing_id #=> String
resp.reserved_instances_listings[0].status #=> String, one of "active", "pending", "cancelled", "closed"
resp.reserved_instances_listings[0].status_message #=> String
resp.reserved_instances_listings[0].tags #=> Array
resp.reserved_instances_listings[0].tags[0].key #=> String
resp.reserved_instances_listings[0].tags[0].value #=> String
resp.reserved_instances_listings[0].update_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_instances_listing_id (required, String) —

    The ID of the Reserved Instance listing.

Returns:

See Also:



4302
4303
4304
4305
 
# File 'lib/aws-sdk-ec2/client.rb', line 4302

def cancel_reserved_instances_listing(params = {}, options = {})
  req = build_request(:cancel_reserved_instances_listing, params)
  req.send_request(options)
end

#cancel_spot_fleet_requests(params = {}) ⇒ Types::CancelSpotFleetRequestsResponse

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.

^

Examples:

Example: To cancel a Spot fleet request


# This example cancels the specified Spot fleet request and terminates its associated Spot Instances.

resp = client.cancel_spot_fleet_requests({
  spot_fleet_request_ids: [
    "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
  ], 
  terminate_instances: true, 
})

resp.to_h outputs the following:
{
  successful_fleet_requests: [
    {
      current_spot_fleet_request_state: "cancelled_running", 
      previous_spot_fleet_request_state: "active", 
      spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
    }, 
  ], 
}

Example: 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.

resp = client.cancel_spot_fleet_requests({
  spot_fleet_request_ids: [
    "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
  ], 
  terminate_instances: false, 
})

resp.to_h outputs the following:
{
  successful_fleet_requests: [
    {
      current_spot_fleet_request_state: "cancelled_terminating", 
      previous_spot_fleet_request_state: "active", 
      spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.cancel_spot_fleet_requests({
  dry_run: false,
  spot_fleet_request_ids: ["SpotFleetRequestId"], # required
  terminate_instances: false, # required
})

Response structure


resp.successful_fleet_requests #=> Array
resp.successful_fleet_requests[0].current_spot_fleet_request_state #=> String, one of "submitted", "active", "cancelled", "failed", "cancelled_running", "cancelled_terminating", "modifying"
resp.successful_fleet_requests[0].previous_spot_fleet_request_state #=> String, one of "submitted", "active", "cancelled", "failed", "cancelled_running", "cancelled_terminating", "modifying"
resp.successful_fleet_requests[0].spot_fleet_request_id #=> String
resp.unsuccessful_fleet_requests #=> Array
resp.unsuccessful_fleet_requests[0].error.code #=> String, one of "fleetRequestIdDoesNotExist", "fleetRequestIdMalformed", "fleetRequestNotInCancellableState", "unexpectedError"
resp.unsuccessful_fleet_requests[0].error.message #=> String
resp.unsuccessful_fleet_requests[0].spot_fleet_request_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :spot_fleet_request_ids (required, Array<String>) —

    The IDs of the Spot Fleet requests.

    Constraint: You can specify up to 100 IDs in a single request.

  • :terminate_instances (required, 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`.

Returns:

See Also:



4417
4418
4419
4420
 
# File 'lib/aws-sdk-ec2/client.rb', line 4417

def cancel_spot_fleet_requests(params = {}, options = {})
  req = build_request(:cancel_spot_fleet_requests, params)
  req.send_request(options)
end

#cancel_spot_instance_requests(params = {}) ⇒ Types::CancelSpotInstanceRequestsResult

Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

Examples:

Example: To cancel Spot Instance requests


# This example cancels a Spot Instance request.

resp = client.cancel_spot_instance_requests({
  spot_instance_request_ids: [
    "sir-08b93456", 
  ], 
})

resp.to_h outputs the following:
{
  cancelled_spot_instance_requests: [
    {
      spot_instance_request_id: "sir-08b93456", 
      state: "cancelled", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.cancel_spot_instance_requests({
  dry_run: false,
  spot_instance_request_ids: ["SpotInstanceRequestId"], # required
})

Response structure


resp.cancelled_spot_instance_requests #=> Array
resp.cancelled_spot_instance_requests[0].spot_instance_request_id #=> String
resp.cancelled_spot_instance_requests[0].state #=> String, one of "active", "open", "closed", "cancelled", "completed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :spot_instance_request_ids (required, Array<String>) —

    The IDs of the Spot Instance requests.

Returns:

See Also:



4478
4479
4480
4481
 
# File 'lib/aws-sdk-ec2/client.rb', line 4478

def cancel_spot_instance_requests(params = {}, options = {})
  req = build_request(:cancel_spot_instance_requests, params)
  req.send_request(options)
end

#confirm_product_instance(params = {}) ⇒ Types::ConfirmProductInstanceResult

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.

Examples:

Example: To confirm the product instance


# This example determines whether the specified product code is associated with the specified instance.

resp = client.confirm_product_instance({
  instance_id: "i-1234567890abcdef0", 
  product_code: "774F4FF8", 
})

resp.to_h outputs the following:
{
  owner_id: "123456789012", 
}

Request syntax with placeholder values


resp = client.confirm_product_instance({
  instance_id: "InstanceId", # required
  product_code: "String", # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean
resp.owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance.

  • :product_code (required, String) —

    The product code. This must be a product code that you own.

  • :dry_run (Boolean) —

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

Returns:

See Also:



4537
4538
4539
4540
 
# File 'lib/aws-sdk-ec2/client.rb', line 4537

def confirm_product_instance(params = {}, options = {})
  req = build_request(:confirm_product_instance, params)
  req.send_request(options)
end

#copy_fpga_image(params = {}) ⇒ Types::CopyFpgaImageResult

Copies the specified Amazon FPGA Image (AFI) to the current Region.

Examples:

Request syntax with placeholder values


resp = client.copy_fpga_image({
  dry_run: false,
  source_fpga_image_id: "String", # required
  description: "String",
  name: "String",
  source_region: "String", # required
  client_token: "String",
})

Response structure


resp.fpga_image_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :source_fpga_image_id (required, 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.

  • :source_region (required, String) —

    The Region that contains the source AFI.

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



4594
4595
4596
4597
 
# File 'lib/aws-sdk-ec2/client.rb', line 4594

def copy_fpga_image(params = {}, options = {})
  req = build_request(:copy_fpga_image, params)
  req.send_request(options)
end

#copy_image(params = {}) ⇒ Types::CopyImageResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html

Examples:

Example: To copy an AMI to another region


# This example copies the specified AMI from the us-east-1 region to the current region.

resp = client.copy_image({
  description: "", 
  name: "My server", 
  source_image_id: "ami-5731123e", 
  source_region: "us-east-1", 
})

resp.to_h outputs the following:
{
  image_id: "ami-438bea42", 
}

Request syntax with placeholder values


resp = client.copy_image({
  client_token: "String",
  description: "String",
  encrypted: false,
  kms_key_id: "KmsKeyId",
  name: "String", # required
  source_image_id: "String", # required
  source_region: "String", # required
  destination_outpost_arn: "String",
  copy_image_tags: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.image_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

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

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html

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

    The name of the new AMI in the destination Region.

  • :source_image_id (required, String) —

    The ID of the AMI to copy.

  • :source_region (required, String) —

    The name of the Region that contains the AMI to copy.

  • :destination_outpost_arn (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*.

    [1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#copy-amis

  • :copy_image_tags (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.

  • :tag_specifications (Array<Types::TagSpecification>) —

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

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



4789
4790
4791
4792
 
# File 'lib/aws-sdk-ec2/client.rb', line 4789

def copy_image(params = {}, options = {})
  req = build_request(:copy_image, params)
  req.send_request(options)
end

#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResult

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

[1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#ami [2]: docs.aws.amazon.com/ebs/latest/userguide/ebs-copy-snapshot.html

Examples:

Example: 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.

resp = client.copy_snapshot({
  description: "This is my copied snapshot.", 
  destination_region: "us-east-1", 
  source_region: "us-west-2", 
  source_snapshot_id: "snap-066877671789bd71b", 
})

resp.to_h outputs the following:
{
  snapshot_id: "snap-066877671789bd71b", 
}

Copy snapshot example

source_snapshot_id = 'snapshot-id'
source_region = 'us-east-1'
target_region = 'us-west-2'

# You must configure your EC2 client for the destination region to copy
ec2 = Aws::EC2::Client(region: target_region)

resp = ec2.copy_snapshot({
    source_region: source_region,
    source_snapshot_id: source_snapshot_id,
})

snapshot_id = resp.snapshot_id

ec2.wait_until(:snapshot_completed, snapshot_ids: [snapshot_id])

Copy an encrypted snapshot

# same as above, expect you must pass `encrypted: true`
resp = ec2.copy_snapshot({
    source_region: source_region,
    source_snapshot_id: source_snapshot_id,
    encrypted: true, # required for encrypted snapshots
})

Request syntax with placeholder values


resp = client.copy_snapshot({
  description: "String",
  destination_outpost_arn: "String",
  destination_region: "String",
  encrypted: false,
  kms_key_id: "KmsKeyId",
  presigned_url: "CopySnapshotRequestPSU",
  source_region: "String", # required
  source_snapshot_id: "String", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.snapshot_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the EBS snapshot.

  • :destination_outpost_arn (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*.

    [1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#copy-snapshots

  • :destination_region (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*.

    [1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html

  • :kms_key_id (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.

  • :presigned_url (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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html

  • :source_region (required, String) —

    The ID of the Region that contains the snapshot to be copied.

  • :source_snapshot_id (required, String) —

    The ID of the EBS snapshot to copy.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the new snapshot.

  • :dry_run (Boolean) —

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

Returns:

See Also:



5010
5011
5012
5013
 
# File 'lib/aws-sdk-ec2/client.rb', line 5010

def copy_snapshot(params = {}, options = {})
  req = build_request(:copy_snapshot, params)
  req.send_request(options)
end

#create_capacity_reservation(params = {}) ⇒ Types::CreateCapacityReservationResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html

Examples:

Request syntax with placeholder values


resp = client.create_capacity_reservation({
  client_token: "String",
  instance_type: "String", # required
  instance_platform: "Linux/UNIX", # required, accepts 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
  availability_zone: "AvailabilityZoneName",
  availability_zone_id: "AvailabilityZoneId",
  tenancy: "default", # accepts default, dedicated
  instance_count: 1, # required
  ebs_optimized: false,
  ephemeral_storage: false,
  end_date: Time.now,
  end_date_type: "unlimited", # accepts unlimited, limited
  instance_match_criteria: "open", # accepts open, targeted
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  outpost_arn: "OutpostArn",
  placement_group_arn: "PlacementGroupArn",
})

Response structure


resp.capacity_reservation.capacity_reservation_id #=> String
resp.capacity_reservation.owner_id #=> String
resp.capacity_reservation.capacity_reservation_arn #=> String
resp.capacity_reservation.availability_zone_id #=> String
resp.capacity_reservation.instance_type #=> String
resp.capacity_reservation.instance_platform #=> String, one of "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"
resp.capacity_reservation.availability_zone #=> String
resp.capacity_reservation.tenancy #=> String, one of "default", "dedicated"
resp.capacity_reservation.total_instance_count #=> Integer
resp.capacity_reservation.available_instance_count #=> Integer
resp.capacity_reservation.ebs_optimized #=> Boolean
resp.capacity_reservation.ephemeral_storage #=> Boolean
resp.capacity_reservation.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "scheduled", "payment-pending", "payment-failed"
resp.capacity_reservation.start_date #=> Time
resp.capacity_reservation.end_date #=> Time
resp.capacity_reservation.end_date_type #=> String, one of "unlimited", "limited"
resp.capacity_reservation.instance_match_criteria #=> String, one of "open", "targeted"
resp.capacity_reservation.create_date #=> Time
resp.capacity_reservation.tags #=> Array
resp.capacity_reservation.tags[0].key #=> String
resp.capacity_reservation.tags[0].value #=> String
resp.capacity_reservation.outpost_arn #=> String
resp.capacity_reservation.capacity_reservation_fleet_id #=> String
resp.capacity_reservation.placement_group_arn #=> String
resp.capacity_reservation.capacity_allocations #=> Array
resp.capacity_reservation.capacity_allocations[0].allocation_type #=> String, one of "used"
resp.capacity_reservation.capacity_allocations[0].count #=> Integer
resp.capacity_reservation.reservation_type #=> String, one of "default", "capacity-block"
resp.capacity_reservation.unused_reservation_billing_owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :instance_type (required, String) —

    The instance type for which to reserve capacity. For more information, see [Instance types] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

  • :instance_platform (required, String) —

    The type of operating system for which to reserve capacity.

  • :availability_zone (String) —

    The Availability Zone in which to create the Capacity Reservation.

  • :availability_zone_id (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.

  • :instance_count (required, Integer) —

    The number of instances for which to reserve capacity.

    Valid range: 1 - 1000

  • :ebs_optimized (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.

  • :ephemeral_storage (Boolean) —

    Deprecated.

  • :end_date (Time, DateTime, Date, Integer, String) —

    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.

  • :end_date_type (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`.

  • :instance_match_criteria (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`

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the Capacity Reservation during launch.

  • :dry_run (Boolean) —

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

  • :outpost_arn (String) —

    The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

  • :placement_group_arn (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html

Returns:

See Also:



5237
5238
5239
5240
 
# File 'lib/aws-sdk-ec2/client.rb', line 5237

def create_capacity_reservation(params = {}, options = {})
  req = build_request(:create_capacity_reservation, params)
  req.send_request(options)
end

#create_capacity_reservation_by_splitting(params = {}) ⇒ Types::CreateCapacityReservationBySplittingResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_capacity_reservation_by_splitting({
  dry_run: false,
  client_token: "String",
  source_capacity_reservation_id: "CapacityReservationId", # required
  instance_count: 1, # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.source_capacity_reservation.capacity_reservation_id #=> String
resp.source_capacity_reservation.owner_id #=> String
resp.source_capacity_reservation.capacity_reservation_arn #=> String
resp.source_capacity_reservation.availability_zone_id #=> String
resp.source_capacity_reservation.instance_type #=> String
resp.source_capacity_reservation.instance_platform #=> String, one of "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"
resp.source_capacity_reservation.availability_zone #=> String
resp.source_capacity_reservation.tenancy #=> String, one of "default", "dedicated"
resp.source_capacity_reservation.total_instance_count #=> Integer
resp.source_capacity_reservation.available_instance_count #=> Integer
resp.source_capacity_reservation.ebs_optimized #=> Boolean
resp.source_capacity_reservation.ephemeral_storage #=> Boolean
resp.source_capacity_reservation.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "scheduled", "payment-pending", "payment-failed"
resp.source_capacity_reservation.start_date #=> Time
resp.source_capacity_reservation.end_date #=> Time
resp.source_capacity_reservation.end_date_type #=> String, one of "unlimited", "limited"
resp.source_capacity_reservation.instance_match_criteria #=> String, one of "open", "targeted"
resp.source_capacity_reservation.create_date #=> Time
resp.source_capacity_reservation.tags #=> Array
resp.source_capacity_reservation.tags[0].key #=> String
resp.source_capacity_reservation.tags[0].value #=> String
resp.source_capacity_reservation.outpost_arn #=> String
resp.source_capacity_reservation.capacity_reservation_fleet_id #=> String
resp.source_capacity_reservation.placement_group_arn #=> String
resp.source_capacity_reservation.capacity_allocations #=> Array
resp.source_capacity_reservation.capacity_allocations[0].allocation_type #=> String, one of "used"
resp.source_capacity_reservation.capacity_allocations[0].count #=> Integer
resp.source_capacity_reservation.reservation_type #=> String, one of "default", "capacity-block"
resp.source_capacity_reservation.unused_reservation_billing_owner_id #=> String
resp.destination_capacity_reservation.capacity_reservation_id #=> String
resp.destination_capacity_reservation.owner_id #=> String
resp.destination_capacity_reservation.capacity_reservation_arn #=> String
resp.destination_capacity_reservation.availability_zone_id #=> String
resp.destination_capacity_reservation.instance_type #=> String
resp.destination_capacity_reservation.instance_platform #=> String, one of "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"
resp.destination_capacity_reservation.availability_zone #=> String
resp.destination_capacity_reservation.tenancy #=> String, one of "default", "dedicated"
resp.destination_capacity_reservation.total_instance_count #=> Integer
resp.destination_capacity_reservation.available_instance_count #=> Integer
resp.destination_capacity_reservation.ebs_optimized #=> Boolean
resp.destination_capacity_reservation.ephemeral_storage #=> Boolean
resp.destination_capacity_reservation.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "scheduled", "payment-pending", "payment-failed"
resp.destination_capacity_reservation.start_date #=> Time
resp.destination_capacity_reservation.end_date #=> Time
resp.destination_capacity_reservation.end_date_type #=> String, one of "unlimited", "limited"
resp.destination_capacity_reservation.instance_match_criteria #=> String, one of "open", "targeted"
resp.destination_capacity_reservation.create_date #=> Time
resp.destination_capacity_reservation.tags #=> Array
resp.destination_capacity_reservation.tags[0].key #=> String
resp.destination_capacity_reservation.tags[0].value #=> String
resp.destination_capacity_reservation.outpost_arn #=> String
resp.destination_capacity_reservation.capacity_reservation_fleet_id #=> String
resp.destination_capacity_reservation.placement_group_arn #=> String
resp.destination_capacity_reservation.capacity_allocations #=> Array
resp.destination_capacity_reservation.capacity_allocations[0].allocation_type #=> String, one of "used"
resp.destination_capacity_reservation.capacity_allocations[0].count #=> Integer
resp.destination_capacity_reservation.reservation_type #=> String, one of "default", "capacity-block"
resp.destination_capacity_reservation.unused_reservation_billing_owner_id #=> String
resp.instance_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :source_capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation from which you want to split the available capacity.

  • :instance_count (required, Integer) —

    The number of instances to split from the source Capacity Reservation.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the new Capacity Reservation.

Returns:

See Also:



5368
5369
5370
5371
 
# File 'lib/aws-sdk-ec2/client.rb', line 5368

def create_capacity_reservation_by_splitting(params = {}, options = {})
  req = build_request(:create_capacity_reservation_by_splitting, params)
  req.send_request(options)
end

#create_capacity_reservation_fleet(params = {}) ⇒ Types::CreateCapacityReservationFleetResult

Creates a Capacity Reservation Fleet. For more information, see

Create a Capacity Reservation Fleet][1

in the *Amazon EC2 User

Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-cr-fleets.html#create-crfleet

Examples:

Request syntax with placeholder values


resp = client.create_capacity_reservation_fleet({
  allocation_strategy: "String",
  client_token: "String",
  instance_type_specifications: [ # required
    {
      instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
      instance_platform: "Linux/UNIX", # accepts 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: 1.0,
      availability_zone: "String",
      availability_zone_id: "String",
      ebs_optimized: false,
      priority: 1,
    },
  ],
  tenancy: "default", # accepts default
  total_target_capacity: 1, # required
  end_date: Time.now,
  instance_match_criteria: "open", # accepts open
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.capacity_reservation_fleet_id #=> String
resp.state #=> String, one of "submitted", "modifying", "active", "partially_fulfilled", "expiring", "expired", "cancelling", "cancelled", "failed"
resp.total_target_capacity #=> Integer
resp.total_fulfilled_capacity #=> Float
resp.instance_match_criteria #=> String, one of "open"
resp.allocation_strategy #=> String
resp.create_time #=> Time
resp.end_date #=> Time
resp.tenancy #=> String, one of "default"
resp.fleet_capacity_reservations #=> Array
resp.fleet_capacity_reservations[0].capacity_reservation_id #=> String
resp.fleet_capacity_reservations[0].availability_zone_id #=> String
resp.fleet_capacity_reservations[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.fleet_capacity_reservations[0].instance_platform #=> String, one of "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"
resp.fleet_capacity_reservations[0].availability_zone #=> String
resp.fleet_capacity_reservations[0].total_instance_count #=> Integer
resp.fleet_capacity_reservations[0].fulfilled_capacity #=> Float
resp.fleet_capacity_reservations[0].ebs_optimized #=> Boolean
resp.fleet_capacity_reservations[0].create_date #=> Time
resp.fleet_capacity_reservations[0].weight #=> Float
resp.fleet_capacity_reservations[0].priority #=> Integer
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_strategy (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`

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :instance_type_specifications (required, Array<Types::ReservationFleetInstanceSpecification>) —

    Information about the instance types for which to reserve the capacity.

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

  • :total_target_capacity (required, 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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity

  • :end_date (Time, DateTime, Date, Integer, String) —

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

  • :instance_match_criteria (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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.

  • :dry_run (Boolean) —

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

Returns:

See Also:



5544
5545
5546
5547
 
# File 'lib/aws-sdk-ec2/client.rb', line 5544

def create_capacity_reservation_fleet(params = {}, options = {})
  req = build_request(:create_capacity_reservation_fleet, params)
  req.send_request(options)
end

#create_carrier_gateway(params = {}) ⇒ Types::CreateCarrierGatewayResult

Creates a carrier gateway. For more information about carrier gateways, see [Carrier gateways] in the *Amazon Web Services Wavelength Developer Guide*.

[1]: docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway

Examples:

Request syntax with placeholder values


resp = client.create_carrier_gateway({
  vpc_id: "VpcId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  client_token: "String",
})

Response structure


resp.carrier_gateway.carrier_gateway_id #=> String
resp.carrier_gateway.vpc_id #=> String
resp.carrier_gateway.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.carrier_gateway.owner_id #=> String
resp.carrier_gateway.tags #=> Array
resp.carrier_gateway.tags[0].key #=> String
resp.carrier_gateway.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    The ID of the VPC to associate with the carrier gateway.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to associate with the carrier gateway.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



5618
5619
5620
5621
 
# File 'lib/aws-sdk-ec2/client.rb', line 5618

def create_carrier_gateway(params = {}, options = {})
  req = build_request(:create_carrier_gateway, params)
  req.send_request(options)
end

#create_client_vpn_endpoint(params = {}) ⇒ Types::CreateClientVpnEndpointResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_client_vpn_endpoint({
  client_cidr_block: "String", # required
  server_certificate_arn: "String", # required
  authentication_options: [ # required
    {
      type: "certificate-authentication", # accepts certificate-authentication, directory-service-authentication, federated-authentication
      active_directory: {
        directory_id: "String",
      },
      mutual_authentication: {
        client_root_certificate_chain_arn: "String",
      },
      federated_authentication: {
        saml_provider_arn: "String",
        self_service_saml_provider_arn: "String",
      },
    },
  ],
  connection_log_options: { # required
    enabled: false,
    cloudwatch_log_group: "String",
    cloudwatch_log_stream: "String",
  },
  dns_servers: ["String"],
  transport_protocol: "tcp", # accepts tcp, udp
  vpn_port: 1,
  description: "String",
  split_tunnel: false,
  dry_run: false,
  client_token: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  security_group_ids: ["SecurityGroupId"],
  vpc_id: "VpcId",
  self_service_portal: "enabled", # accepts enabled, disabled
  client_connect_options: {
    enabled: false,
    lambda_function_arn: "String",
  },
  session_timeout_hours: 1,
  client_login_banner_options: {
    enabled: false,
    banner_text: "String",
  },
})

Response structure


resp.client_vpn_endpoint_id #=> String
resp.status.code #=> String, one of "pending-associate", "available", "deleting", "deleted"
resp.status.message #=> String
resp.dns_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_cidr_block (required, 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.

  • :server_certificate_arn (required, String) —

    The ARN of the server certificate. For more information, see the [Certificate Manager User Guide].

    [1]: docs.aws.amazon.com/acm/latest/userguide/

  • :authentication_options (required, Array<Types::ClientVpnAuthenticationRequest>) —

    Information about the authentication method to be used to authenticate clients.

  • :connection_log_options (required, Types::ConnectionLogOptions) —

    Information about the client connection logging options.

    If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

    • Client connection requests

    • Client connection results (successful and unsuccessful)

    • Reasons for unsuccessful client connection requests

    • Client connection termination time

  • :dns_servers (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.

  • :transport_protocol (String) —

    The transport protocol to be used by the VPN session.

    Default value: ‘udp`

  • :vpn_port (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.

  • :split_tunnel (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*.

    [1]: docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the Client VPN endpoint during creation.

  • :security_group_ids (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.

  • :vpc_id (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.

  • :self_service_portal (String) —

    Specify whether to enable the self-service portal for the Client VPN endpoint.

    Default Value: ‘enabled`

  • :client_connect_options (Types::ClientConnectOptions) —

    The options for managing connection authorization for new client connections.

  • :session_timeout_hours (Integer) —

    The maximum VPN session duration time in hours.

    Valid values: ‘8 | 10 | 12 | 24`

    Default value: ‘24`

  • :client_login_banner_options (Types::ClientLoginBannerOptions) —

    Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

Returns:

See Also:



5824
5825
5826
5827
 
# File 'lib/aws-sdk-ec2/client.rb', line 5824

def create_client_vpn_endpoint(params = {}, options = {})
  req = build_request(:create_client_vpn_endpoint, params)
  req.send_request(options)
end

#create_client_vpn_route(params = {}) ⇒ Types::CreateClientVpnRouteResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_client_vpn_route({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  destination_cidr_block: "String", # required
  target_vpc_subnet_id: "SubnetId", # required
  description: "String",
  client_token: "String",
  dry_run: false,
})

Response structure


resp.status.code #=> String, one of "creating", "active", "failed", "deleting"
resp.status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint to which to add the route.

  • :destination_cidr_block (required, 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

  • :target_vpc_subnet_id (required, 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.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



5904
5905
5906
5907
 
# File 'lib/aws-sdk-ec2/client.rb', line 5904

def create_client_vpn_route(params = {}, options = {})
  req = build_request(:create_client_vpn_route, params)
  req.send_request(options)
end

#create_coip_cidr(params = {}) ⇒ Types::CreateCoipCidrResult

Creates a range of customer-owned IP addresses.

Examples:

Request syntax with placeholder values


resp = client.create_coip_cidr({
  cidr: "String", # required
  coip_pool_id: "Ipv4PoolCoipId", # required
  dry_run: false,
})

Response structure


resp.coip_cidr.cidr #=> String
resp.coip_cidr.coip_pool_id #=> String
resp.coip_cidr.local_gateway_route_table_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr (required, String) —

    A customer-owned IP address range to create.

  • :coip_pool_id (required, String) —

    The ID of the address pool.

  • :dry_run (Boolean) —

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

Returns:

See Also:



5945
5946
5947
5948
 
# File 'lib/aws-sdk-ec2/client.rb', line 5945

def create_coip_cidr(params = {}, options = {})
  req = build_request(:create_coip_cidr, params)
  req.send_request(options)
end

#create_coip_pool(params = {}) ⇒ Types::CreateCoipPoolResult

Creates a pool of customer-owned IP (CoIP) addresses.

Examples:

Request syntax with placeholder values


resp = client.create_coip_pool({
  local_gateway_route_table_id: "LocalGatewayRoutetableId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.coip_pool.pool_id #=> String
resp.coip_pool.pool_cidrs #=> Array
resp.coip_pool.pool_cidrs[0] #=> String
resp.coip_pool.local_gateway_route_table_id #=> String
resp.coip_pool.tags #=> Array
resp.coip_pool.tags[0].key #=> String
resp.coip_pool.tags[0].value #=> String
resp.coip_pool.pool_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_id (required, String) —

    The ID of the local gateway route table.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the CoIP address pool.

  • :dry_run (Boolean) —

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

Returns:

See Also:



6001
6002
6003
6004
 
# File 'lib/aws-sdk-ec2/client.rb', line 6001

def create_coip_pool(params = {}, options = {})
  req = build_request(:create_coip_pool, params)
  req.send_request(options)
end

#create_customer_gateway(params = {}) ⇒ Types::CreateCustomerGatewayResult

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][1

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.

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/cgw-options.html

Examples:

Example: To create a customer gateway


# This example creates a customer gateway with the specified IP address for its outside interface.

resp = client.create_customer_gateway({
  bgp_asn: 65534, 
  public_ip: "12.1.2.3", 
  type: "ipsec.1", 
})

resp.to_h outputs the following:
{
  customer_gateway: {
    bgp_asn: "65534", 
    customer_gateway_id: "cgw-0e11f167", 
    ip_address: "12.1.2.3", 
    state: "available", 
    type: "ipsec.1", 
  }, 
}

Request syntax with placeholder values


resp = client.create_customer_gateway({
  bgp_asn: 1,
  public_ip: "String",
  certificate_arn: "String",
  type: "ipsec.1", # required, accepts ipsec.1
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  device_name: "String",
  ip_address: "String",
  bgp_asn_extended: 1,
  dry_run: false,
})

Response structure


resp.customer_gateway.certificate_arn #=> String
resp.customer_gateway.device_name #=> String
resp.customer_gateway.tags #=> Array
resp.customer_gateway.tags[0].key #=> String
resp.customer_gateway.tags[0].value #=> String
resp.customer_gateway.bgp_asn_extended #=> String
resp.customer_gateway.customer_gateway_id #=> String
resp.customer_gateway.state #=> String
resp.customer_gateway.type #=> String
resp.customer_gateway.ip_address #=> String
resp.customer_gateway.bgp_asn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bgp_asn (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`

  • :public_ip (String) —

    *This member has been deprecated.* The Internet-routable IP address for the customer gateway’s outside interface. The address must be static.

  • :certificate_arn (String) —

    The Amazon Resource Name (ARN) for the customer gateway certificate.

  • :type (required, String) —

    The type of VPN connection that this customer gateway supports (‘ipsec.1`).

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the customer gateway.

  • :device_name (String) —

    A name for the customer gateway device.

    Length Constraints: Up to 255 characters.

  • :ip_address (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.

  • :bgp_asn_extended (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`

  • :dry_run (Boolean) —

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

Returns:

See Also:



6148
6149
6150
6151
 
# File 'lib/aws-sdk-ec2/client.rb', line 6148

def create_customer_gateway(params = {}, options = {})
  req = build_request(:create_customer_gateway, params)
  req.send_request(options)
end

#create_default_subnet(params = {}) ⇒ Types::CreateDefaultSubnetResult

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][1

in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html#create-default-subnet

Examples:

Request syntax with placeholder values


resp = client.create_default_subnet({
  availability_zone: "AvailabilityZoneName", # required
  dry_run: false,
  ipv_6_native: false,
})

Response structure


resp.subnet.availability_zone_id #=> String
resp.subnet.enable_lni_at_device_index #=> Integer
resp.subnet.map_customer_owned_ip_on_launch #=> Boolean
resp.subnet.customer_owned_ipv_4_pool #=> String
resp.subnet.owner_id #=> String
resp.subnet.assign_ipv_6_address_on_creation #=> Boolean
resp.subnet.ipv_6_cidr_block_association_set #=> Array
resp.subnet.ipv_6_cidr_block_association_set[0].association_id #=> String
resp.subnet.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block #=> String
resp.subnet.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.subnet.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.status_message #=> String
resp.subnet.ipv_6_cidr_block_association_set[0].ipv_6_address_attribute #=> String, one of "public", "private"
resp.subnet.ipv_6_cidr_block_association_set[0].ip_source #=> String, one of "amazon", "byoip", "none"
resp.subnet.tags #=> Array
resp.subnet.tags[0].key #=> String
resp.subnet.tags[0].value #=> String
resp.subnet.subnet_arn #=> String
resp.subnet.outpost_arn #=> String
resp.subnet.enable_dns_64 #=> Boolean
resp.subnet.ipv_6_native #=> Boolean
resp.subnet.private_dns_name_options_on_launch.hostname_type #=> String, one of "ip-name", "resource-name"
resp.subnet.private_dns_name_options_on_launch.enable_resource_name_dns_a_record #=> Boolean
resp.subnet.private_dns_name_options_on_launch.enable_resource_name_dns_aaaa_record #=> Boolean
resp.subnet.subnet_id #=> String
resp.subnet.state #=> String, one of "pending", "available", "unavailable"
resp.subnet.vpc_id #=> String
resp.subnet.cidr_block #=> String
resp.subnet.available_ip_address_count #=> Integer
resp.subnet.availability_zone #=> String
resp.subnet.default_for_az #=> Boolean
resp.subnet.map_public_ip_on_launch #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :availability_zone (required, String) —

    The Availability Zone in which to create the default subnet.

  • :dry_run (Boolean) —

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

  • :ipv_6_native (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.

Returns:

See Also:



6226
6227
6228
6229
 
# File 'lib/aws-sdk-ec2/client.rb', line 6226

def create_default_subnet(params = {}, options = {})
  req = build_request(:create_default_subnet, params)
  req.send_request(options)
end

#create_default_vpc(params = {}) ⇒ Types::CreateDefaultVpcResult

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.

[1]: docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html

Examples:

Request syntax with placeholder values


resp = client.create_default_vpc({
  dry_run: false,
})

Response structure


resp.vpc.owner_id #=> String
resp.vpc.instance_tenancy #=> String, one of "default", "dedicated", "host"
resp.vpc.ipv_6_cidr_block_association_set #=> Array
resp.vpc.ipv_6_cidr_block_association_set[0].association_id #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.status_message #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].network_border_group #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_pool #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_address_attribute #=> String, one of "public", "private"
resp.vpc.ipv_6_cidr_block_association_set[0].ip_source #=> String, one of "amazon", "byoip", "none"
resp.vpc.cidr_block_association_set #=> Array
resp.vpc.cidr_block_association_set[0].association_id #=> String
resp.vpc.cidr_block_association_set[0].cidr_block #=> String
resp.vpc.cidr_block_association_set[0].cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.vpc.cidr_block_association_set[0].cidr_block_state.status_message #=> String
resp.vpc.is_default #=> Boolean
resp.vpc.tags #=> Array
resp.vpc.tags[0].key #=> String
resp.vpc.tags[0].value #=> String
resp.vpc.vpc_id #=> String
resp.vpc.state #=> String, one of "pending", "available"
resp.vpc.cidr_block #=> String
resp.vpc.dhcp_options_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



6291
6292
6293
6294
 
# File 'lib/aws-sdk-ec2/client.rb', line 6291

def create_default_vpc(params = {}, options = {})
  req = build_request(:create_default_vpc, params)
  req.send_request(options)
end

#create_dhcp_options(params = {}) ⇒ Types::CreateDhcpOptionsResult

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.

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html [2]: www.ietf.org/rfc/rfc2132.txt

Examples:

Example: To create a DHCP options set


# This example creates a DHCP options set.

resp = client.create_dhcp_options({
  dhcp_configurations: [
    {
      key: "domain-name-servers", 
      values: [
        "10.2.5.1", 
        "10.2.5.2", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  dhcp_options: {
    dhcp_configurations: [
      {
        key: "domain-name-servers", 
        values: [
          {
            value: "10.2.5.2", 
          }, 
          {
            value: "10.2.5.1", 
          }, 
        ], 
      }, 
    ], 
    dhcp_options_id: "dopt-d9070ebb", 
  }, 
}

Request syntax with placeholder values


resp = client.create_dhcp_options({
  dhcp_configurations: [ # required
    {
      key: "String",
      values: ["String"],
    },
  ],
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.dhcp_options.owner_id #=> String
resp.dhcp_options.tags #=> Array
resp.dhcp_options.tags[0].key #=> String
resp.dhcp_options.tags[0].value #=> String
resp.dhcp_options.dhcp_options_id #=> String
resp.dhcp_options.dhcp_configurations #=> Array
resp.dhcp_options.dhcp_configurations[0].key #=> String
resp.dhcp_options.dhcp_configurations[0].values #=> Array
resp.dhcp_options.dhcp_configurations[0].values[0] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dhcp_configurations (required, Array<Types::NewDhcpConfiguration>) —

    A DHCP configuration option.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the DHCP option.

  • :dry_run (Boolean) —

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

Returns:

See Also:



6442
6443
6444
6445
 
# File 'lib/aws-sdk-ec2/client.rb', line 6442

def create_dhcp_options(params = {}, options = {})
  req = build_request(:create_dhcp_options, params)
  req.send_request(options)
end

#create_egress_only_internet_gateway(params = {}) ⇒ Types::CreateEgressOnlyInternetGatewayResult

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

Examples:

Request syntax with placeholder values


resp = client.create_egress_only_internet_gateway({
  client_token: "String",
  dry_run: false,
  vpc_id: "VpcId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.client_token #=> String
resp.egress_only_internet_gateway.attachments #=> Array
resp.egress_only_internet_gateway.attachments[0].state #=> String, one of "attaching", "attached", "detaching", "detached"
resp.egress_only_internet_gateway.attachments[0].vpc_id #=> String
resp.egress_only_internet_gateway.egress_only_internet_gateway_id #=> String
resp.egress_only_internet_gateway.tags #=> Array
resp.egress_only_internet_gateway.tags[0].key #=> String
resp.egress_only_internet_gateway.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :vpc_id (required, String) —

    The ID of the VPC for which to create the egress-only internet gateway.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the egress-only internet gateway.

Returns:

See Also:



6514
6515
6516
6517
 
# File 'lib/aws-sdk-ec2/client.rb', line 6514

def create_egress_only_internet_gateway(params = {}, options = {})
  req = build_request(:create_egress_only_internet_gateway, params)
  req.send_request(options)
end

#create_fleet(params = {}) ⇒ Types::CreateFleetResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html

Examples:

Request syntax with placeholder values


resp = client.create_fleet({
  dry_run: false,
  client_token: "String",
  spot_options: {
    allocation_strategy: "lowest-price", # accepts lowest-price, diversified, capacity-optimized, capacity-optimized-prioritized, price-capacity-optimized
    maintenance_strategies: {
      capacity_rebalance: {
        replacement_strategy: "launch", # accepts launch, launch-before-terminate
        termination_delay: 1,
      },
    },
    instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
    instance_pools_to_use_count: 1,
    single_instance_type: false,
    single_availability_zone: false,
    min_target_capacity: 1,
    max_total_price: "String",
  },
  on_demand_options: {
    allocation_strategy: "lowest-price", # accepts lowest-price, prioritized
    capacity_reservation_options: {
      usage_strategy: "use-capacity-reservations-first", # accepts use-capacity-reservations-first, use-capacity-reservations-only, none
    },
    single_instance_type: false,
    single_availability_zone: false,
    min_target_capacity: 1,
    max_total_price: "String",
  },
  excess_capacity_termination_policy: "no-termination", # accepts no-termination, termination
  launch_template_configs: [ # required
    {
      launch_template_specification: {
        launch_template_id: "LaunchTemplateId",
        launch_template_name: "LaunchTemplateName",
        version: "String",
      },
      overrides: [
        {
          instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
          max_price: "String",
          subnet_id: "SubnetId",
          availability_zone: "String",
          weighted_capacity: 1.0,
          priority: 1.0,
          placement: {
            affinity: "String",
            group_name: "PlacementGroupName",
            partition_number: 1,
            host_id: "String",
            tenancy: "default", # accepts default, dedicated, host
            spread_domain: "String",
            host_resource_group_arn: "String",
            group_id: "PlacementGroupId",
            availability_zone: "String",
          },
          instance_requirements: {
            v_cpu_count: { # required
              min: 1, # required
              max: 1,
            },
            memory_mi_b: { # required
              min: 1, # required
              max: 1,
            },
            cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
            memory_gi_b_per_v_cpu: {
              min: 1.0,
              max: 1.0,
            },
            excluded_instance_types: ["ExcludedInstanceType"],
            instance_generations: ["current"], # accepts current, previous
            spot_max_price_percentage_over_lowest_price: 1,
            on_demand_max_price_percentage_over_lowest_price: 1,
            bare_metal: "included", # accepts included, required, excluded
            burstable_performance: "included", # accepts included, required, excluded
            require_hibernate_support: false,
            network_interface_count: {
              min: 1,
              max: 1,
            },
            local_storage: "included", # accepts included, required, excluded
            local_storage_types: ["hdd"], # accepts hdd, ssd
            total_local_storage_gb: {
              min: 1.0,
              max: 1.0,
            },
            baseline_ebs_bandwidth_mbps: {
              min: 1,
              max: 1,
            },
            accelerator_types: ["gpu"], # accepts gpu, fpga, inference
            accelerator_count: {
              min: 1,
              max: 1,
            },
            accelerator_manufacturers: ["amazon-web-services"], # accepts amazon-web-services, amd, nvidia, xilinx, habana
            accelerator_names: ["a100"], # accepts a100, inferentia, k520, k80, m60, radeon-pro-v520, t4, vu9p, v100, a10g, h100, t4g
            accelerator_total_memory_mi_b: {
              min: 1,
              max: 1,
            },
            network_bandwidth_gbps: {
              min: 1.0,
              max: 1.0,
            },
            allowed_instance_types: ["AllowedInstanceType"],
            max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
          },
          image_id: "ImageId",
        },
      ],
    },
  ],
  target_capacity_specification: { # required
    total_target_capacity: 1, # required
    on_demand_target_capacity: 1,
    spot_target_capacity: 1,
    default_target_capacity_type: "spot", # accepts spot, on-demand, capacity-block
    target_capacity_unit_type: "vcpu", # accepts vcpu, memory-mib, units
  },
  terminate_instances_with_expiration: false,
  type: "request", # accepts request, maintain, instant
  valid_from: Time.now,
  valid_until: Time.now,
  replace_unhealthy_instances: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  context: "String",
})

Response structure


resp.fleet_id #=> String
resp.errors #=> Array
resp.errors[0].launch_template_and_overrides.launch_template_specification.launch_template_id #=> String
resp.errors[0].launch_template_and_overrides.launch_template_specification.launch_template_name #=> String
resp.errors[0].launch_template_and_overrides.launch_template_specification.version #=> String
resp.errors[0].launch_template_and_overrides.overrides.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.errors[0].launch_template_and_overrides.overrides.max_price #=> String
resp.errors[0].launch_template_and_overrides.overrides.subnet_id #=> String
resp.errors[0].launch_template_and_overrides.overrides.availability_zone #=> String
resp.errors[0].launch_template_and_overrides.overrides.weighted_capacity #=> Float
resp.errors[0].launch_template_and_overrides.overrides.priority #=> Float
resp.errors[0].launch_template_and_overrides.overrides.placement.group_name #=> String
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.v_cpu_count.min #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.v_cpu_count.max #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.memory_mi_b.min #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.memory_mi_b.max #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.cpu_manufacturers #=> Array
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.excluded_instance_types #=> Array
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.excluded_instance_types[0] #=> String
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.instance_generations #=> Array
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.require_hibernate_support #=> Boolean
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.network_interface_count.min #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.network_interface_count.max #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.local_storage_types #=> Array
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.total_local_storage_gb.min #=> Float
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.total_local_storage_gb.max #=> Float
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_types #=> Array
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_count.min #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_count.max #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_manufacturers #=> Array
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_names #=> Array
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.network_bandwidth_gbps.min #=> Float
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.network_bandwidth_gbps.max #=> Float
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.allowed_instance_types #=> Array
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.allowed_instance_types[0] #=> String
resp.errors[0].launch_template_and_overrides.overrides.instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.errors[0].launch_template_and_overrides.overrides.image_id #=> String
resp.errors[0].lifecycle #=> String, one of "spot", "on-demand"
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.instances #=> Array
resp.instances[0].launch_template_and_overrides.launch_template_specification.launch_template_id #=> String
resp.instances[0].launch_template_and_overrides.launch_template_specification.launch_template_name #=> String
resp.instances[0].launch_template_and_overrides.launch_template_specification.version #=> String
resp.instances[0].launch_template_and_overrides.overrides.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.instances[0].launch_template_and_overrides.overrides.max_price #=> String
resp.instances[0].launch_template_and_overrides.overrides.subnet_id #=> String
resp.instances[0].launch_template_and_overrides.overrides.availability_zone #=> String
resp.instances[0].launch_template_and_overrides.overrides.weighted_capacity #=> Float
resp.instances[0].launch_template_and_overrides.overrides.priority #=> Float
resp.instances[0].launch_template_and_overrides.overrides.placement.group_name #=> String
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.v_cpu_count.min #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.v_cpu_count.max #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.memory_mi_b.min #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.memory_mi_b.max #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.cpu_manufacturers #=> Array
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.excluded_instance_types #=> Array
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.excluded_instance_types[0] #=> String
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.instance_generations #=> Array
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.require_hibernate_support #=> Boolean
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.network_interface_count.min #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.network_interface_count.max #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.local_storage_types #=> Array
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.total_local_storage_gb.min #=> Float
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.total_local_storage_gb.max #=> Float
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_types #=> Array
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_count.min #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_count.max #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_manufacturers #=> Array
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_names #=> Array
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.network_bandwidth_gbps.min #=> Float
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.network_bandwidth_gbps.max #=> Float
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.allowed_instance_types #=> Array
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.allowed_instance_types[0] #=> String
resp.instances[0].launch_template_and_overrides.overrides.instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.instances[0].launch_template_and_overrides.overrides.image_id #=> String
resp.instances[0].lifecycle #=> String, one of "spot", "on-demand"
resp.instances[0].instance_ids #=> Array
resp.instances[0].instance_ids[0] #=> String
resp.instances[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.instances[0].platform #=> String, one of "Windows"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :spot_options (Types::SpotOptionsRequest) —

    Describes the configuration of Spot Instances in an EC2 Fleet.

  • :on_demand_options (Types::OnDemandOptionsRequest) —

    Describes the configuration of On-Demand Instances in an EC2 Fleet.

  • :excess_capacity_termination_policy (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`.

  • :launch_template_configs (required, Array<Types::FleetLaunchTemplateConfigRequest>) —

    The configuration for the EC2 Fleet.

  • :target_capacity_specification (required, Types::TargetCapacitySpecificationRequest) —

    The number of units to request.

  • :terminate_instances_with_expiration (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html

  • :valid_from (Time, DateTime, Date, Integer, String) —

    The start date and time of the request, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z). The default is to start fulfilling the request immediately.

  • :valid_until (Time, DateTime, Date, Integer, String) —

    The end date and time of the request, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z). 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.

  • :replace_unhealthy_instances (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks

  • :tag_specifications (Array<Types::TagSpecification>) —

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

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template

  • :context (String) —

    Reserved.

Returns:

See Also:



6903
6904
6905
6906
 
# File 'lib/aws-sdk-ec2/client.rb', line 6903

def create_fleet(params = {}, options = {})
  req = build_request(:create_fleet, params)
  req.send_request(options)
end

#create_flow_logs(params = {}) ⇒ Types::CreateFlowLogsResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records [2]: docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html

Examples:

Request syntax with placeholder values


resp = client.create_flow_logs({
  dry_run: false,
  client_token: "String",
  deliver_logs_permission_arn: "String",
  deliver_cross_account_role: "String",
  log_group_name: "String",
  resource_ids: ["FlowLogResourceId"], # required
  resource_type: "VPC", # required, accepts VPC, Subnet, NetworkInterface, TransitGateway, TransitGatewayAttachment
  traffic_type: "ACCEPT", # accepts ACCEPT, REJECT, ALL
  log_destination_type: "cloud-watch-logs", # accepts cloud-watch-logs, s3, kinesis-data-firehose
  log_destination: "String",
  log_format: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  max_aggregation_interval: 1,
  destination_options: {
    file_format: "plain-text", # accepts plain-text, parquet
    hive_compatible_partitions: false,
    per_hour_partition: false,
  },
})

Response structure


resp.client_token #=> String
resp.flow_log_ids #=> Array
resp.flow_log_ids[0] #=> String
resp.unsuccessful #=> Array
resp.unsuccessful[0].error.code #=> String
resp.unsuccessful[0].error.message #=> String
resp.unsuccessful[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :deliver_logs_permission_arn (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.

  • :deliver_cross_account_role (String) —

    The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

  • :log_group_name (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`.

  • :resource_ids (required, 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.

  • :resource_type (required, String) —

    The type of resource to monitor.

  • :traffic_type (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.

  • :log_destination_type (String) —

    The type of destination for the flow log data.

    Default: ‘cloud-watch-logs`

  • :log_destination (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

  • :log_format (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.

    [1]: docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records [2]: docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the flow logs.

  • :max_aggregation_interval (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

    [1]: docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html

  • :destination_options (Types::DestinationOptionsRequest) —

    The destination options.

Returns:

See Also:



7101
7102
7103
7104
 
# File 'lib/aws-sdk-ec2/client.rb', line 7101

def create_flow_logs(params = {}, options = {})
  req = build_request(:create_flow_logs, params)
  req.send_request(options)
end

#create_fpga_image(params = {}) ⇒ Types::CreateFpgaImageResult

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

[1]: github.com/aws/aws-fpga/

Examples:

Request syntax with placeholder values


resp = client.create_fpga_image({
  dry_run: false,
  input_storage_location: { # required
    bucket: "String",
    key: "String",
  },
  logs_storage_location: {
    bucket: "String",
    key: "String",
  },
  description: "String",
  name: "String",
  client_token: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.fpga_image_id #=> String
resp.fpga_image_global_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :input_storage_location (required, Types::StorageLocation) —

    The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

  • :logs_storage_location (Types::StorageLocation) —

    The location in Amazon S3 for the output logs.

  • :description (String) —

    A description for the AFI.

  • :name (String) —

    A name for the AFI.

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the FPGA image during creation.

Returns:

See Also:



7194
7195
7196
7197
 
# File 'lib/aws-sdk-ec2/client.rb', line 7194

def create_fpga_image(params = {}, options = {})
  req = build_request(:create_fpga_image, params)
  req.send_request(options)
end

#create_image(params = {}) ⇒ Types::CreateImageResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html

Examples:

Example: 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.

resp = client.create_image({
  block_device_mappings: [
    {
      device_name: "/dev/sdh", 
      ebs: {
        volume_size: 100, 
      }, 
    }, 
    {
      device_name: "/dev/sdc", 
      virtual_name: "ephemeral1", 
    }, 
  ], 
  description: "An AMI for my server", 
  instance_id: "i-1234567890abcdef0", 
  name: "My server", 
  no_reboot: true, 
})

resp.to_h outputs the following:
{
  image_id: "ami-1a2b3c4d", 
}

Request syntax with placeholder values


resp = client.create_image({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  instance_id: "InstanceId", # required
  name: "String", # required
  description: "String",
  no_reboot: false,
  block_device_mappings: [
    {
      ebs: {
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "SnapshotId",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
        kms_key_id: "String",
        throughput: 1,
        outpost_arn: "String",
        encrypted: false,
      },
      no_device: "String",
      device_name: "String",
      virtual_name: "String",
    },
  ],
})

Response structure


resp.image_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.

    • To tag the AMI, the value for ‘ResourceType` must be `image`.

    • To tag the snapshots that are created of the root volume and of other 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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the instance.

  • :name (required, 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(_)

  • :description (String) —

    A description for the new image.

  • :no_reboot (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`

  • :block_device_mappings (Array<Types::BlockDeviceMapping>) —

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

Returns:

See Also:



7369
7370
7371
7372
 
# File 'lib/aws-sdk-ec2/client.rb', line 7369

def create_image(params = {}, options = {})
  req = build_request(:create_image, params)
  req.send_request(options)
end

#create_instance_connect_endpoint(params = {}) ⇒ Types::CreateInstanceConnectEndpointResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect-Endpoint.html

Examples:

Request syntax with placeholder values


resp = client.create_instance_connect_endpoint({
  dry_run: false,
  subnet_id: "SubnetId", # required
  security_group_ids: ["SecurityGroupId"],
  preserve_client_ip: false,
  client_token: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.instance_connect_endpoint.owner_id #=> String
resp.instance_connect_endpoint.instance_connect_endpoint_id #=> String
resp.instance_connect_endpoint.instance_connect_endpoint_arn #=> String
resp.instance_connect_endpoint.state #=> String, one of "create-in-progress", "create-complete", "create-failed", "delete-in-progress", "delete-complete", "delete-failed"
resp.instance_connect_endpoint.state_message #=> String
resp.instance_connect_endpoint.dns_name #=> String
resp.instance_connect_endpoint.fips_dns_name #=> String
resp.instance_connect_endpoint.network_interface_ids #=> Array
resp.instance_connect_endpoint.network_interface_ids[0] #=> String
resp.instance_connect_endpoint.vpc_id #=> String
resp.instance_connect_endpoint.availability_zone #=> String
resp.instance_connect_endpoint.created_at #=> Time
resp.instance_connect_endpoint.subnet_id #=> String
resp.instance_connect_endpoint.preserve_client_ip #=> Boolean
resp.instance_connect_endpoint.security_group_ids #=> Array
resp.instance_connect_endpoint.security_group_ids[0] #=> String
resp.instance_connect_endpoint.tags #=> Array
resp.instance_connect_endpoint.tags[0].key #=> String
resp.instance_connect_endpoint.tags[0].value #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :subnet_id (required, String) —

    The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

  • :security_group_ids (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.

  • :preserve_client_ip (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`

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the EC2 Instance Connect Endpoint during creation.

Returns:

See Also:



7475
7476
7477
7478
 
# File 'lib/aws-sdk-ec2/client.rb', line 7475

def create_instance_connect_endpoint(params = {}, options = {})
  req = build_request(:create_instance_connect_endpoint, params)
  req.send_request(options)
end

#create_instance_event_window(params = {}) ⇒ Types::CreateInstanceEventWindowResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html

Examples:

Request syntax with placeholder values


resp = client.create_instance_event_window({
  dry_run: false,
  name: "String",
  time_ranges: [
    {
      start_week_day: "sunday", # accepts sunday, monday, tuesday, wednesday, thursday, friday, saturday
      start_hour: 1,
      end_week_day: "sunday", # accepts sunday, monday, tuesday, wednesday, thursday, friday, saturday
      end_hour: 1,
    },
  ],
  cron_expression: "InstanceEventWindowCronExpression",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.instance_event_window.instance_event_window_id #=> String
resp.instance_event_window.time_ranges #=> Array
resp.instance_event_window.time_ranges[0].start_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_window.time_ranges[0].start_hour #=> Integer
resp.instance_event_window.time_ranges[0].end_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_window.time_ranges[0].end_hour #=> Integer
resp.instance_event_window.name #=> String
resp.instance_event_window.cron_expression #=> String
resp.instance_event_window.association_target.instance_ids #=> Array
resp.instance_event_window.association_target.instance_ids[0] #=> String
resp.instance_event_window.association_target.tags #=> Array
resp.instance_event_window.association_target.tags[0].key #=> String
resp.instance_event_window.association_target.tags[0].value #=> String
resp.instance_event_window.association_target.dedicated_host_ids #=> Array
resp.instance_event_window.association_target.dedicated_host_ids[0] #=> String
resp.instance_event_window.state #=> String, one of "creating", "deleting", "active", "deleted"
resp.instance_event_window.tags #=> Array
resp.instance_event_window.tags[0].key #=> String
resp.instance_event_window.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :time_ranges (Array<Types::InstanceEventWindowTimeRangeRequest>) —

    The time range for the event window. If you specify a time range, you can’t specify a cron expression.

  • :cron_expression (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 &gt;= 2 hours, for example, ‘0-2` or `20-23`.

    • The event window must be &gt;= 4 hours. The combined total time ranges in the event window must be &gt;= 4 hours.

    For more information about cron expressions, see [cron] on the *Wikipedia website*.

    [1]: en.wikipedia.org/wiki/Cron

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the event window.

Returns:

See Also:



7613
7614
7615
7616
 
# File 'lib/aws-sdk-ec2/client.rb', line 7613

def create_instance_event_window(params = {}, options = {})
  req = build_request(:create_instance_event_window, params)
  req.send_request(options)
end

#create_instance_export_task(params = {}) ⇒ Types::CreateInstanceExportTaskResult

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

[1]: docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html

Examples:

Request syntax with placeholder values


resp = client.create_instance_export_task({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  description: "String",
  instance_id: "InstanceId", # required
  target_environment: "citrix", # required, accepts citrix, vmware, microsoft
  export_to_s3_task: { # required
    disk_image_format: "VMDK", # accepts VMDK, RAW, VHD
    container_format: "ova", # accepts ova
    s3_bucket: "String",
    s3_prefix: "String",
  },
})

Response structure


resp.export_task.description #=> String
resp.export_task.export_task_id #=> String
resp.export_task.export_to_s3_task.container_format #=> String, one of "ova"
resp.export_task.export_to_s3_task.disk_image_format #=> String, one of "VMDK", "RAW", "VHD"
resp.export_task.export_to_s3_task.s3_bucket #=> String
resp.export_task.export_to_s3_task.s3_key #=> String
resp.export_task.instance_export_details.instance_id #=> String
resp.export_task.instance_export_details.target_environment #=> String, one of "citrix", "vmware", "microsoft"
resp.export_task.state #=> String, one of "active", "cancelling", "cancelled", "completed"
resp.export_task.status_message #=> String
resp.export_task.tags #=> Array
resp.export_task.tags[0].key #=> String
resp.export_task.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the export instance task during creation.

  • :description (String) —

    A description for the conversion task or the resource being exported. The maximum length is 255 characters.

  • :instance_id (required, String) —

    The ID of the instance.

  • :target_environment (required, String) —

    The target virtualization environment.

  • :export_to_s3_task (required, Types::ExportToS3TaskSpecification) —

    The format and location for an export instance task.

Returns:

See Also:



7694
7695
7696
7697
 
# File 'lib/aws-sdk-ec2/client.rb', line 7694

def create_instance_export_task(params = {}, options = {})
  req = build_request(:create_instance_export_task, params)
  req.send_request(options)
end

#create_internet_gateway(params = {}) ⇒ Types::CreateInternetGatewayResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html

Examples:

Example: To create an Internet gateway


# This example creates an Internet gateway.

resp = client.create_internet_gateway({
})

resp.to_h outputs the following:
{
  internet_gateway: {
    attachments: [
    ], 
    internet_gateway_id: "igw-c0a643a9", 
    tags: [
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.create_internet_gateway({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.internet_gateway.attachments #=> Array
resp.internet_gateway.attachments[0].state #=> String, one of "attaching", "attached", "detaching", "detached"
resp.internet_gateway.attachments[0].vpc_id #=> String
resp.internet_gateway.internet_gateway_id #=> String
resp.internet_gateway.owner_id #=> String
resp.internet_gateway.tags #=> Array
resp.internet_gateway.tags[0].key #=> String
resp.internet_gateway.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the internet gateway.

  • :dry_run (Boolean) —

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

Returns:

See Also:



7773
7774
7775
7776
 
# File 'lib/aws-sdk-ec2/client.rb', line 7773

def create_internet_gateway(params = {}, options = {})
  req = build_request(:create_internet_gateway, params)
  req.send_request(options)
end

#create_ipam(params = {}) ⇒ Types::CreateIpamResult

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

[1]: docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html

Examples:

Request syntax with placeholder values


resp = client.create_ipam({
  dry_run: false,
  description: "String",
  operating_regions: [
    {
      region_name: "String",
    },
  ],
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
  tier: "free", # accepts free, advanced
  enable_private_gua: false,
})

Response structure


resp.ipam.owner_id #=> String
resp.ipam.ipam_id #=> String
resp.ipam.ipam_arn #=> String
resp.ipam.ipam_region #=> String
resp.ipam.public_default_scope_id #=> String
resp.ipam.private_default_scope_id #=> String
resp.ipam.scope_count #=> Integer
resp.ipam.description #=> String
resp.ipam.operating_regions #=> Array
resp.ipam.operating_regions[0].region_name #=> String
resp.ipam.state #=> String, one of "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"
resp.ipam.tags #=> Array
resp.ipam.tags[0].key #=> String
resp.ipam.tags[0].value #=> String
resp.ipam.default_resource_discovery_id #=> String
resp.ipam.default_resource_discovery_association_id #=> String
resp.ipam.resource_discovery_association_count #=> Integer
resp.ipam.state_message #=> String
resp.ipam.tier #=> String, one of "free", "advanced"
resp.ipam.enable_private_gua #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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.

  • :operating_regions (Array<Types::AddIpamOperatingRegion>) —

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

    [1]: docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html

  • :tag_specifications (Array<Types::TagSpecification>) —

    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.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :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 &gt; IPAM tab].

    [1]: aws.amazon.com/vpc/pricing/

  • :enable_private_gua (Boolean) —

    Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Returns:

See Also:



7902
7903
7904
7905
 
# File 'lib/aws-sdk-ec2/client.rb', line 7902

def create_ipam(params = {}, options = {})
  req = build_request(:create_ipam, params)
  req.send_request(options)
end

#create_ipam_external_resource_verification_token(params = {}) ⇒ Types::CreateIpamExternalResourceVerificationTokenResult

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

Examples:

Request syntax with placeholder values


resp = client.create_ipam_external_resource_verification_token({
  dry_run: false,
  ipam_id: "IpamId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
})

Response structure


resp.ipam_external_resource_verification_token.ipam_external_resource_verification_token_id #=> String
resp.ipam_external_resource_verification_token.ipam_external_resource_verification_token_arn #=> String
resp.ipam_external_resource_verification_token.ipam_id #=> String
resp.ipam_external_resource_verification_token.ipam_arn #=> String
resp.ipam_external_resource_verification_token.ipam_region #=> String
resp.ipam_external_resource_verification_token.token_value #=> String
resp.ipam_external_resource_verification_token.token_name #=> String
resp.ipam_external_resource_verification_token.not_after #=> Time
resp.ipam_external_resource_verification_token.status #=> String, one of "valid", "expired"
resp.ipam_external_resource_verification_token.tags #=> Array
resp.ipam_external_resource_verification_token.tags[0].key #=> String
resp.ipam_external_resource_verification_token.tags[0].value #=> String
resp.ipam_external_resource_verification_token.state #=> String, one of "create-in-progress", "create-complete", "create-failed", "delete-in-progress", "delete-complete", "delete-failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_id (required, String) —

    The ID of the IPAM that will create the token.

  • :tag_specifications (Array<Types::TagSpecification>) —

    Token tags.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



7980
7981
7982
7983
 
# File 'lib/aws-sdk-ec2/client.rb', line 7980

def create_ipam_external_resource_verification_token(params = {}, options = {})
  req = build_request(:create_ipam_external_resource_verification_token, params)
  req.send_request(options)
end

#create_ipam_pool(params = {}) ⇒ Types::CreateIpamPoolResult

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

[1]: docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html

Examples:

Request syntax with placeholder values


resp = client.create_ipam_pool({
  dry_run: false,
  ipam_scope_id: "IpamScopeId", # required
  locale: "String",
  source_ipam_pool_id: "IpamPoolId",
  description: "String",
  address_family: "ipv4", # required, accepts ipv4, ipv6
  auto_import: false,
  publicly_advertisable: false,
  allocation_min_netmask_length: 1,
  allocation_max_netmask_length: 1,
  allocation_default_netmask_length: 1,
  allocation_resource_tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
  aws_service: "ec2", # accepts ec2
  public_ip_source: "amazon", # accepts amazon, byoip
  source_resource: {
    resource_id: "String",
    resource_type: "vpc", # accepts vpc
    resource_region: "String",
    resource_owner: "String",
  },
})

Response structure


resp.ipam_pool.owner_id #=> String
resp.ipam_pool.ipam_pool_id #=> String
resp.ipam_pool.source_ipam_pool_id #=> String
resp.ipam_pool.ipam_pool_arn #=> String
resp.ipam_pool.ipam_scope_arn #=> String
resp.ipam_pool.ipam_scope_type #=> String, one of "public", "private"
resp.ipam_pool.ipam_arn #=> String
resp.ipam_pool.ipam_region #=> String
resp.ipam_pool.locale #=> String
resp.ipam_pool.pool_depth #=> Integer
resp.ipam_pool.state #=> String, one of "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"
resp.ipam_pool.state_message #=> String
resp.ipam_pool.description #=> String
resp.ipam_pool.auto_import #=> Boolean
resp.ipam_pool.publicly_advertisable #=> Boolean
resp.ipam_pool.address_family #=> String, one of "ipv4", "ipv6"
resp.ipam_pool.allocation_min_netmask_length #=> Integer
resp.ipam_pool.allocation_max_netmask_length #=> Integer
resp.ipam_pool.allocation_default_netmask_length #=> Integer
resp.ipam_pool.allocation_resource_tags #=> Array
resp.ipam_pool.allocation_resource_tags[0].key #=> String
resp.ipam_pool.allocation_resource_tags[0].value #=> String
resp.ipam_pool.tags #=> Array
resp.ipam_pool.tags[0].key #=> String
resp.ipam_pool.tags[0].value #=> String
resp.ipam_pool.aws_service #=> String, one of "ec2"
resp.ipam_pool.public_ip_source #=> String, one of "amazon", "byoip"
resp.ipam_pool.source_resource.resource_id #=> String
resp.ipam_pool.source_resource.resource_type #=> String, one of "vpc"
resp.ipam_pool.source_resource.resource_region #=> String
resp.ipam_pool.source_resource.resource_owner #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_scope_id (required, 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. Default is ‘none` and means any locale.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail

  • :source_ipam_pool_id (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.

  • :address_family (required, String) —

    The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

  • :auto_import (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.

  • :publicly_advertisable (Boolean) —

    Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ‘ipv4`.

  • :allocation_min_netmask_length (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.

  • :allocation_max_netmask_length (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.

  • :allocation_default_netmask_length (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.

  • :allocation_resource_tags (Array<Types::RequestIpamResourceTag>) —

    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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    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.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :aws_service (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.

  • :public_ip_source (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*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html [2]: docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html

  • :source_resource (Types::IpamPoolSourceResourceRequest) —

    The resource used to provision CIDRs to a resource planning pool.

Returns:

See Also:



8212
8213
8214
8215
 
# File 'lib/aws-sdk-ec2/client.rb', line 8212

def create_ipam_pool(params = {}, options = {})
  req = build_request(:create_ipam_pool, params)
  req.send_request(options)
end

#create_ipam_resource_discovery(params = {}) ⇒ Types::CreateIpamResourceDiscoveryResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_ipam_resource_discovery({
  dry_run: false,
  description: "String",
  operating_regions: [
    {
      region_name: "String",
    },
  ],
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
})

Response structure


resp.ipam_resource_discovery.owner_id #=> String
resp.ipam_resource_discovery.ipam_resource_discovery_id #=> String
resp.ipam_resource_discovery.ipam_resource_discovery_arn #=> String
resp.ipam_resource_discovery.ipam_resource_discovery_region #=> String
resp.ipam_resource_discovery.description #=> String
resp.ipam_resource_discovery.operating_regions #=> Array
resp.ipam_resource_discovery.operating_regions[0].region_name #=> String
resp.ipam_resource_discovery.is_default #=> Boolean
resp.ipam_resource_discovery.state #=> String, one of "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"
resp.ipam_resource_discovery.tags #=> Array
resp.ipam_resource_discovery.tags[0].key #=> String
resp.ipam_resource_discovery.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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.

  • :operating_regions (Array<Types::AddIpamOperatingRegion>) —

    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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    Tag specifications for the IPAM resource discovery.

  • :client_token (String) —

    A client token for the IPAM resource discovery.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



8292
8293
8294
8295
 
# File 'lib/aws-sdk-ec2/client.rb', line 8292

def create_ipam_resource_discovery(params = {}, options = {})
  req = build_request(:create_ipam_resource_discovery, params)
  req.send_request(options)
end

#create_ipam_scope(params = {}) ⇒ Types::CreateIpamScopeResult

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

[1]: docs.aws.amazon.com/vpc/latest/ipam/add-scope-ipam.html

Examples:

Request syntax with placeholder values


resp = client.create_ipam_scope({
  dry_run: false,
  ipam_id: "IpamId", # required
  description: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
})

Response structure


resp.ipam_scope.owner_id #=> String
resp.ipam_scope.ipam_scope_id #=> String
resp.ipam_scope.ipam_scope_arn #=> String
resp.ipam_scope.ipam_arn #=> String
resp.ipam_scope.ipam_region #=> String
resp.ipam_scope.ipam_scope_type #=> String, one of "public", "private"
resp.ipam_scope.is_default #=> Boolean
resp.ipam_scope.description #=> String
resp.ipam_scope.pool_count #=> Integer
resp.ipam_scope.state #=> String, one of "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"
resp.ipam_scope.tags #=> Array
resp.ipam_scope.tags[0].key #=> String
resp.ipam_scope.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_id (required, String) —

    The ID of the IPAM for which you’re creating this scope.

  • :description (String) —

    A description for the scope you’re creating.

  • :tag_specifications (Array<Types::TagSpecification>) —

    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.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



8387
8388
8389
8390
 
# File 'lib/aws-sdk-ec2/client.rb', line 8387

def create_ipam_scope(params = {}, options = {})
  req = build_request(:create_ipam_scope, params)
  req.send_request(options)
end

#create_key_pair(params = {}) ⇒ Types::KeyPair

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html

Examples:

Example: To create a key pair


# This example creates a key pair named my-key-pair.

resp = client.create_key_pair({
  key_name: "my-key-pair", 
})

Request syntax with placeholder values


resp = client.create_key_pair({
  key_name: "String", # required
  key_type: "rsa", # accepts rsa, ed25519
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  key_format: "pem", # accepts pem, ppk
  dry_run: false,
})

Response structure


resp.key_pair_id #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.key_name #=> String
resp.key_fingerprint #=> String
resp.key_material #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_name (required, String) —

    A unique name for the key pair.

    Constraints: Up to 255 ASCII characters

  • :key_type (String) —

    The type of key pair. Note that ED25519 keys are not supported for Windows instances.

    Default: ‘rsa`

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the new key pair.

  • :key_format (String) —

    The format of the key pair.

    Default: ‘pem`

  • :dry_run (Boolean) —

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

Returns:

See Also:



8490
8491
8492
8493
 
# File 'lib/aws-sdk-ec2/client.rb', line 8490

def create_key_pair(params = {}, options = {})
  req = build_request(:create_key_pair, params)
  req.send_request(options)
end

#create_launch_template(params = {}) ⇒ Types::CreateLaunchTemplateResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template-from-existing-launch-template

Examples:

Example: 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.

resp = client.create_launch_template({
  launch_template_data: {
    image_id: "ami-8c1be5f6", 
    instance_type: "t2.small", 
    network_interfaces: [
      {
        associate_public_ip_address: true, 
        device_index: 0, 
        ipv_6_address_count: 1, 
        subnet_id: "subnet-7b16de0c", 
      }, 
    ], 
    tag_specifications: [
      {
        resource_type: "instance", 
        tags: [
          {
            key: "Name", 
            value: "webserver", 
          }, 
        ], 
      }, 
    ], 
  }, 
  launch_template_name: "my-template", 
  version_description: "WebVersion1", 
})

resp.to_h outputs the following:
{
  launch_template: {
    create_time: Time.parse("2017-11-27T09:13:24.000Z"), 
    created_by: "arn:aws:iam::123456789012:root", 
    default_version_number: 1, 
    latest_version_number: 1, 
    launch_template_id: "lt-01238c059e3466abc", 
    launch_template_name: "my-template", 
  }, 
}

Request syntax with placeholder values


resp = client.create_launch_template({
  dry_run: false,
  client_token: "String",
  launch_template_name: "LaunchTemplateName", # required
  version_description: "VersionDescription",
  launch_template_data: { # required
    kernel_id: "KernelId",
    ebs_optimized: false,
    iam_instance_profile: {
      arn: "String",
      name: "String",
    },
    block_device_mappings: [
      {
        device_name: "String",
        virtual_name: "String",
        ebs: {
          encrypted: false,
          delete_on_termination: false,
          iops: 1,
          kms_key_id: "KmsKeyId",
          snapshot_id: "SnapshotId",
          volume_size: 1,
          volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
          throughput: 1,
        },
        no_device: "String",
      },
    ],
    network_interfaces: [
      {
        associate_carrier_ip_address: false,
        associate_public_ip_address: false,
        delete_on_termination: false,
        description: "String",
        device_index: 1,
        groups: ["SecurityGroupId"],
        interface_type: "String",
        ipv_6_address_count: 1,
        ipv_6_addresses: [
          {
            ipv_6_address: "String",
          },
        ],
        network_interface_id: "NetworkInterfaceId",
        private_ip_address: "String",
        private_ip_addresses: [
          {
            primary: false,
            private_ip_address: "String",
          },
        ],
        secondary_private_ip_address_count: 1,
        subnet_id: "SubnetId",
        network_card_index: 1,
        ipv_4_prefixes: [
          {
            ipv_4_prefix: "String",
          },
        ],
        ipv_4_prefix_count: 1,
        ipv_6_prefixes: [
          {
            ipv_6_prefix: "String",
          },
        ],
        ipv_6_prefix_count: 1,
        primary_ipv_6: false,
        ena_srd_specification: {
          ena_srd_enabled: false,
          ena_srd_udp_specification: {
            ena_srd_udp_enabled: false,
          },
        },
        connection_tracking_specification: {
          tcp_established_timeout: 1,
          udp_stream_timeout: 1,
          udp_timeout: 1,
        },
      },
    ],
    image_id: "ImageId",
    instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
    key_name: "KeyPairName",
    monitoring: {
      enabled: false,
    },
    placement: {
      availability_zone: "String",
      affinity: "String",
      group_name: "PlacementGroupName",
      host_id: "DedicatedHostId",
      tenancy: "default", # accepts default, dedicated, host
      spread_domain: "String",
      host_resource_group_arn: "String",
      partition_number: 1,
      group_id: "PlacementGroupId",
    },
    ram_disk_id: "RamdiskId",
    disable_api_termination: false,
    instance_initiated_shutdown_behavior: "stop", # accepts stop, terminate
    user_data: "SensitiveUserData",
    tag_specifications: [
      {
        resource_type: "capacity-reservation", # accepts 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: "String",
          },
        ],
      },
    ],
    elastic_gpu_specifications: [
      {
        type: "String", # required
      },
    ],
    elastic_inference_accelerators: [
      {
        type: "String", # required
        count: 1,
      },
    ],
    security_group_ids: ["SecurityGroupId"],
    security_groups: ["SecurityGroupName"],
    instance_market_options: {
      market_type: "spot", # accepts spot, capacity-block
      spot_options: {
        max_price: "String",
        spot_instance_type: "one-time", # accepts one-time, persistent
        block_duration_minutes: 1,
        valid_until: Time.now,
        instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
      },
    },
    credit_specification: {
      cpu_credits: "String", # required
    },
    cpu_options: {
      core_count: 1,
      threads_per_core: 1,
      amd_sev_snp: "enabled", # accepts enabled, disabled
    },
    capacity_reservation_specification: {
      capacity_reservation_preference: "open", # accepts open, none
      capacity_reservation_target: {
        capacity_reservation_id: "CapacityReservationId",
        capacity_reservation_resource_group_arn: "String",
      },
    },
    license_specifications: [
      {
        license_configuration_arn: "String",
      },
    ],
    hibernation_options: {
      configured: false,
    },
    metadata_options: {
      http_tokens: "optional", # accepts optional, required
      http_put_response_hop_limit: 1,
      http_endpoint: "disabled", # accepts disabled, enabled
      http_protocol_ipv_6: "disabled", # accepts disabled, enabled
      instance_metadata_tags: "disabled", # accepts disabled, enabled
    },
    enclave_options: {
      enabled: false,
    },
    instance_requirements: {
      v_cpu_count: { # required
        min: 1, # required
        max: 1,
      },
      memory_mi_b: { # required
        min: 1, # required
        max: 1,
      },
      cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
      memory_gi_b_per_v_cpu: {
        min: 1.0,
        max: 1.0,
      },
      excluded_instance_types: ["ExcludedInstanceType"],
      instance_generations: ["current"], # accepts current, previous
      spot_max_price_percentage_over_lowest_price: 1,
      on_demand_max_price_percentage_over_lowest_price: 1,
      bare_metal: "included", # accepts included, required, excluded
      burstable_performance: "included", # accepts included, required, excluded
      require_hibernate_support: false,
      network_interface_count: {
        min: 1,
        max: 1,
      },
      local_storage: "included", # accepts included, required, excluded
      local_storage_types: ["hdd"], # accepts hdd, ssd
      total_local_storage_gb: {
        min: 1.0,
        max: 1.0,
      },
      baseline_ebs_bandwidth_mbps: {
        min: 1,
        max: 1,
      },
      accelerator_types: ["gpu"], # accepts gpu, fpga, inference
      accelerator_count: {
        min: 1,
        max: 1,
      },
      accelerator_manufacturers: ["amazon-web-services"], # accepts amazon-web-services, amd, nvidia, xilinx, habana
      accelerator_names: ["a100"], # accepts a100, inferentia, k520, k80, m60, radeon-pro-v520, t4, vu9p, v100, a10g, h100, t4g
      accelerator_total_memory_mi_b: {
        min: 1,
        max: 1,
      },
      network_bandwidth_gbps: {
        min: 1.0,
        max: 1.0,
      },
      allowed_instance_types: ["AllowedInstanceType"],
      max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
    },
    private_dns_name_options: {
      hostname_type: "ip-name", # accepts ip-name, resource-name
      enable_resource_name_dns_a_record: false,
      enable_resource_name_dns_aaaa_record: false,
    },
    maintenance_options: {
      auto_recovery: "default", # accepts default, disabled
    },
    disable_api_stop: false,
  },
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.launch_template.launch_template_id #=> String
resp.launch_template.launch_template_name #=> String
resp.launch_template.create_time #=> Time
resp.launch_template.created_by #=> String
resp.launch_template.default_version_number #=> Integer
resp.launch_template.latest_version_number #=> Integer
resp.launch_template.tags #=> Array
resp.launch_template.tags[0].key #=> String
resp.launch_template.tags[0].value #=> String
resp.warning.errors #=> Array
resp.warning.errors[0].code #=> String
resp.warning.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :client_token (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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :launch_template_name (required, String) —

    A name for the launch template.

  • :version_description (String) —

    A description for the first version of the launch template.

  • :launch_template_data (required, Types::RequestLaunchTemplateData) —

    The information for the launch template.

  • :tag_specifications (Array<Types::TagSpecification>) —

    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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html

Returns:

See Also:



8869
8870
8871
8872
 
# File 'lib/aws-sdk-ec2/client.rb', line 8869

def create_launch_template(params = {}, options = {})
  req = build_request(:create_launch_template, params)
  req.send_request(options)
end

#create_launch_template_version(params = {}) ⇒ Types::CreateLaunchTemplateVersionResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#manage-launch-template-versions

Examples:

Example: 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.

resp = client.create_launch_template_version({
  launch_template_data: {
    image_id: "ami-c998b6b2", 
  }, 
  launch_template_id: "lt-0abcd290751193123", 
  source_version: "1", 
  version_description: "WebVersion2", 
})

resp.to_h outputs the following:
{
  launch_template_version: {
    create_time: Time.parse("2017-12-01T13:35:46.000Z"), 
    created_by: "arn:aws:iam::123456789012:root", 
    default_version: false, 
    launch_template_data: {
      image_id: "ami-c998b6b2", 
      instance_type: "t2.micro", 
      network_interfaces: [
        {
          associate_public_ip_address: true, 
          device_index: 0, 
          ipv_6_addresses: [
            {
              ipv_6_address: "2001:db8:1234:1a00::123", 
            }, 
          ], 
          subnet_id: "subnet-7b16de0c", 
        }, 
      ], 
    }, 
    launch_template_id: "lt-0abcd290751193123", 
    launch_template_name: "my-template", 
    version_description: "WebVersion2", 
    version_number: 2, 
  }, 
}

Request syntax with placeholder values


resp = client.create_launch_template_version({
  dry_run: false,
  client_token: "String",
  launch_template_id: "LaunchTemplateId",
  launch_template_name: "LaunchTemplateName",
  source_version: "String",
  version_description: "VersionDescription",
  launch_template_data: { # required
    kernel_id: "KernelId",
    ebs_optimized: false,
    iam_instance_profile: {
      arn: "String",
      name: "String",
    },
    block_device_mappings: [
      {
        device_name: "String",
        virtual_name: "String",
        ebs: {
          encrypted: false,
          delete_on_termination: false,
          iops: 1,
          kms_key_id: "KmsKeyId",
          snapshot_id: "SnapshotId",
          volume_size: 1,
          volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
          throughput: 1,
        },
        no_device: "String",
      },
    ],
    network_interfaces: [
      {
        associate_carrier_ip_address: false,
        associate_public_ip_address: false,
        delete_on_termination: false,
        description: "String",
        device_index: 1,
        groups: ["SecurityGroupId"],
        interface_type: "String",
        ipv_6_address_count: 1,
        ipv_6_addresses: [
          {
            ipv_6_address: "String",
          },
        ],
        network_interface_id: "NetworkInterfaceId",
        private_ip_address: "String",
        private_ip_addresses: [
          {
            primary: false,
            private_ip_address: "String",
          },
        ],
        secondary_private_ip_address_count: 1,
        subnet_id: "SubnetId",
        network_card_index: 1,
        ipv_4_prefixes: [
          {
            ipv_4_prefix: "String",
          },
        ],
        ipv_4_prefix_count: 1,
        ipv_6_prefixes: [
          {
            ipv_6_prefix: "String",
          },
        ],
        ipv_6_prefix_count: 1,
        primary_ipv_6: false,
        ena_srd_specification: {
          ena_srd_enabled: false,
          ena_srd_udp_specification: {
            ena_srd_udp_enabled: false,
          },
        },
        connection_tracking_specification: {
          tcp_established_timeout: 1,
          udp_stream_timeout: 1,
          udp_timeout: 1,
        },
      },
    ],
    image_id: "ImageId",
    instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
    key_name: "KeyPairName",
    monitoring: {
      enabled: false,
    },
    placement: {
      availability_zone: "String",
      affinity: "String",
      group_name: "PlacementGroupName",
      host_id: "DedicatedHostId",
      tenancy: "default", # accepts default, dedicated, host
      spread_domain: "String",
      host_resource_group_arn: "String",
      partition_number: 1,
      group_id: "PlacementGroupId",
    },
    ram_disk_id: "RamdiskId",
    disable_api_termination: false,
    instance_initiated_shutdown_behavior: "stop", # accepts stop, terminate
    user_data: "SensitiveUserData",
    tag_specifications: [
      {
        resource_type: "capacity-reservation", # accepts 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: "String",
          },
        ],
      },
    ],
    elastic_gpu_specifications: [
      {
        type: "String", # required
      },
    ],
    elastic_inference_accelerators: [
      {
        type: "String", # required
        count: 1,
      },
    ],
    security_group_ids: ["SecurityGroupId"],
    security_groups: ["SecurityGroupName"],
    instance_market_options: {
      market_type: "spot", # accepts spot, capacity-block
      spot_options: {
        max_price: "String",
        spot_instance_type: "one-time", # accepts one-time, persistent
        block_duration_minutes: 1,
        valid_until: Time.now,
        instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
      },
    },
    credit_specification: {
      cpu_credits: "String", # required
    },
    cpu_options: {
      core_count: 1,
      threads_per_core: 1,
      amd_sev_snp: "enabled", # accepts enabled, disabled
    },
    capacity_reservation_specification: {
      capacity_reservation_preference: "open", # accepts open, none
      capacity_reservation_target: {
        capacity_reservation_id: "CapacityReservationId",
        capacity_reservation_resource_group_arn: "String",
      },
    },
    license_specifications: [
      {
        license_configuration_arn: "String",
      },
    ],
    hibernation_options: {
      configured: false,
    },
    metadata_options: {
      http_tokens: "optional", # accepts optional, required
      http_put_response_hop_limit: 1,
      http_endpoint: "disabled", # accepts disabled, enabled
      http_protocol_ipv_6: "disabled", # accepts disabled, enabled
      instance_metadata_tags: "disabled", # accepts disabled, enabled
    },
    enclave_options: {
      enabled: false,
    },
    instance_requirements: {
      v_cpu_count: { # required
        min: 1, # required
        max: 1,
      },
      memory_mi_b: { # required
        min: 1, # required
        max: 1,
      },
      cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
      memory_gi_b_per_v_cpu: {
        min: 1.0,
        max: 1.0,
      },
      excluded_instance_types: ["ExcludedInstanceType"],
      instance_generations: ["current"], # accepts current, previous
      spot_max_price_percentage_over_lowest_price: 1,
      on_demand_max_price_percentage_over_lowest_price: 1,
      bare_metal: "included", # accepts included, required, excluded
      burstable_performance: "included", # accepts included, required, excluded
      require_hibernate_support: false,
      network_interface_count: {
        min: 1,
        max: 1,
      },
      local_storage: "included", # accepts included, required, excluded
      local_storage_types: ["hdd"], # accepts hdd, ssd
      total_local_storage_gb: {
        min: 1.0,
        max: 1.0,
      },
      baseline_ebs_bandwidth_mbps: {
        min: 1,
        max: 1,
      },
      accelerator_types: ["gpu"], # accepts gpu, fpga, inference
      accelerator_count: {
        min: 1,
        max: 1,
      },
      accelerator_manufacturers: ["amazon-web-services"], # accepts amazon-web-services, amd, nvidia, xilinx, habana
      accelerator_names: ["a100"], # accepts a100, inferentia, k520, k80, m60, radeon-pro-v520, t4, vu9p, v100, a10g, h100, t4g
      accelerator_total_memory_mi_b: {
        min: 1,
        max: 1,
      },
      network_bandwidth_gbps: {
        min: 1.0,
        max: 1.0,
      },
      allowed_instance_types: ["AllowedInstanceType"],
      max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
    },
    private_dns_name_options: {
      hostname_type: "ip-name", # accepts ip-name, resource-name
      enable_resource_name_dns_a_record: false,
      enable_resource_name_dns_aaaa_record: false,
    },
    maintenance_options: {
      auto_recovery: "default", # accepts default, disabled
    },
    disable_api_stop: false,
  },
  resolve_alias: false,
})

Response structure


resp.launch_template_version.launch_template_id #=> String
resp.launch_template_version.launch_template_name #=> String
resp.launch_template_version.version_number #=> Integer
resp.launch_template_version.version_description #=> String
resp.launch_template_version.create_time #=> Time
resp.launch_template_version.created_by #=> String
resp.launch_template_version.default_version #=> Boolean
resp.launch_template_version.launch_template_data.kernel_id #=> String
resp.launch_template_version.launch_template_data.ebs_optimized #=> Boolean
resp.launch_template_version.launch_template_data.iam_instance_profile.arn #=> String
resp.launch_template_version.launch_template_data.iam_instance_profile.name #=> String
resp.launch_template_version.launch_template_data.block_device_mappings #=> Array
resp.launch_template_version.launch_template_data.block_device_mappings[0].device_name #=> String
resp.launch_template_version.launch_template_data.block_device_mappings[0].virtual_name #=> String
resp.launch_template_version.launch_template_data.block_device_mappings[0].ebs.encrypted #=> Boolean
resp.launch_template_version.launch_template_data.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.launch_template_version.launch_template_data.block_device_mappings[0].ebs.iops #=> Integer
resp.launch_template_version.launch_template_data.block_device_mappings[0].ebs.kms_key_id #=> String
resp.launch_template_version.launch_template_data.block_device_mappings[0].ebs.snapshot_id #=> String
resp.launch_template_version.launch_template_data.block_device_mappings[0].ebs.volume_size #=> Integer
resp.launch_template_version.launch_template_data.block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.launch_template_version.launch_template_data.block_device_mappings[0].ebs.throughput #=> Integer
resp.launch_template_version.launch_template_data.block_device_mappings[0].no_device #=> String
resp.launch_template_version.launch_template_data.network_interfaces #=> Array
resp.launch_template_version.launch_template_data.network_interfaces[0].associate_carrier_ip_address #=> Boolean
resp.launch_template_version.launch_template_data.network_interfaces[0].associate_public_ip_address #=> Boolean
resp.launch_template_version.launch_template_data.network_interfaces[0].delete_on_termination #=> Boolean
resp.launch_template_version.launch_template_data.network_interfaces[0].description #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].device_index #=> Integer
resp.launch_template_version.launch_template_data.network_interfaces[0].groups #=> Array
resp.launch_template_version.launch_template_data.network_interfaces[0].groups[0] #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].interface_type #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_6_address_count #=> Integer
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_6_addresses #=> Array
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_6_addresses[0].ipv_6_address #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.launch_template_version.launch_template_data.network_interfaces[0].network_interface_id #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].private_ip_address #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].private_ip_addresses #=> Array
resp.launch_template_version.launch_template_data.network_interfaces[0].private_ip_addresses[0].primary #=> Boolean
resp.launch_template_version.launch_template_data.network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].secondary_private_ip_address_count #=> Integer
resp.launch_template_version.launch_template_data.network_interfaces[0].subnet_id #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].network_card_index #=> Integer
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_4_prefixes #=> Array
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_4_prefix_count #=> Integer
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_6_prefixes #=> Array
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.launch_template_version.launch_template_data.network_interfaces[0].ipv_6_prefix_count #=> Integer
resp.launch_template_version.launch_template_data.network_interfaces[0].primary_ipv_6 #=> Boolean
resp.launch_template_version.launch_template_data.network_interfaces[0].ena_srd_specification.ena_srd_enabled #=> Boolean
resp.launch_template_version.launch_template_data.network_interfaces[0].ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.launch_template_version.launch_template_data.network_interfaces[0].connection_tracking_specification.tcp_established_timeout #=> Integer
resp.launch_template_version.launch_template_data.network_interfaces[0].connection_tracking_specification.udp_timeout #=> Integer
resp.launch_template_version.launch_template_data.network_interfaces[0].connection_tracking_specification.udp_stream_timeout #=> Integer
resp.launch_template_version.launch_template_data.image_id #=> String
resp.launch_template_version.launch_template_data.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.launch_template_version.launch_template_data.key_name #=> String
resp.launch_template_version.launch_template_data.monitoring.enabled #=> Boolean
resp.launch_template_version.launch_template_data.placement.availability_zone #=> String
resp.launch_template_version.launch_template_data.placement.affinity #=> String
resp.launch_template_version.launch_template_data.placement.group_name #=> String
resp.launch_template_version.launch_template_data.placement.host_id #=> String
resp.launch_template_version.launch_template_data.placement.tenancy #=> String, one of "default", "dedicated", "host"
resp.launch_template_version.launch_template_data.placement.spread_domain #=> String
resp.launch_template_version.launch_template_data.placement.host_resource_group_arn #=> String
resp.launch_template_version.launch_template_data.placement.partition_number #=> Integer
resp.launch_template_version.launch_template_data.placement.group_id #=> String
resp.launch_template_version.launch_template_data.ram_disk_id #=> String
resp.launch_template_version.launch_template_data.disable_api_termination #=> Boolean
resp.launch_template_version.launch_template_data.instance_initiated_shutdown_behavior #=> String, one of "stop", "terminate"
resp.launch_template_version.launch_template_data.user_data #=> String
resp.launch_template_version.launch_template_data.tag_specifications #=> Array
resp.launch_template_version.launch_template_data.tag_specifications[0].resource_type #=> String, one of "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"
resp.launch_template_version.launch_template_data.tag_specifications[0].tags #=> Array
resp.launch_template_version.launch_template_data.tag_specifications[0].tags[0].key #=> String
resp.launch_template_version.launch_template_data.tag_specifications[0].tags[0].value #=> String
resp.launch_template_version.launch_template_data.elastic_gpu_specifications #=> Array
resp.launch_template_version.launch_template_data.elastic_gpu_specifications[0].type #=> String
resp.launch_template_version.launch_template_data.elastic_inference_accelerators #=> Array
resp.launch_template_version.launch_template_data.elastic_inference_accelerators[0].type #=> String
resp.launch_template_version.launch_template_data.elastic_inference_accelerators[0].count #=> Integer
resp.launch_template_version.launch_template_data.security_group_ids #=> Array
resp.launch_template_version.launch_template_data.security_group_ids[0] #=> String
resp.launch_template_version.launch_template_data.security_groups #=> Array
resp.launch_template_version.launch_template_data.security_groups[0] #=> String
resp.launch_template_version.launch_template_data.instance_market_options.market_type #=> String, one of "spot", "capacity-block"
resp.launch_template_version.launch_template_data.instance_market_options.spot_options.max_price #=> String
resp.launch_template_version.launch_template_data.instance_market_options.spot_options.spot_instance_type #=> String, one of "one-time", "persistent"
resp.launch_template_version.launch_template_data.instance_market_options.spot_options.block_duration_minutes #=> Integer
resp.launch_template_version.launch_template_data.instance_market_options.spot_options.valid_until #=> Time
resp.launch_template_version.launch_template_data.instance_market_options.spot_options.instance_interruption_behavior #=> String, one of "hibernate", "stop", "terminate"
resp.launch_template_version.launch_template_data.credit_specification.cpu_credits #=> String
resp.launch_template_version.launch_template_data.cpu_options.core_count #=> Integer
resp.launch_template_version.launch_template_data.cpu_options.threads_per_core #=> Integer
resp.launch_template_version.launch_template_data.cpu_options.amd_sev_snp #=> String, one of "enabled", "disabled"
resp.launch_template_version.launch_template_data.capacity_reservation_specification.capacity_reservation_preference #=> String, one of "open", "none"
resp.launch_template_version.launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_id #=> String
resp.launch_template_version.launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_resource_group_arn #=> String
resp.launch_template_version.launch_template_data.license_specifications #=> Array
resp.launch_template_version.launch_template_data.license_specifications[0].license_configuration_arn #=> String
resp.launch_template_version.launch_template_data.hibernation_options.configured #=> Boolean
resp.launch_template_version.launch_template_data.metadata_options.state #=> String, one of "pending", "applied"
resp.launch_template_version.launch_template_data.metadata_options.http_tokens #=> String, one of "optional", "required"
resp.launch_template_version.launch_template_data.metadata_options.http_put_response_hop_limit #=> Integer
resp.launch_template_version.launch_template_data.metadata_options.http_endpoint #=> String, one of "disabled", "enabled"
resp.launch_template_version.launch_template_data.metadata_options.http_protocol_ipv_6 #=> String, one of "disabled", "enabled"
resp.launch_template_version.launch_template_data.metadata_options.instance_metadata_tags #=> String, one of "disabled", "enabled"
resp.launch_template_version.launch_template_data.enclave_options.enabled #=> Boolean
resp.launch_template_version.launch_template_data.instance_requirements.v_cpu_count.min #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.v_cpu_count.max #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.memory_mi_b.min #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.memory_mi_b.max #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.cpu_manufacturers #=> Array
resp.launch_template_version.launch_template_data.instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.launch_template_version.launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.launch_template_version.launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.launch_template_version.launch_template_data.instance_requirements.excluded_instance_types #=> Array
resp.launch_template_version.launch_template_data.instance_requirements.excluded_instance_types[0] #=> String
resp.launch_template_version.launch_template_data.instance_requirements.instance_generations #=> Array
resp.launch_template_version.launch_template_data.instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.launch_template_version.launch_template_data.instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.launch_template_version.launch_template_data.instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.launch_template_version.launch_template_data.instance_requirements.require_hibernate_support #=> Boolean
resp.launch_template_version.launch_template_data.instance_requirements.network_interface_count.min #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.network_interface_count.max #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.launch_template_version.launch_template_data.instance_requirements.local_storage_types #=> Array
resp.launch_template_version.launch_template_data.instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.launch_template_version.launch_template_data.instance_requirements.total_local_storage_gb.min #=> Float
resp.launch_template_version.launch_template_data.instance_requirements.total_local_storage_gb.max #=> Float
resp.launch_template_version.launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_types #=> Array
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_count.min #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_count.max #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_manufacturers #=> Array
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_names #=> Array
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.launch_template_version.launch_template_data.instance_requirements.network_bandwidth_gbps.min #=> Float
resp.launch_template_version.launch_template_data.instance_requirements.network_bandwidth_gbps.max #=> Float
resp.launch_template_version.launch_template_data.instance_requirements.allowed_instance_types #=> Array
resp.launch_template_version.launch_template_data.instance_requirements.allowed_instance_types[0] #=> String
resp.launch_template_version.launch_template_data.instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.launch_template_version.launch_template_data.private_dns_name_options.hostname_type #=> String, one of "ip-name", "resource-name"
resp.launch_template_version.launch_template_data.private_dns_name_options.enable_resource_name_dns_a_record #=> Boolean
resp.launch_template_version.launch_template_data.private_dns_name_options.enable_resource_name_dns_aaaa_record #=> Boolean
resp.launch_template_version.launch_template_data.maintenance_options.auto_recovery #=> String, one of "default", "disabled"
resp.launch_template_version.launch_template_data.disable_api_stop #=> Boolean
resp.warning.errors #=> Array
resp.warning.errors[0].code #=> String
resp.warning.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :client_token (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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :launch_template_id (String) —

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name, but not both.

  • :launch_template_name (String) —

    The name of the launch template.

    You must specify either the launch template ID or the launch template name, but not both.

  • :source_version (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.

  • :version_description (String) —

    A description for the version of the launch template.

  • :launch_template_data (required, Types::RequestLaunchTemplateData) —

    The information for the launch template.

  • :resolve_alias (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`

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id

Returns:

See Also:



9408
9409
9410
9411
 
# File 'lib/aws-sdk-ec2/client.rb', line 9408

def create_launch_template_version(params = {}, options = {})
  req = build_request(:create_launch_template_version, params)
  req.send_request(options)
end

#create_local_gateway_route(params = {}) ⇒ Types::CreateLocalGatewayRouteResult

Creates a static route for the specified local gateway route table. You must specify one of the following targets:

  • ‘LocalGatewayVirtualInterfaceGroupId`

  • ‘NetworkInterfaceId`

Examples:

Request syntax with placeholder values


resp = client.create_local_gateway_route({
  destination_cidr_block: "String",
  local_gateway_route_table_id: "LocalGatewayRoutetableId", # required
  local_gateway_virtual_interface_group_id: "LocalGatewayVirtualInterfaceGroupId",
  dry_run: false,
  network_interface_id: "NetworkInterfaceId",
  destination_prefix_list_id: "PrefixListResourceId",
})

Response structure


resp.route.destination_cidr_block #=> String
resp.route.local_gateway_virtual_interface_group_id #=> String
resp.route.type #=> String, one of "static", "propagated"
resp.route.state #=> String, one of "pending", "active", "blackhole", "deleting", "deleted"
resp.route.local_gateway_route_table_id #=> String
resp.route.local_gateway_route_table_arn #=> String
resp.route.owner_id #=> String
resp.route.subnet_id #=> String
resp.route.coip_pool_id #=> String
resp.route.network_interface_id #=> String
resp.route.destination_prefix_list_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_cidr_block (String) —

    The CIDR range used for destination matches. Routing decisions are based on the most specific match.

  • :local_gateway_route_table_id (required, String) —

    The ID of the local gateway route table.

  • :local_gateway_virtual_interface_group_id (String) —

    The ID of the virtual interface group.

  • :dry_run (Boolean) —

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

  • :network_interface_id (String) —

    The ID of the network interface.

  • :destination_prefix_list_id (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.

Returns:

See Also:



9477
9478
9479
9480
 
# File 'lib/aws-sdk-ec2/client.rb', line 9477

def create_local_gateway_route(params = {}, options = {})
  req = build_request(:create_local_gateway_route, params)
  req.send_request(options)
end

#create_local_gateway_route_table(params = {}) ⇒ Types::CreateLocalGatewayRouteTableResult

Creates a local gateway route table.

Examples:

Request syntax with placeholder values


resp = client.create_local_gateway_route_table({
  local_gateway_id: "LocalGatewayId", # required
  mode: "direct-vpc-routing", # accepts direct-vpc-routing, coip
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.local_gateway_route_table.local_gateway_route_table_id #=> String
resp.local_gateway_route_table.local_gateway_route_table_arn #=> String
resp.local_gateway_route_table.local_gateway_id #=> String
resp.local_gateway_route_table.outpost_arn #=> String
resp.local_gateway_route_table.owner_id #=> String
resp.local_gateway_route_table.state #=> String
resp.local_gateway_route_table.tags #=> Array
resp.local_gateway_route_table.tags[0].key #=> String
resp.local_gateway_route_table.tags[0].value #=> String
resp.local_gateway_route_table.mode #=> String, one of "direct-vpc-routing", "coip"
resp.local_gateway_route_table.state_reason.code #=> String
resp.local_gateway_route_table.state_reason.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_id (required, String) —

    The ID of the local gateway.

  • :mode (String) —

    The mode of the local gateway route table.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags assigned to the local gateway route table.

  • :dry_run (Boolean) —

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

Returns:

See Also:



9541
9542
9543
9544
 
# File 'lib/aws-sdk-ec2/client.rb', line 9541

def create_local_gateway_route_table(params = {}, options = {})
  req = build_request(:create_local_gateway_route_table, params)
  req.send_request(options)
end

#create_local_gateway_route_table_virtual_interface_group_association(params = {}) ⇒ Types::CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult

Creates a local gateway route table virtual interface group association.

Examples:

Request syntax with placeholder values


resp = client.create_local_gateway_route_table_virtual_interface_group_association({
  local_gateway_route_table_id: "LocalGatewayRoutetableId", # required
  local_gateway_virtual_interface_group_id: "LocalGatewayVirtualInterfaceGroupId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_route_table_virtual_interface_group_association_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_virtual_interface_group_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_route_table_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_route_table_arn #=> String
resp.local_gateway_route_table_virtual_interface_group_association.owner_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.state #=> String
resp.local_gateway_route_table_virtual_interface_group_association.tags #=> Array
resp.local_gateway_route_table_virtual_interface_group_association.tags[0].key #=> String
resp.local_gateway_route_table_virtual_interface_group_association.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_id (required, String) —

    The ID of the local gateway route table.

  • :local_gateway_virtual_interface_group_id (required, String) —

    The ID of the local gateway route table virtual interface group association.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags assigned to the local gateway route table virtual interface group association.

  • :dry_run (Boolean) —

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

Returns:

See Also:



9606
9607
9608
9609
 
# File 'lib/aws-sdk-ec2/client.rb', line 9606

def create_local_gateway_route_table_virtual_interface_group_association(params = {}, options = {})
  req = build_request(:create_local_gateway_route_table_virtual_interface_group_association, params)
  req.send_request(options)
end

#create_local_gateway_route_table_vpc_association(params = {}) ⇒ Types::CreateLocalGatewayRouteTableVpcAssociationResult

Associates the specified VPC with the specified local gateway route table.

Examples:

Request syntax with placeholder values


resp = client.create_local_gateway_route_table_vpc_association({
  local_gateway_route_table_id: "LocalGatewayRoutetableId", # required
  vpc_id: "VpcId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.local_gateway_route_table_vpc_association.local_gateway_route_table_vpc_association_id #=> String
resp.local_gateway_route_table_vpc_association.local_gateway_route_table_id #=> String
resp.local_gateway_route_table_vpc_association.local_gateway_route_table_arn #=> String
resp.local_gateway_route_table_vpc_association.local_gateway_id #=> String
resp.local_gateway_route_table_vpc_association.vpc_id #=> String
resp.local_gateway_route_table_vpc_association.owner_id #=> String
resp.local_gateway_route_table_vpc_association.state #=> String
resp.local_gateway_route_table_vpc_association.tags #=> Array
resp.local_gateway_route_table_vpc_association.tags[0].key #=> String
resp.local_gateway_route_table_vpc_association.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_id (required, String) —

    The ID of the local gateway route table.

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the local gateway route table VPC association.

  • :dry_run (Boolean) —

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

Returns:

See Also:



9669
9670
9671
9672
 
# File 'lib/aws-sdk-ec2/client.rb', line 9669

def create_local_gateway_route_table_vpc_association(params = {}, options = {})
  req = build_request(:create_local_gateway_route_table_vpc_association, params)
  req.send_request(options)
end

#create_managed_prefix_list(params = {}) ⇒ Types::CreateManagedPrefixListResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_managed_prefix_list({
  dry_run: false,
  prefix_list_name: "String", # required
  entries: [
    {
      cidr: "String", # required
      description: "String",
    },
  ],
  max_entries: 1, # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  address_family: "String", # required
  client_token: "String",
})

Response structure


resp.prefix_list.prefix_list_id #=> String
resp.prefix_list.address_family #=> String
resp.prefix_list.state #=> String, one of "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"
resp.prefix_list.state_message #=> String
resp.prefix_list.prefix_list_arn #=> String
resp.prefix_list.prefix_list_name #=> String
resp.prefix_list.max_entries #=> Integer
resp.prefix_list.version #=> Integer
resp.prefix_list.tags #=> Array
resp.prefix_list.tags[0].key #=> String
resp.prefix_list.tags[0].value #=> String
resp.prefix_list.owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    A name for the prefix list.

    Constraints: Up to 255 characters in length. The name cannot start with ‘com.amazonaws`.

  • :entries (Array<Types::AddPrefixListEntry>) —

    One or more entries for the prefix list.

  • :max_entries (required, Integer) —

    The maximum number of entries for the prefix list.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the prefix list during creation.

  • :address_family (required, String) —

    The IP address type.

    Valid Values: ‘IPv4` | `IPv6`

  • :client_token (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.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



9768
9769
9770
9771
 
# File 'lib/aws-sdk-ec2/client.rb', line 9768

def create_managed_prefix_list(params = {}, options = {})
  req = build_request(:create_managed_prefix_list, params)
  req.send_request(options)
end

#create_nat_gateway(params = {}) ⇒ Types::CreateNatGatewayResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html [2]: docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip

Examples:

Example: 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.

resp = client.create_nat_gateway({
  allocation_id: "eipalloc-37fc1a52", 
  subnet_id: "subnet-1a2b3c4d", 
})

resp.to_h outputs the following:
{
  nat_gateway: {
    create_time: Time.parse("2015-12-17T12:45:26.732Z"), 
    nat_gateway_addresses: [
      {
        allocation_id: "eipalloc-37fc1a52", 
      }, 
    ], 
    nat_gateway_id: "nat-08d48af2a8e83edfd", 
    state: "pending", 
    subnet_id: "subnet-1a2b3c4d", 
    vpc_id: "vpc-1122aabb", 
  }, 
}

Request syntax with placeholder values


resp = client.create_nat_gateway({
  allocation_id: "AllocationId",
  client_token: "String",
  dry_run: false,
  subnet_id: "SubnetId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  connectivity_type: "private", # accepts private, public
  private_ip_address: "String",
  secondary_allocation_ids: ["AllocationId"],
  secondary_private_ip_addresses: ["String"],
  secondary_private_ip_address_count: 1,
})

Response structure


resp.client_token #=> String
resp.nat_gateway.create_time #=> Time
resp.nat_gateway.delete_time #=> Time
resp.nat_gateway.failure_code #=> String
resp.nat_gateway.failure_message #=> String
resp.nat_gateway.nat_gateway_addresses #=> Array
resp.nat_gateway.nat_gateway_addresses[0].allocation_id #=> String
resp.nat_gateway.nat_gateway_addresses[0].network_interface_id #=> String
resp.nat_gateway.nat_gateway_addresses[0].private_ip #=> String
resp.nat_gateway.nat_gateway_addresses[0].public_ip #=> String
resp.nat_gateway.nat_gateway_addresses[0].association_id #=> String
resp.nat_gateway.nat_gateway_addresses[0].is_primary #=> Boolean
resp.nat_gateway.nat_gateway_addresses[0].failure_message #=> String
resp.nat_gateway.nat_gateway_addresses[0].status #=> String, one of "assigning", "unassigning", "associating", "disassociating", "succeeded", "failed"
resp.nat_gateway.nat_gateway_id #=> String
resp.nat_gateway.provisioned_bandwidth.provision_time #=> Time
resp.nat_gateway.provisioned_bandwidth.provisioned #=> String
resp.nat_gateway.provisioned_bandwidth.request_time #=> Time
resp.nat_gateway.provisioned_bandwidth.requested #=> String
resp.nat_gateway.provisioned_bandwidth.status #=> String
resp.nat_gateway.state #=> String, one of "pending", "failed", "available", "deleting", "deleted"
resp.nat_gateway.subnet_id #=> String
resp.nat_gateway.vpc_id #=> String
resp.nat_gateway.tags #=> Array
resp.nat_gateway.tags[0].key #=> String
resp.nat_gateway.tags[0].value #=> String
resp.nat_gateway.connectivity_type #=> String, one of "private", "public"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_id (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.

  • :client_token (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.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :subnet_id (required, String) —

    The ID of the subnet in which to create the NAT gateway.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the NAT gateway.

  • :connectivity_type (String) —

    Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

  • :private_ip_address (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.

  • :secondary_allocation_ids (Array<String>) —

    Secondary EIP allocation IDs. For more information, see [Create a NAT gateway] in the *Amazon VPC User Guide*.

    [1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating

  • :secondary_private_ip_addresses (Array<String>) —

    Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway] in the *Amazon VPC User Guide*.

    [1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating

  • :secondary_private_ip_address_count (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*.

    [1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating

Returns:

See Also:



9966
9967
9968
9969
 
# File 'lib/aws-sdk-ec2/client.rb', line 9966

def create_nat_gateway(params = {}, options = {})
  req = build_request(:create_nat_gateway, params)
  req.send_request(options)
end

#create_network_acl(params = {}) ⇒ Types::CreateNetworkAclResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html

Examples:

Example: To create a network ACL


# This example creates a network ACL for the specified VPC.

resp = client.create_network_acl({
  vpc_id: "vpc-a01106c2", 
})

resp.to_h outputs the following:
{
  network_acl: {
    associations: [
    ], 
    entries: [
      {
        cidr_block: "0.0.0.0/0", 
        egress: true, 
        protocol: "-1", 
        rule_action: "deny", 
        rule_number: 32767, 
      }, 
      {
        cidr_block: "0.0.0.0/0", 
        egress: false, 
        protocol: "-1", 
        rule_action: "deny", 
        rule_number: 32767, 
      }, 
    ], 
    is_default: false, 
    network_acl_id: "acl-5fb85d36", 
    tags: [
    ], 
    vpc_id: "vpc-a01106c2", 
  }, 
}

Request syntax with placeholder values


resp = client.create_network_acl({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
  dry_run: false,
  vpc_id: "VpcId", # required
})

Response structure


resp.network_acl.associations #=> Array
resp.network_acl.associations[0].network_acl_association_id #=> String
resp.network_acl.associations[0].network_acl_id #=> String
resp.network_acl.associations[0].subnet_id #=> String
resp.network_acl.entries #=> Array
resp.network_acl.entries[0].cidr_block #=> String
resp.network_acl.entries[0].egress #=> Boolean
resp.network_acl.entries[0].icmp_type_code.code #=> Integer
resp.network_acl.entries[0].icmp_type_code.type #=> Integer
resp.network_acl.entries[0].ipv_6_cidr_block #=> String
resp.network_acl.entries[0].port_range.from #=> Integer
resp.network_acl.entries[0].port_range.to #=> Integer
resp.network_acl.entries[0].protocol #=> String
resp.network_acl.entries[0].rule_action #=> String, one of "allow", "deny"
resp.network_acl.entries[0].rule_number #=> Integer
resp.network_acl.is_default #=> Boolean
resp.network_acl.network_acl_id #=> String
resp.network_acl.tags #=> Array
resp.network_acl.tags[0].key #=> String
resp.network_acl.tags[0].value #=> String
resp.network_acl.vpc_id #=> String
resp.network_acl.owner_id #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the network ACL.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :vpc_id (required, String) —

    The ID of the VPC.

Returns:

See Also:



10098
10099
10100
10101
 
# File 'lib/aws-sdk-ec2/client.rb', line 10098

def create_network_acl(params = {}, options = {})
  req = build_request(:create_network_acl, params)
  req.send_request(options)
end

#create_network_acl_entry(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html

Examples:

Example: 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.

resp = client.create_network_acl_entry({
  cidr_block: "0.0.0.0/0", 
  egress: false, 
  network_acl_id: "acl-5fb85d36", 
  port_range: {
    from: 53, 
    to: 53, 
  }, 
  protocol: "17", 
  rule_action: "allow", 
  rule_number: 100, 
})

Request syntax with placeholder values


resp = client.create_network_acl_entry({
  dry_run: false,
  network_acl_id: "NetworkAclId", # required
  rule_number: 1, # required
  protocol: "String", # required
  rule_action: "allow", # required, accepts allow, deny
  egress: false, # required
  cidr_block: "String",
  ipv_6_cidr_block: "String",
  icmp_type_code: {
    code: 1,
    type: 1,
  },
  port_range: {
    from: 1,
    to: 1,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_acl_id (required, String) —

    The ID of the network ACL.

  • :rule_number (required, 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.

  • :protocol (required, 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.

  • :rule_action (required, String) —

    Indicates whether to allow or deny the traffic that matches the rule.

  • :egress (required, Boolean) —

    Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

  • :cidr_block (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`.

  • :ipv_6_cidr_block (String) —

    The IPv6 network range to allow or deny, in CIDR notation (for example ‘2001:db8:1234:1a00::/64`).

  • :icmp_type_code (Types::IcmpTypeCode) —

    ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

  • :port_range (Types::PortRange) —

    TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10224
10225
10226
10227
 
# File 'lib/aws-sdk-ec2/client.rb', line 10224

def create_network_acl_entry(params = {}, options = {})
  req = build_request(:create_network_acl_entry, params)
  req.send_request(options)
end

#create_network_insights_access_scope(params = {}) ⇒ Types::CreateNetworkInsightsAccessScopeResult

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

[1]: docs.aws.amazon.com/vpc/latest/network-access-analyzer/

Examples:

Request syntax with placeholder values


resp = client.create_network_insights_access_scope({
  match_paths: [
    {
      source: {
        packet_header_statement: {
          source_addresses: ["String"],
          destination_addresses: ["String"],
          source_ports: ["String"],
          destination_ports: ["String"],
          source_prefix_lists: ["String"],
          destination_prefix_lists: ["String"],
          protocols: ["tcp"], # accepts tcp, udp
        },
        resource_statement: {
          resources: ["String"],
          resource_types: ["String"],
        },
      },
      destination: {
        packet_header_statement: {
          source_addresses: ["String"],
          destination_addresses: ["String"],
          source_ports: ["String"],
          destination_ports: ["String"],
          source_prefix_lists: ["String"],
          destination_prefix_lists: ["String"],
          protocols: ["tcp"], # accepts tcp, udp
        },
        resource_statement: {
          resources: ["String"],
          resource_types: ["String"],
        },
      },
      through_resources: [
        {
          resource_statement: {
            resources: ["String"],
            resource_types: ["String"],
          },
        },
      ],
    },
  ],
  exclude_paths: [
    {
      source: {
        packet_header_statement: {
          source_addresses: ["String"],
          destination_addresses: ["String"],
          source_ports: ["String"],
          destination_ports: ["String"],
          source_prefix_lists: ["String"],
          destination_prefix_lists: ["String"],
          protocols: ["tcp"], # accepts tcp, udp
        },
        resource_statement: {
          resources: ["String"],
          resource_types: ["String"],
        },
      },
      destination: {
        packet_header_statement: {
          source_addresses: ["String"],
          destination_addresses: ["String"],
          source_ports: ["String"],
          destination_ports: ["String"],
          source_prefix_lists: ["String"],
          destination_prefix_lists: ["String"],
          protocols: ["tcp"], # accepts tcp, udp
        },
        resource_statement: {
          resources: ["String"],
          resource_types: ["String"],
        },
      },
      through_resources: [
        {
          resource_statement: {
            resources: ["String"],
            resource_types: ["String"],
          },
        },
      ],
    },
  ],
  client_token: "String", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.network_insights_access_scope.network_insights_access_scope_id #=> String
resp.network_insights_access_scope.network_insights_access_scope_arn #=> String
resp.network_insights_access_scope.created_date #=> Time
resp.network_insights_access_scope.updated_date #=> Time
resp.network_insights_access_scope.tags #=> Array
resp.network_insights_access_scope.tags[0].key #=> String
resp.network_insights_access_scope.tags[0].value #=> String
resp.network_insights_access_scope_content.network_insights_access_scope_id #=> String
resp.network_insights_access_scope_content.match_paths #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_addresses #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_addresses[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_addresses #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_addresses[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_ports #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_ports[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_ports #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_ports[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_prefix_lists #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_prefix_lists #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.protocols #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.protocols[0] #=> String, one of "tcp", "udp"
resp.network_insights_access_scope_content.match_paths[0].source.resource_statement.resources #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_addresses #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_addresses[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_addresses #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_addresses[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_ports #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_ports[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_ports #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_ports[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_prefix_lists #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_prefix_lists #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.protocols #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.protocols[0] #=> String, one of "tcp", "udp"
resp.network_insights_access_scope_content.match_paths[0].destination.resource_statement.resources #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].through_resources #=> Array
resp.network_insights_access_scope_content.match_paths[0].through_resources[0].resource_statement.resources #=> Array
resp.network_insights_access_scope_content.match_paths[0].through_resources[0].resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].through_resources[0].resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.match_paths[0].through_resources[0].resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.exclude_paths #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_addresses #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_addresses[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_addresses #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_addresses[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_ports #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_ports[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_ports #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_ports[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_prefix_lists #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_prefix_lists #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.protocols #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.protocols[0] #=> String, one of "tcp", "udp"
resp.network_insights_access_scope_content.exclude_paths[0].source.resource_statement.resources #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_addresses #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_addresses[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_addresses #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_addresses[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_ports #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_ports[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_ports #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_ports[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_prefix_lists #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_prefix_lists #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.protocols #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.protocols[0] #=> String, one of "tcp", "udp"
resp.network_insights_access_scope_content.exclude_paths[0].destination.resource_statement.resources #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].through_resources #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].through_resources[0].resource_statement.resources #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].through_resources[0].resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].through_resources[0].resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].through_resources[0].resource_statement.resource_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :match_paths (Array<Types::AccessScopePathRequest>) —

    The paths to match.

  • :exclude_paths (Array<Types::AccessScopePathRequest>) —

    The paths to exclude.

  • :client_token (required, String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply.

  • :dry_run (Boolean) —

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

Returns:

See Also:



10474
10475
10476
10477
 
# File 'lib/aws-sdk-ec2/client.rb', line 10474

def create_network_insights_access_scope(params = {}, options = {})
  req = build_request(:create_network_insights_access_scope, params)
  req.send_request(options)
end

#create_network_insights_path(params = {}) ⇒ Types::CreateNetworkInsightsPathResult

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

[1]: docs.aws.amazon.com/vpc/latest/reachability/

Examples:

Request syntax with placeholder values


resp = client.create_network_insights_path({
  source_ip: "IpAddress",
  destination_ip: "IpAddress",
  source: "NetworkInsightsResourceId", # required
  destination: "NetworkInsightsResourceId",
  protocol: "tcp", # required, accepts tcp, udp
  destination_port: 1,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  client_token: "String", # required
  filter_at_source: {
    source_address: "IpAddress",
    source_port_range: {
      from_port: 1,
      to_port: 1,
    },
    destination_address: "IpAddress",
    destination_port_range: {
      from_port: 1,
      to_port: 1,
    },
  },
  filter_at_destination: {
    source_address: "IpAddress",
    source_port_range: {
      from_port: 1,
      to_port: 1,
    },
    destination_address: "IpAddress",
    destination_port_range: {
      from_port: 1,
      to_port: 1,
    },
  },
})

Response structure


resp.network_insights_path.network_insights_path_id #=> String
resp.network_insights_path.network_insights_path_arn #=> String
resp.network_insights_path.created_date #=> Time
resp.network_insights_path.source #=> String
resp.network_insights_path.destination #=> String
resp.network_insights_path.source_arn #=> String
resp.network_insights_path.destination_arn #=> String
resp.network_insights_path.source_ip #=> String
resp.network_insights_path.destination_ip #=> String
resp.network_insights_path.protocol #=> String, one of "tcp", "udp"
resp.network_insights_path.destination_port #=> Integer
resp.network_insights_path.tags #=> Array
resp.network_insights_path.tags[0].key #=> String
resp.network_insights_path.tags[0].value #=> String
resp.network_insights_path.filter_at_source.source_address #=> String
resp.network_insights_path.filter_at_source.source_port_range.from_port #=> Integer
resp.network_insights_path.filter_at_source.source_port_range.to_port #=> Integer
resp.network_insights_path.filter_at_source.destination_address #=> String
resp.network_insights_path.filter_at_source.destination_port_range.from_port #=> Integer
resp.network_insights_path.filter_at_source.destination_port_range.to_port #=> Integer
resp.network_insights_path.filter_at_destination.source_address #=> String
resp.network_insights_path.filter_at_destination.source_port_range.from_port #=> Integer
resp.network_insights_path.filter_at_destination.source_port_range.to_port #=> Integer
resp.network_insights_path.filter_at_destination.destination_address #=> String
resp.network_insights_path.filter_at_destination.destination_port_range.from_port #=> Integer
resp.network_insights_path.filter_at_destination.destination_port_range.to_port #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_ip (String) —

    The IP address of the source.

  • :destination_ip (String) —

    The IP address of the destination.

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

    The protocol.

  • :destination_port (Integer) —

    The destination port.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to add to the path.

  • :dry_run (Boolean) —

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

  • :client_token (required, String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :filter_at_source (Types::PathRequestFilter) —

    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.

  • :filter_at_destination (Types::PathRequestFilter) —

    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.

Returns:

See Also:



10625
10626
10627
10628
 
# File 'lib/aws-sdk-ec2/client.rb', line 10625

def create_network_insights_path(params = {}, options = {})
  req = build_request(:create_network_insights_path, params)
  req.send_request(options)
end

#create_network_interface(params = {}) ⇒ Types::CreateNetworkInterfaceResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html

Examples:

Example: To create a network interface


# This example creates a network interface for the specified subnet.

resp = client.create_network_interface({
  description: "my network interface", 
  groups: [
    "sg-903004f8", 
  ], 
  private_ip_address: "10.0.2.17", 
  subnet_id: "subnet-9d4a7b6c", 
})

resp.to_h outputs the following:
{
  network_interface: {
    availability_zone: "us-east-1d", 
    description: "my network interface", 
    groups: [
      {
        group_id: "sg-903004f8", 
        group_name: "default", 
      }, 
    ], 
    mac_address: "02:1a:80:41:52:9c", 
    network_interface_id: "eni-e5aa89a3", 
    owner_id: "123456789012", 
    private_ip_address: "10.0.2.17", 
    private_ip_addresses: [
      {
        primary: true, 
        private_ip_address: "10.0.2.17", 
      }, 
    ], 
    requester_managed: false, 
    source_dest_check: true, 
    status: "pending", 
    subnet_id: "subnet-9d4a7b6c", 
    tag_set: [
    ], 
    vpc_id: "vpc-a01106c2", 
  }, 
}

Request syntax with placeholder values


resp = client.create_network_interface({
  ipv_4_prefixes: [
    {
      ipv_4_prefix: "String",
    },
  ],
  ipv_4_prefix_count: 1,
  ipv_6_prefixes: [
    {
      ipv_6_prefix: "String",
    },
  ],
  ipv_6_prefix_count: 1,
  interface_type: "efa", # accepts efa, branch, trunk
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
  enable_primary_ipv_6: false,
  connection_tracking_specification: {
    tcp_established_timeout: 1,
    udp_stream_timeout: 1,
    udp_timeout: 1,
  },
  subnet_id: "SubnetId", # required
  description: "String",
  private_ip_address: "String",
  groups: ["SecurityGroupId"],
  private_ip_addresses: [
    {
      primary: false,
      private_ip_address: "String",
    },
  ],
  secondary_private_ip_address_count: 1,
  ipv_6_addresses: [
    {
      ipv_6_address: "String",
      is_primary_ipv_6: false,
    },
  ],
  ipv_6_address_count: 1,
  dry_run: false,
})

Response structure


resp.network_interface.association.allocation_id #=> String
resp.network_interface.association.association_id #=> String
resp.network_interface.association.ip_owner_id #=> String
resp.network_interface.association.public_dns_name #=> String
resp.network_interface.association.public_ip #=> String
resp.network_interface.association.customer_owned_ip #=> String
resp.network_interface.association.carrier_ip #=> String
resp.network_interface.attachment.attach_time #=> Time
resp.network_interface.attachment.attachment_id #=> String
resp.network_interface.attachment.delete_on_termination #=> Boolean
resp.network_interface.attachment.device_index #=> Integer
resp.network_interface.attachment.network_card_index #=> Integer
resp.network_interface.attachment.instance_id #=> String
resp.network_interface.attachment.instance_owner_id #=> String
resp.network_interface.attachment.status #=> String, one of "attaching", "attached", "detaching", "detached"
resp.network_interface.attachment.ena_srd_specification.ena_srd_enabled #=> Boolean
resp.network_interface.attachment.ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.network_interface.availability_zone #=> String
resp.network_interface.connection_tracking_configuration.tcp_established_timeout #=> Integer
resp.network_interface.connection_tracking_configuration.udp_stream_timeout #=> Integer
resp.network_interface.connection_tracking_configuration.udp_timeout #=> Integer
resp.network_interface.description #=> String
resp.network_interface.groups #=> Array
resp.network_interface.groups[0].group_id #=> String
resp.network_interface.groups[0].group_name #=> String
resp.network_interface.interface_type #=> String, one of "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"
resp.network_interface.ipv_6_addresses #=> Array
resp.network_interface.ipv_6_addresses[0].ipv_6_address #=> String
resp.network_interface.ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.network_interface.mac_address #=> String
resp.network_interface.network_interface_id #=> String
resp.network_interface.outpost_arn #=> String
resp.network_interface.owner_id #=> String
resp.network_interface.private_dns_name #=> String
resp.network_interface.private_ip_address #=> String
resp.network_interface.private_ip_addresses #=> Array
resp.network_interface.private_ip_addresses[0].association.allocation_id #=> String
resp.network_interface.private_ip_addresses[0].association.association_id #=> String
resp.network_interface.private_ip_addresses[0].association.ip_owner_id #=> String
resp.network_interface.private_ip_addresses[0].association.public_dns_name #=> String
resp.network_interface.private_ip_addresses[0].association.public_ip #=> String
resp.network_interface.private_ip_addresses[0].association.customer_owned_ip #=> String
resp.network_interface.private_ip_addresses[0].association.carrier_ip #=> String
resp.network_interface.private_ip_addresses[0].primary #=> Boolean
resp.network_interface.private_ip_addresses[0].private_dns_name #=> String
resp.network_interface.private_ip_addresses[0].private_ip_address #=> String
resp.network_interface.ipv_4_prefixes #=> Array
resp.network_interface.ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.network_interface.ipv_6_prefixes #=> Array
resp.network_interface.ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.network_interface.requester_id #=> String
resp.network_interface.requester_managed #=> Boolean
resp.network_interface.source_dest_check #=> Boolean
resp.network_interface.status #=> String, one of "available", "associated", "attaching", "in-use", "detaching"
resp.network_interface.subnet_id #=> String
resp.network_interface.tag_set #=> Array
resp.network_interface.tag_set[0].key #=> String
resp.network_interface.tag_set[0].value #=> String
resp.network_interface.vpc_id #=> String
resp.network_interface.deny_all_igw_traffic #=> Boolean
resp.network_interface.ipv_6_native #=> Boolean
resp.network_interface.ipv_6_address #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ipv_4_prefixes (Array<Types::Ipv4PrefixSpecificationRequest>) —

    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.

  • :ipv_4_prefix_count (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.

  • :ipv_6_prefixes (Array<Types::Ipv6PrefixSpecificationRequest>) —

    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.

  • :ipv_6_prefix_count (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.

  • :interface_type (String) —

    The type of network interface. The default is ‘interface`.

    The only supported values are ‘interface`, `efa`, and `trunk`.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the new network interface.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :enable_primary_ipv_6 (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.

  • :connection_tracking_specification (Types::ConnectionTrackingSpecificationRequest) —

    A connection tracking specification for the network interface.

  • :subnet_id (required, String) —

    The ID of the subnet to associate with the network interface.

  • :description (String) —

    A description for the network interface.

  • :private_ip_address (String) —

    The primary private IPv4 address of the network interface. If you don’t specify an IPv4 address, Amazon EC2 selects one for you from the subnet’s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in ‘privateIpAddresses` as primary (only one IP address can be designated as primary).

  • :groups (Array<String>) —

    The IDs of one or more security groups.

  • :private_ip_addresses (Array<Types::PrivateIpAddressSpecification>) —

    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.

  • :secondary_private_ip_address_count (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.

  • :ipv_6_addresses (Array<Types::InstanceIpv6Address>) —

    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.

  • :ipv_6_address_count (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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



10946
10947
10948
10949
 
# File 'lib/aws-sdk-ec2/client.rb', line 10946

def create_network_interface(params = {}, options = {})
  req = build_request(:create_network_interface, params)
  req.send_request(options)
end

#create_network_interface_permission(params = {}) ⇒ Types::CreateNetworkInterfacePermissionResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_network_interface_permission({
  network_interface_id: "NetworkInterfaceId", # required
  aws_account_id: "String",
  aws_service: "String",
  permission: "INSTANCE-ATTACH", # required, accepts INSTANCE-ATTACH, EIP-ASSOCIATE
  dry_run: false,
})

Response structure


resp.interface_permission.network_interface_permission_id #=> String
resp.interface_permission.network_interface_id #=> String
resp.interface_permission. #=> String
resp.interface_permission.aws_service #=> String
resp.interface_permission.permission #=> String, one of "INSTANCE-ATTACH", "EIP-ASSOCIATE"
resp.interface_permission.permission_state.state #=> String, one of "pending", "granted", "revoking", "revoked"
resp.interface_permission.permission_state.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_interface_id (required, String) —

    The ID of the network interface.

  • :aws_account_id (String) —

    The Amazon Web Services account ID.

  • :aws_service (String) —

    The Amazon Web Services service. Currently not supported.

  • :permission (required, String) —

    The type of permission to grant.

  • :dry_run (Boolean) —

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

Returns:

See Also:



11003
11004
11005
11006
 
# File 'lib/aws-sdk-ec2/client.rb', line 11003

def create_network_interface_permission(params = {}, options = {})
  req = build_request(:create_network_interface_permission, params)
  req.send_request(options)
end

#create_placement_group(params = {}) ⇒ Types::CreatePlacementGroupResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html

Examples:

Example: To create a placement group


# This example creates a placement group with the specified name.

resp = client.create_placement_group({
  group_name: "my-cluster", 
  strategy: "cluster", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.create_placement_group({
  partition_count: 1,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  spread_level: "host", # accepts host, rack
  dry_run: false,
  group_name: "String",
  strategy: "cluster", # accepts cluster, spread, partition
})

Response structure


resp.placement_group.group_name #=> String
resp.placement_group.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.placement_group.strategy #=> String, one of "cluster", "spread", "partition"
resp.placement_group.partition_count #=> Integer
resp.placement_group.group_id #=> String
resp.placement_group.tags #=> Array
resp.placement_group.tags[0].key #=> String
resp.placement_group.tags[0].value #=> String
resp.placement_group.group_arn #=> String
resp.placement_group.spread_level #=> String, one of "host", "rack"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :partition_count (Integer) —

    The number of partitions. Valid only when Strategy is set to ‘partition`.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the new placement group.

  • :spread_level (String) —

    Determines how placement groups spread instances.

    • Host – You can use ‘host` only with Outpost placement groups.

    • Rack – No usage restrictions.

  • :dry_run (Boolean) —

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

  • :group_name (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.

Returns:

See Also:



11111
11112
11113
11114
 
# File 'lib/aws-sdk-ec2/client.rb', line 11111

def create_placement_group(params = {}, options = {})
  req = build_request(:create_placement_group, params)
  req.send_request(options)
end

#create_public_ipv_4_pool(params = {}) ⇒ Types::CreatePublicIpv4PoolResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribePublicIpv4Pools.html

Examples:

Request syntax with placeholder values


resp = client.create_public_ipv_4_pool({
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  network_border_group: "String",
})

Response structure


resp.pool_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :tag_specifications (Array<Types::TagSpecification>) —

    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.

  • :network_border_group (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail

Returns:

See Also:



11180
11181
11182
11183
 
# File 'lib/aws-sdk-ec2/client.rb', line 11180

def create_public_ipv_4_pool(params = {}, options = {})
  req = build_request(:create_public_ipv_4_pool, params)
  req.send_request(options)
end

#create_replace_root_volume_task(params = {}) ⇒ Types::CreateReplaceRootVolumeTaskResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html

Examples:

Request syntax with placeholder values


resp = client.create_replace_root_volume_task({
  instance_id: "InstanceId", # required
  snapshot_id: "SnapshotId",
  client_token: "String",
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  image_id: "ImageId",
  delete_replaced_root_volume: false,
})

Response structure


resp.replace_root_volume_task.replace_root_volume_task_id #=> String
resp.replace_root_volume_task.instance_id #=> String
resp.replace_root_volume_task.task_state #=> String, one of "pending", "in-progress", "failing", "succeeded", "failed", "failed-detached"
resp.replace_root_volume_task.start_time #=> String
resp.replace_root_volume_task.complete_time #=> String
resp.replace_root_volume_task.tags #=> Array
resp.replace_root_volume_task.tags[0].key #=> String
resp.replace_root_volume_task.tags[0].value #=> String
resp.replace_root_volume_task.image_id #=> String
resp.replace_root_volume_task.snapshot_id #=> String
resp.replace_root_volume_task.delete_replaced_root_volume #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance for which to replace the root volume.

  • :snapshot_id (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.

  • :client_token (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].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the root volume replacement task.

  • :image_id (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.

  • :delete_replaced_root_volume (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.

Returns:

See Also:



11292
11293
11294
11295
 
# File 'lib/aws-sdk-ec2/client.rb', line 11292

def create_replace_root_volume_task(params = {}, options = {})
  req = build_request(:create_replace_root_volume_task, params)
  req.send_request(options)
end

#create_reserved_instances_listing(params = {}) ⇒ Types::CreateReservedInstancesListingResult

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 markdown=“1”> Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.

</note>

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html

Examples:

Request syntax with placeholder values


resp = client.create_reserved_instances_listing({
  reserved_instances_id: "ReservationId", # required
  instance_count: 1, # required
  price_schedules: [ # required
    {
      term: 1,
      price: 1.0,
      currency_code: "USD", # accepts USD
    },
  ],
  client_token: "String", # required
})

Response structure


resp.reserved_instances_listings #=> Array
resp.reserved_instances_listings[0].client_token #=> String
resp.reserved_instances_listings[0].create_date #=> Time
resp.reserved_instances_listings[0].instance_counts #=> Array
resp.reserved_instances_listings[0].instance_counts[0].instance_count #=> Integer
resp.reserved_instances_listings[0].instance_counts[0].state #=> String, one of "available", "sold", "cancelled", "pending"
resp.reserved_instances_listings[0].price_schedules #=> Array
resp.reserved_instances_listings[0].price_schedules[0].active #=> Boolean
resp.reserved_instances_listings[0].price_schedules[0].currency_code #=> String, one of "USD"
resp.reserved_instances_listings[0].price_schedules[0].price #=> Float
resp.reserved_instances_listings[0].price_schedules[0].term #=> Integer
resp.reserved_instances_listings[0].reserved_instances_id #=> String
resp.reserved_instances_listings[0].reserved_instances_listing_id #=> String
resp.reserved_instances_listings[0].status #=> String, one of "active", "pending", "cancelled", "closed"
resp.reserved_instances_listings[0].status_message #=> String
resp.reserved_instances_listings[0].tags #=> Array
resp.reserved_instances_listings[0].tags[0].key #=> String
resp.reserved_instances_listings[0].tags[0].value #=> String
resp.reserved_instances_listings[0].update_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_instances_id (required, String) —

    The ID of the active Standard Reserved Instance.

  • :instance_count (required, 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.

  • :price_schedules (required, Array<Types::PriceScheduleSpecification>) —

    A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

  • :client_token (required, String) —

    Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see [Ensuring Idempotency].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

See Also:



11397
11398
11399
11400
 
# File 'lib/aws-sdk-ec2/client.rb', line 11397

def create_reserved_instances_listing(params = {}, options = {})
  req = build_request(:create_reserved_instances_listing, params)
  req.send_request(options)
end

#create_restore_image_task(params = {}) ⇒ Types::CreateRestoreImageTaskResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html

Examples:

Request syntax with placeholder values


resp = client.create_restore_image_task({
  bucket: "String", # required
  object_key: "String", # required
  name: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.image_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the Amazon S3 bucket that contains the stored AMI object.

  • :object_key (required, 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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.

    • To tag the AMI, the value for ‘ResourceType` must be `image`.

    • To tag the snapshots, the value for ‘ResourceType` must be `snapshot`. The same tag is applied to all of the snapshots that are created.

  • :dry_run (Boolean) —

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

Returns:

See Also:



11477
11478
11479
11480
 
# File 'lib/aws-sdk-ec2/client.rb', line 11477

def create_restore_image_task(params = {}, options = {})
  req = build_request(:create_restore_image_task, params)
  req.send_request(options)
end

#create_route(params = {}) ⇒ Types::CreateRouteResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html

Examples:

Example: 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.

resp = client.create_route({
  destination_cidr_block: "0.0.0.0/0", 
  gateway_id: "igw-c0a643a9", 
  route_table_id: "rtb-22574640", 
})

Request syntax with placeholder values


resp = client.create_route({
  destination_prefix_list_id: "PrefixListResourceId",
  vpc_endpoint_id: "VpcEndpointId",
  transit_gateway_id: "TransitGatewayId",
  local_gateway_id: "LocalGatewayId",
  carrier_gateway_id: "CarrierGatewayId",
  core_network_arn: "CoreNetworkArn",
  dry_run: false,
  route_table_id: "RouteTableId", # required
  destination_cidr_block: "String",
  gateway_id: "RouteGatewayId",
  destination_ipv_6_cidr_block: "String",
  egress_only_internet_gateway_id: "EgressOnlyInternetGatewayId",
  instance_id: "InstanceId",
  network_interface_id: "NetworkInterfaceId",
  vpc_peering_connection_id: "VpcPeeringConnectionId",
  nat_gateway_id: "NatGatewayId",
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_prefix_list_id (String) —

    The ID of a prefix list used for the destination match.

  • :vpc_endpoint_id (String) —

    The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

  • :transit_gateway_id (String) —

    The ID of a transit gateway.

  • :local_gateway_id (String) —

    The ID of the local gateway.

  • :carrier_gateway_id (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.

  • :core_network_arn (String) —

    The Amazon Resource Name (ARN) of the core network.

  • :dry_run (Boolean) —

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

  • :route_table_id (required, String) —

    The ID of the route table for the route.

  • :destination_cidr_block (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`.

  • :gateway_id (String) —

    The ID of an internet gateway or virtual private gateway attached to your VPC.

  • :destination_ipv_6_cidr_block (String) —

    The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

  • :egress_only_internet_gateway_id (String) —

    [IPv6 traffic only] The ID of an egress-only internet gateway.

  • :instance_id (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.

  • :network_interface_id (String) —

    The ID of a network interface.

  • :vpc_peering_connection_id (String) —

    The ID of a VPC peering connection.

  • :nat_gateway_id (String) —

    [IPv4 traffic only] The ID of a NAT gateway.

Returns:

See Also:



11616
11617
11618
11619
 
# File 'lib/aws-sdk-ec2/client.rb', line 11616

def create_route(params = {}, options = {})
  req = build_request(:create_route, params)
  req.send_request(options)
end

#create_route_table(params = {}) ⇒ Types::CreateRouteTableResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html

Examples:

Example: To create a route table


# This example creates a route table for the specified VPC.

resp = client.create_route_table({
  vpc_id: "vpc-a01106c2", 
})

resp.to_h outputs the following:
{
  route_table: {
    associations: [
    ], 
    propagating_vgws: [
    ], 
    route_table_id: "rtb-22574640", 
    routes: [
      {
        destination_cidr_block: "10.0.0.0/16", 
        gateway_id: "local", 
        state: "active", 
      }, 
    ], 
    tags: [
    ], 
    vpc_id: "vpc-a01106c2", 
  }, 
}

Request syntax with placeholder values


resp = client.create_route_table({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
  dry_run: false,
  vpc_id: "VpcId", # required
})

Response structure


resp.route_table.associations #=> Array
resp.route_table.associations[0].main #=> Boolean
resp.route_table.associations[0].route_table_association_id #=> String
resp.route_table.associations[0].route_table_id #=> String
resp.route_table.associations[0].subnet_id #=> String
resp.route_table.associations[0].gateway_id #=> String
resp.route_table.associations[0].association_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failed"
resp.route_table.associations[0].association_state.status_message #=> String
resp.route_table.propagating_vgws #=> Array
resp.route_table.propagating_vgws[0].gateway_id #=> String
resp.route_table.route_table_id #=> String
resp.route_table.routes #=> Array
resp.route_table.routes[0].destination_cidr_block #=> String
resp.route_table.routes[0].destination_ipv_6_cidr_block #=> String
resp.route_table.routes[0].destination_prefix_list_id #=> String
resp.route_table.routes[0].egress_only_internet_gateway_id #=> String
resp.route_table.routes[0].gateway_id #=> String
resp.route_table.routes[0].instance_id #=> String
resp.route_table.routes[0].instance_owner_id #=> String
resp.route_table.routes[0].nat_gateway_id #=> String
resp.route_table.routes[0].transit_gateway_id #=> String
resp.route_table.routes[0].local_gateway_id #=> String
resp.route_table.routes[0].carrier_gateway_id #=> String
resp.route_table.routes[0].network_interface_id #=> String
resp.route_table.routes[0].origin #=> String, one of "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation"
resp.route_table.routes[0].state #=> String, one of "active", "blackhole"
resp.route_table.routes[0].vpc_peering_connection_id #=> String
resp.route_table.routes[0].core_network_arn #=> String
resp.route_table.tags #=> Array
resp.route_table.tags[0].key #=> String
resp.route_table.tags[0].value #=> String
resp.route_table.vpc_id #=> String
resp.route_table.owner_id #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the route table.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :vpc_id (required, String) —

    The ID of the VPC.

Returns:

See Also:



11750
11751
11752
11753
 
# File 'lib/aws-sdk-ec2/client.rb', line 11750

def create_route_table(params = {}, options = {})
  req = build_request(:create_route_table, params)
  req.send_request(options)
end

#create_security_group(params = {}) ⇒ Types::CreateSecurityGroupResult

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][1

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html [2]: docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html [3]: docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html

Examples:

Example: To create a security group for a VPC


# This example creates a security group for the specified VPC.

resp = client.create_security_group({
  description: "My security group", 
  group_name: "my-security-group", 
  vpc_id: "vpc-1a2b3c4d", 
})

resp.to_h outputs the following:
{
  group_id: "sg-903004f8", 
}

Request syntax with placeholder values


resp = client.create_security_group({
  description: "String", # required
  group_name: "String", # required
  vpc_id: "VpcId",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.group_id #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (required, String) —

    A description for the security group.

    Constraints: Up to 255 characters in length

    Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@+=&amp;;{\}!$*

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

  • :vpc_id (String) —

    The ID of the VPC. Required for a nondefault VPC.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the security group.

  • :dry_run (Boolean) —

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

Returns:

See Also:



11866
11867
11868
11869
 
# File 'lib/aws-sdk-ec2/client.rb', line 11866

def create_security_group(params = {}, options = {})
  req = build_request(:create_security_group, params)
  req.send_request(options)
end

#create_snapshot(params = {}) ⇒ Types::Snapshot

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][1

in the *Amazon EC2 User Guide*.

For more information, see [Amazon EBS] and [Amazon EBS encryption] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html [2]: docs.aws.amazon.com/ebs/latest/userguide/what-is-ebs.html [3]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html

Examples:

Example: 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.

resp = client.create_snapshot({
  description: "This is my root volume snapshot.", 
  volume_id: "vol-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
  description: "This is my root volume snapshot.", 
  owner_id: "012345678910", 
  snapshot_id: "snap-066877671789bd71b", 
  start_time: Time.parse("2014-02-28T21:06:01.000Z"), 
  state: "pending", 
  tags: [
  ], 
  volume_id: "vol-1234567890abcdef0", 
  volume_size: 8, 
}

Request syntax with placeholder values


resp = client.create_snapshot({
  description: "String",
  outpost_arn: "String",
  volume_id: "VolumeId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.owner_alias #=> String
resp.outpost_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.storage_tier #=> String, one of "archive", "standard"
resp.restore_expiry_time #=> Time
resp.sse_type #=> String, one of "sse-ebs", "sse-kms", "none"
resp.snapshot_id #=> String
resp.volume_id #=> String
resp.state #=> String, one of "pending", "completed", "error", "recoverable", "recovering"
resp.state_message #=> String
resp.start_time #=> Time
resp.progress #=> String
resp.owner_id #=> String
resp.description #=> String
resp.volume_size #=> Integer
resp.encrypted #=> Boolean
resp.kms_key_id #=> String
resp.data_encryption_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the snapshot.

  • :outpost_arn (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*.

    [1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot

  • :volume_id (required, String) —

    The ID of the Amazon EBS volume.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the snapshot during creation.

  • :dry_run (Boolean) —

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

Returns:

See Also:



12048
12049
12050
12051
 
# File 'lib/aws-sdk-ec2/client.rb', line 12048

def create_snapshot(params = {}, options = {})
  req = build_request(:create_snapshot, params)
  req.send_request(options)
end

#create_snapshots(params = {}) ⇒ Types::CreateSnapshotsResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_snapshots({
  description: "String",
  instance_specification: { # required
    instance_id: "InstanceIdWithVolumeResolver", # required
    exclude_boot_volume: false,
    exclude_data_volume_ids: ["VolumeId"],
  },
  outpost_arn: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  copy_tags_from_source: "volume", # accepts volume
})

Response structure


resp.snapshots #=> Array
resp.snapshots[0].description #=> String
resp.snapshots[0].tags #=> Array
resp.snapshots[0].tags[0].key #=> String
resp.snapshots[0].tags[0].value #=> String
resp.snapshots[0].encrypted #=> Boolean
resp.snapshots[0].volume_id #=> String
resp.snapshots[0].state #=> String, one of "pending", "completed", "error", "recoverable", "recovering"
resp.snapshots[0].volume_size #=> Integer
resp.snapshots[0].start_time #=> Time
resp.snapshots[0].progress #=> String
resp.snapshots[0].owner_id #=> String
resp.snapshots[0].snapshot_id #=> String
resp.snapshots[0].outpost_arn #=> String
resp.snapshots[0].sse_type #=> String, one of "sse-ebs", "sse-kms", "none"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description propagated to every snapshot specified by the instance.

  • :instance_specification (required, Types::InstanceSpecification) —

    The instance to specify which volumes should be included in the snapshots.

  • :outpost_arn (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*.

    [1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-multivol-snapshot

  • :tag_specifications (Array<Types::TagSpecification>) —

    Tags to apply to every snapshot specified by the instance.

  • :dry_run (Boolean) —

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

  • :copy_tags_from_source (String) —

    Copies the tags from the specified volume to corresponding snapshot.

Returns:

See Also:



12162
12163
12164
12165
 
# File 'lib/aws-sdk-ec2/client.rb', line 12162

def create_snapshots(params = {}, options = {})
  req = build_request(:create_snapshots, params)
  req.send_request(options)
end

#create_spot_datafeed_subscription(params = {}) ⇒ Types::CreateSpotDatafeedSubscriptionResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html

Examples:

Example: To create a Spot Instance datafeed


# This example creates a Spot Instance data feed for your AWS account.

resp = client.create_spot_datafeed_subscription({
  bucket: "my-s3-bucket", 
  prefix: "spotdata", 
})

resp.to_h outputs the following:
{
  spot_datafeed_subscription: {
    bucket: "my-s3-bucket", 
    owner_id: "123456789012", 
    prefix: "spotdata", 
    state: "Active", 
  }, 
}

Request syntax with placeholder values


resp = client.create_spot_datafeed_subscription({
  dry_run: false,
  bucket: "String", # required
  prefix: "String",
})

Response structure


resp.spot_datafeed_subscription.bucket #=> String
resp.spot_datafeed_subscription.fault.code #=> String
resp.spot_datafeed_subscription.fault.message #=> String
resp.spot_datafeed_subscription.owner_id #=> String
resp.spot_datafeed_subscription.prefix #=> String
resp.spot_datafeed_subscription.state #=> String, one of "Active", "Inactive"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :bucket (required, String) —

    The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see [Bucket naming rules] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html

  • :prefix (String) —

    The prefix for the data feed file names.

Returns:

See Also:



12239
12240
12241
12242
 
# File 'lib/aws-sdk-ec2/client.rb', line 12239

def create_spot_datafeed_subscription(params = {}, options = {})
  req = build_request(:create_spot_datafeed_subscription, params)
  req.send_request(options)
end

#create_store_image_task(params = {}) ⇒ Types::CreateStoreImageTaskResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html

Examples:

Request syntax with placeholder values


resp = client.create_store_image_task({
  image_id: "ImageId", # required
  bucket: "String", # required
  s3_object_tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  dry_run: false,
})

Response structure


resp.object_key #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI.

  • :bucket (required, 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.

  • :s3_object_tags (Array<Types::S3ObjectTag>) —

    The tags to apply to the AMI object that will be stored in the Amazon S3 bucket.

  • :dry_run (Boolean) —

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

Returns:

See Also:



12303
12304
12305
12306
 
# File 'lib/aws-sdk-ec2/client.rb', line 12303

def create_store_image_task(params = {}, options = {})
  req = build_request(:create_store_image_task, params)
  req.send_request(options)
end

#create_subnet(params = {}) ⇒ Types::CreateSubnetResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html

Examples:

Example: 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.

resp = client.create_subnet({
  cidr_block: "10.0.1.0/24", 
  vpc_id: "vpc-a01106c2", 
})

resp.to_h outputs the following:
{
  subnet: {
    availability_zone: "us-west-2c", 
    available_ip_address_count: 251, 
    cidr_block: "10.0.1.0/24", 
    state: "pending", 
    subnet_id: "subnet-9d4a7b6c", 
    vpc_id: "vpc-a01106c2", 
  }, 
}

Request syntax with placeholder values


resp = client.create_subnet({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  availability_zone: "String",
  availability_zone_id: "String",
  cidr_block: "String",
  ipv_6_cidr_block: "String",
  outpost_arn: "String",
  vpc_id: "VpcId", # required
  ipv_6_native: false,
  ipv_4_ipam_pool_id: "IpamPoolId",
  ipv_4_netmask_length: 1,
  ipv_6_ipam_pool_id: "IpamPoolId",
  ipv_6_netmask_length: 1,
  dry_run: false,
})

Response structure


resp.subnet.availability_zone_id #=> String
resp.subnet.enable_lni_at_device_index #=> Integer
resp.subnet.map_customer_owned_ip_on_launch #=> Boolean
resp.subnet.customer_owned_ipv_4_pool #=> String
resp.subnet.owner_id #=> String
resp.subnet.assign_ipv_6_address_on_creation #=> Boolean
resp.subnet.ipv_6_cidr_block_association_set #=> Array
resp.subnet.ipv_6_cidr_block_association_set[0].association_id #=> String
resp.subnet.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block #=> String
resp.subnet.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.subnet.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.status_message #=> String
resp.subnet.ipv_6_cidr_block_association_set[0].ipv_6_address_attribute #=> String, one of "public", "private"
resp.subnet.ipv_6_cidr_block_association_set[0].ip_source #=> String, one of "amazon", "byoip", "none"
resp.subnet.tags #=> Array
resp.subnet.tags[0].key #=> String
resp.subnet.tags[0].value #=> String
resp.subnet.subnet_arn #=> String
resp.subnet.outpost_arn #=> String
resp.subnet.enable_dns_64 #=> Boolean
resp.subnet.ipv_6_native #=> Boolean
resp.subnet.private_dns_name_options_on_launch.hostname_type #=> String, one of "ip-name", "resource-name"
resp.subnet.private_dns_name_options_on_launch.enable_resource_name_dns_a_record #=> Boolean
resp.subnet.private_dns_name_options_on_launch.enable_resource_name_dns_aaaa_record #=> Boolean
resp.subnet.subnet_id #=> String
resp.subnet.state #=> String, one of "pending", "available", "unavailable"
resp.subnet.vpc_id #=> String
resp.subnet.cidr_block #=> String
resp.subnet.available_ip_address_count #=> Integer
resp.subnet.availability_zone #=> String
resp.subnet.default_for_az #=> Boolean
resp.subnet.map_public_ip_on_launch #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the subnet.

  • :availability_zone (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.

    [1]: docs.aws.amazon.com/local-zones/latest/ug/available-local-zones.html

  • :availability_zone_id (String) —

    The AZ ID or the Local Zone ID of the subnet.

  • :cidr_block (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.

  • :ipv_6_cidr_block (String) —

    The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet.

  • :outpost_arn (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.

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :ipv_6_native (Boolean) —

    Indicates whether to create an IPv6 only subnet.

  • :ipv_4_ipam_pool_id (String) —

    An IPv4 IPAM pool ID for the subnet.

  • :ipv_4_netmask_length (Integer) —

    An IPv4 netmask length for the subnet.

  • :ipv_6_ipam_pool_id (String) —

    An IPv6 IPAM pool ID for the subnet.

  • :ipv_6_netmask_length (Integer) —

    An IPv6 netmask length for the subnet.

  • :dry_run (Boolean) —

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

Returns:

See Also:



12498
12499
12500
12501
 
# File 'lib/aws-sdk-ec2/client.rb', line 12498

def create_subnet(params = {}, options = {})
  req = build_request(:create_subnet, params)
  req.send_request(options)
end

#create_subnet_cidr_reservation(params = {}) ⇒ Types::CreateSubnetCidrReservationResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html

Examples:

Request syntax with placeholder values


resp = client.create_subnet_cidr_reservation({
  subnet_id: "SubnetId", # required
  cidr: "String", # required
  reservation_type: "prefix", # required, accepts prefix, explicit
  description: "String",
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.subnet_cidr_reservation.subnet_cidr_reservation_id #=> String
resp.subnet_cidr_reservation.subnet_id #=> String
resp.subnet_cidr_reservation.cidr #=> String
resp.subnet_cidr_reservation.reservation_type #=> String, one of "prefix", "explicit"
resp.subnet_cidr_reservation.owner_id #=> String
resp.subnet_cidr_reservation.description #=> String
resp.subnet_cidr_reservation.tags #=> Array
resp.subnet_cidr_reservation.tags[0].key #=> String
resp.subnet_cidr_reservation.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subnet_id (required, String) —

    The ID of the subnet.

  • :cidr (required, String) —

    The IPv4 or IPV6 CIDR range to reserve.

  • :reservation_type (required, 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.

  • :description (String) —

    The description to assign to the subnet CIDR reservation.

  • :dry_run (Boolean) —

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

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the subnet CIDR reservation.

Returns:

See Also:



12581
12582
12583
12584
 
# File 'lib/aws-sdk-ec2/client.rb', line 12581

def create_subnet_cidr_reservation(params = {}, options = {})
  req = build_request(:create_subnet_cidr_reservation, params)
  req.send_request(options)
end

#create_tags(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-iam-actions-resources.html

Examples:

Example: 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.

resp = client.create_tags({
  resources: [
    "ami-78a54011", 
  ], 
  tags: [
    {
      key: "Stack", 
      value: "production", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.create_tags({
  dry_run: false,
  resources: ["TaggableResourceId"], # required
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The tags. The ‘value` parameter is required, but if you don’t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12658
12659
12660
12661
 
# File 'lib/aws-sdk-ec2/client.rb', line 12658

def create_tags(params = {}, options = {})
  req = build_request(:create_tags, params)
  req.send_request(options)
end

#create_traffic_mirror_filter(params = {}) ⇒ Types::CreateTrafficMirrorFilterResult

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][1

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilterRule.htm [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyTrafficMirrorFilterNetworkServices.html

Examples:

Request syntax with placeholder values


resp = client.create_traffic_mirror_filter({
  description: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  client_token: "String",
})

Response structure


resp.traffic_mirror_filter.traffic_mirror_filter_id #=> String
resp.traffic_mirror_filter.ingress_filter_rules #=> Array
resp.traffic_mirror_filter.ingress_filter_rules[0].traffic_mirror_filter_rule_id #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].traffic_mirror_filter_id #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].traffic_direction #=> String, one of "ingress", "egress"
resp.traffic_mirror_filter.ingress_filter_rules[0].rule_number #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].rule_action #=> String, one of "accept", "reject"
resp.traffic_mirror_filter.ingress_filter_rules[0].protocol #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].destination_port_range.from_port #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].destination_port_range.to_port #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].source_port_range.from_port #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].source_port_range.to_port #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].destination_cidr_block #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].source_cidr_block #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].description #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].tags #=> Array
resp.traffic_mirror_filter.ingress_filter_rules[0].tags[0].key #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].tags[0].value #=> String
resp.traffic_mirror_filter.egress_filter_rules #=> Array
resp.traffic_mirror_filter.egress_filter_rules[0].traffic_mirror_filter_rule_id #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].traffic_mirror_filter_id #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].traffic_direction #=> String, one of "ingress", "egress"
resp.traffic_mirror_filter.egress_filter_rules[0].rule_number #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].rule_action #=> String, one of "accept", "reject"
resp.traffic_mirror_filter.egress_filter_rules[0].protocol #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].destination_port_range.from_port #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].destination_port_range.to_port #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].source_port_range.from_port #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].source_port_range.to_port #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].destination_cidr_block #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].source_cidr_block #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].description #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].tags #=> Array
resp.traffic_mirror_filter.egress_filter_rules[0].tags[0].key #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].tags[0].value #=> String
resp.traffic_mirror_filter.network_services #=> Array
resp.traffic_mirror_filter.network_services[0] #=> String, one of "amazon-dns"
resp.traffic_mirror_filter.description #=> String
resp.traffic_mirror_filter.tags #=> Array
resp.traffic_mirror_filter.tags[0].key #=> String
resp.traffic_mirror_filter.tags[0].value #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    The description of the Traffic Mirror filter.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to a Traffic Mirror filter.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



12776
12777
12778
12779
 
# File 'lib/aws-sdk-ec2/client.rb', line 12776

def create_traffic_mirror_filter(params = {}, options = {})
  req = build_request(:create_traffic_mirror_filter, params)
  req.send_request(options)
end

#create_traffic_mirror_filter_rule(params = {}) ⇒ Types::CreateTrafficMirrorFilterRuleResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_traffic_mirror_filter_rule({
  traffic_mirror_filter_id: "TrafficMirrorFilterId", # required
  traffic_direction: "ingress", # required, accepts ingress, egress
  rule_number: 1, # required
  rule_action: "accept", # required, accepts accept, reject
  destination_port_range: {
    from_port: 1,
    to_port: 1,
  },
  source_port_range: {
    from_port: 1,
    to_port: 1,
  },
  protocol: 1,
  destination_cidr_block: "String", # required
  source_cidr_block: "String", # required
  description: "String",
  dry_run: false,
  client_token: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.traffic_mirror_filter_rule.traffic_mirror_filter_rule_id #=> String
resp.traffic_mirror_filter_rule.traffic_mirror_filter_id #=> String
resp.traffic_mirror_filter_rule.traffic_direction #=> String, one of "ingress", "egress"
resp.traffic_mirror_filter_rule.rule_number #=> Integer
resp.traffic_mirror_filter_rule.rule_action #=> String, one of "accept", "reject"
resp.traffic_mirror_filter_rule.protocol #=> Integer
resp.traffic_mirror_filter_rule.destination_port_range.from_port #=> Integer
resp.traffic_mirror_filter_rule.destination_port_range.to_port #=> Integer
resp.traffic_mirror_filter_rule.source_port_range.from_port #=> Integer
resp.traffic_mirror_filter_rule.source_port_range.to_port #=> Integer
resp.traffic_mirror_filter_rule.destination_cidr_block #=> String
resp.traffic_mirror_filter_rule.source_cidr_block #=> String
resp.traffic_mirror_filter_rule.description #=> String
resp.traffic_mirror_filter_rule.tags #=> Array
resp.traffic_mirror_filter_rule.tags[0].key #=> String
resp.traffic_mirror_filter_rule.tags[0].value #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_filter_id (required, String) —

    The ID of the filter that this rule is associated with.

  • :traffic_direction (required, String) —

    The type of traffic.

  • :rule_number (required, 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.

  • :rule_action (required, String) —

    The action to take on the filtered traffic.

  • :destination_port_range (Types::TrafficMirrorPortRangeRequest) —

    The destination port range.

  • :source_port_range (Types::TrafficMirrorPortRangeRequest) —

    The source port range.

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

    [1]: www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml

  • :destination_cidr_block (required, String) —

    The destination CIDR block to assign to the Traffic Mirror rule.

  • :source_cidr_block (required, String) —

    The source CIDR block to assign to the Traffic Mirror rule.

  • :description (String) —

    The description of the Traffic Mirror rule.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :tag_specifications (Array<Types::TagSpecification>) —

    Traffic Mirroring tags specifications.

Returns:

See Also:



12911
12912
12913
12914
 
# File 'lib/aws-sdk-ec2/client.rb', line 12911

def create_traffic_mirror_filter_rule(params = {}, options = {})
  req = build_request(:create_traffic_mirror_filter_rule, params)
  req.send_request(options)
end

#create_traffic_mirror_session(params = {}) ⇒ Types::CreateTrafficMirrorSessionResult

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilter.htm

Examples:

Request syntax with placeholder values


resp = client.create_traffic_mirror_session({
  network_interface_id: "NetworkInterfaceId", # required
  traffic_mirror_target_id: "TrafficMirrorTargetId", # required
  traffic_mirror_filter_id: "TrafficMirrorFilterId", # required
  packet_length: 1,
  session_number: 1, # required
  virtual_network_id: 1,
  description: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  client_token: "String",
})

Response structure


resp.traffic_mirror_session.traffic_mirror_session_id #=> String
resp.traffic_mirror_session.traffic_mirror_target_id #=> String
resp.traffic_mirror_session.traffic_mirror_filter_id #=> String
resp.traffic_mirror_session.network_interface_id #=> String
resp.traffic_mirror_session.owner_id #=> String
resp.traffic_mirror_session.packet_length #=> Integer
resp.traffic_mirror_session.session_number #=> Integer
resp.traffic_mirror_session.virtual_network_id #=> Integer
resp.traffic_mirror_session.description #=> String
resp.traffic_mirror_session.tags #=> Array
resp.traffic_mirror_session.tags[0].key #=> String
resp.traffic_mirror_session.tags[0].value #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_interface_id (required, String) —

    The ID of the source network interface.

  • :traffic_mirror_target_id (required, String) —

    The ID of the Traffic Mirror target.

  • :traffic_mirror_filter_id (required, String) —

    The ID of the Traffic Mirror filter.

  • :packet_length (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.

  • :session_number (required, 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.

  • :virtual_network_id (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.

    [1]: datatracker.ietf.org/doc/html/rfc7348

  • :description (String) —

    The description of the Traffic Mirror session.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to a Traffic Mirror session.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



13049
13050
13051
13052
 
# File 'lib/aws-sdk-ec2/client.rb', line 13049

def create_traffic_mirror_session(params = {}, options = {})
  req = build_request(:create_traffic_mirror_session, params)
  req.send_request(options)
end

#create_traffic_mirror_target(params = {}) ⇒ Types::CreateTrafficMirrorTargetResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorSession.htm

Examples:

Request syntax with placeholder values


resp = client.create_traffic_mirror_target({
  network_interface_id: "NetworkInterfaceId",
  network_load_balancer_arn: "String",
  description: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  client_token: "String",
  gateway_load_balancer_endpoint_id: "VpcEndpointId",
})

Response structure


resp.traffic_mirror_target.traffic_mirror_target_id #=> String
resp.traffic_mirror_target.network_interface_id #=> String
resp.traffic_mirror_target.network_load_balancer_arn #=> String
resp.traffic_mirror_target.type #=> String, one of "network-interface", "network-load-balancer", "gateway-load-balancer-endpoint"
resp.traffic_mirror_target.description #=> String
resp.traffic_mirror_target.owner_id #=> String
resp.traffic_mirror_target.tags #=> Array
resp.traffic_mirror_target.tags[0].key #=> String
resp.traffic_mirror_target.tags[0].value #=> String
resp.traffic_mirror_target.gateway_load_balancer_endpoint_id #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_interface_id (String) —

    The network interface ID that is associated with the target.

  • :network_load_balancer_arn (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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the Traffic Mirror target.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :gateway_load_balancer_endpoint_id (String) —

    The ID of the Gateway Load Balancer endpoint.

Returns:

See Also:



13150
13151
13152
13153
 
# File 'lib/aws-sdk-ec2/client.rb', line 13150

def create_traffic_mirror_target(params = {}, options = {})
  req = build_request(:create_traffic_mirror_target, params)
  req.send_request(options)
end

#create_transit_gateway(params = {}) ⇒ Types::CreateTransitGatewayResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway({
  description: "String",
  options: {
    amazon_side_asn: 1,
    auto_accept_shared_attachments: "enable", # accepts enable, disable
    default_route_table_association: "enable", # accepts enable, disable
    default_route_table_propagation: "enable", # accepts enable, disable
    vpn_ecmp_support: "enable", # accepts enable, disable
    dns_support: "enable", # accepts enable, disable
    security_group_referencing_support: "enable", # accepts enable, disable
    multicast_support: "enable", # accepts enable, disable
    transit_gateway_cidr_blocks: ["String"],
  },
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.transit_gateway.transit_gateway_id #=> String
resp.transit_gateway.transit_gateway_arn #=> String
resp.transit_gateway.state #=> String, one of "pending", "available", "modifying", "deleting", "deleted"
resp.transit_gateway.owner_id #=> String
resp.transit_gateway.description #=> String
resp.transit_gateway.creation_time #=> Time
resp.transit_gateway.options.amazon_side_asn #=> Integer
resp.transit_gateway.options.transit_gateway_cidr_blocks #=> Array
resp.transit_gateway.options.transit_gateway_cidr_blocks[0] #=> String
resp.transit_gateway.options.auto_accept_shared_attachments #=> String, one of "enable", "disable"
resp.transit_gateway.options.default_route_table_association #=> String, one of "enable", "disable"
resp.transit_gateway.options.association_default_route_table_id #=> String
resp.transit_gateway.options.default_route_table_propagation #=> String, one of "enable", "disable"
resp.transit_gateway.options.propagation_default_route_table_id #=> String
resp.transit_gateway.options.vpn_ecmp_support #=> String, one of "enable", "disable"
resp.transit_gateway.options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateway.options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateway.options.multicast_support #=> String, one of "enable", "disable"
resp.transit_gateway.tags #=> Array
resp.transit_gateway.tags[0].key #=> String
resp.transit_gateway.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description of the transit gateway.

  • :options (Types::TransitGatewayRequestOptions) —

    The transit gateway options.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the transit gateway.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13255
13256
13257
13258
 
# File 'lib/aws-sdk-ec2/client.rb', line 13255

def create_transit_gateway(params = {}, options = {})
  req = build_request(:create_transit_gateway, params)
  req.send_request(options)
end

#create_transit_gateway_connect(params = {}) ⇒ Types::CreateTransitGatewayConnectResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_connect({
  transport_transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  options: { # required
    protocol: "gre", # required, accepts gre
  },
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.transit_gateway_connect.transit_gateway_attachment_id #=> String
resp.transit_gateway_connect.transport_transit_gateway_attachment_id #=> String
resp.transit_gateway_connect.transit_gateway_id #=> String
resp.transit_gateway_connect.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_connect.creation_time #=> Time
resp.transit_gateway_connect.options.protocol #=> String, one of "gre"
resp.transit_gateway_connect.tags #=> Array
resp.transit_gateway_connect.tags[0].key #=> String
resp.transit_gateway_connect.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transport_transit_gateway_attachment_id (required, String) —

    The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.

  • :options (required, Types::CreateTransitGatewayConnectRequestOptions) —

    The Connect attachment options.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the Connect attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13325
13326
13327
13328
 
# File 'lib/aws-sdk-ec2/client.rb', line 13325

def create_transit_gateway_connect(params = {}, options = {})
  req = build_request(:create_transit_gateway_connect, params)
  req.send_request(options)
end

#create_transit_gateway_connect_peer(params = {}) ⇒ Types::CreateTransitGatewayConnectPeerResult

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

[1]: docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html#tgw-connect-peer

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_connect_peer({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  transit_gateway_address: "String",
  peer_address: "String", # required
  bgp_options: {
    peer_asn: 1,
  },
  inside_cidr_blocks: ["String"], # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.transit_gateway_connect_peer.transit_gateway_attachment_id #=> String
resp.transit_gateway_connect_peer.transit_gateway_connect_peer_id #=> String
resp.transit_gateway_connect_peer.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_connect_peer.creation_time #=> Time
resp.transit_gateway_connect_peer.connect_peer_configuration.transit_gateway_address #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.peer_address #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.inside_cidr_blocks #=> Array
resp.transit_gateway_connect_peer.connect_peer_configuration.inside_cidr_blocks[0] #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.protocol #=> String, one of "gre"
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations #=> Array
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].transit_gateway_asn #=> Integer
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].peer_asn #=> Integer
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].transit_gateway_address #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].peer_address #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].bgp_status #=> String, one of "up", "down"
resp.transit_gateway_connect_peer.tags #=> Array
resp.transit_gateway_connect_peer.tags[0].key #=> String
resp.transit_gateway_connect_peer.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the Connect attachment.

  • :transit_gateway_address (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.

  • :peer_address (required, String) —

    The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

  • :bgp_options (Types::TransitGatewayConnectRequestBgpOptions) —

    The BGP options for the Connect peer.

  • :inside_cidr_blocks (required, 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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the Connect peer.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13428
13429
13430
13431
 
# File 'lib/aws-sdk-ec2/client.rb', line 13428

def create_transit_gateway_connect_peer(params = {}, options = {})
  req = build_request(:create_transit_gateway_connect_peer, params)
  req.send_request(options)
end

#create_transit_gateway_multicast_domain(params = {}) ⇒ Types::CreateTransitGatewayMulticastDomainResult

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_multicast_domain({
  transit_gateway_id: "TransitGatewayId", # required
  options: {
    igmpv_2_support: "enable", # accepts enable, disable
    static_sources_support: "enable", # accepts enable, disable
    auto_accept_shared_associations: "enable", # accepts enable, disable
  },
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.transit_gateway_multicast_domain.transit_gateway_multicast_domain_id #=> String
resp.transit_gateway_multicast_domain.transit_gateway_id #=> String
resp.transit_gateway_multicast_domain.transit_gateway_multicast_domain_arn #=> String
resp.transit_gateway_multicast_domain.owner_id #=> String
resp.transit_gateway_multicast_domain.options.igmpv_2_support #=> String, one of "enable", "disable"
resp.transit_gateway_multicast_domain.options.static_sources_support #=> String, one of "enable", "disable"
resp.transit_gateway_multicast_domain.options.auto_accept_shared_associations #=> String, one of "enable", "disable"
resp.transit_gateway_multicast_domain.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_multicast_domain.creation_time #=> Time
resp.transit_gateway_multicast_domain.tags #=> Array
resp.transit_gateway_multicast_domain.tags[0].key #=> String
resp.transit_gateway_multicast_domain.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_id (required, String) —

    The ID of the transit gateway.

  • :options (Types::CreateTransitGatewayMulticastDomainRequestOptions) —

    The options for the transit gateway multicast domain.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags for the transit gateway multicast domain.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13504
13505
13506
13507
 
# File 'lib/aws-sdk-ec2/client.rb', line 13504

def create_transit_gateway_multicast_domain(params = {}, options = {})
  req = build_request(:create_transit_gateway_multicast_domain, params)
  req.send_request(options)
end

#create_transit_gateway_peering_attachment(params = {}) ⇒ Types::CreateTransitGatewayPeeringAttachmentResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_peering_attachment({
  transit_gateway_id: "TransitGatewayId", # required
  peer_transit_gateway_id: "TransitAssociationGatewayId", # required
  peer_account_id: "String", # required
  peer_region: "String", # required
  options: {
    dynamic_routing: "enable", # accepts enable, disable
  },
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.transit_gateway_peering_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachment.accepter_transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.region #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.region #=> String
resp.transit_gateway_peering_attachment.options.dynamic_routing #=> String, one of "enable", "disable"
resp.transit_gateway_peering_attachment.status.code #=> String
resp.transit_gateway_peering_attachment.status.message #=> String
resp.transit_gateway_peering_attachment.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_peering_attachment.creation_time #=> Time
resp.transit_gateway_peering_attachment.tags #=> Array
resp.transit_gateway_peering_attachment.tags[0].key #=> String
resp.transit_gateway_peering_attachment.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_id (required, String) —

    The ID of the transit gateway.

  • :peer_transit_gateway_id (required, String) —

    The ID of the peer transit gateway with which to create the peering attachment.

  • :peer_account_id (required, String) —

    The ID of the Amazon Web Services account that owns the peer transit gateway.

  • :peer_region (required, String) —

    The Region where the peer transit gateway is located.

  • :options (Types::CreateTransitGatewayPeeringAttachmentRequestOptions) —

    Requests a transit gateway peering attachment.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the transit gateway peering attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13596
13597
13598
13599
 
# File 'lib/aws-sdk-ec2/client.rb', line 13596

def create_transit_gateway_peering_attachment(params = {}, options = {})
  req = build_request(:create_transit_gateway_peering_attachment, params)
  req.send_request(options)
end

#create_transit_gateway_policy_table(params = {}) ⇒ Types::CreateTransitGatewayPolicyTableResult

Creates a transit gateway policy table.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_policy_table({
  transit_gateway_id: "TransitGatewayId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.transit_gateway_policy_table.transit_gateway_policy_table_id #=> String
resp.transit_gateway_policy_table.transit_gateway_id #=> String
resp.transit_gateway_policy_table.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_policy_table.creation_time #=> Time
resp.transit_gateway_policy_table.tags #=> Array
resp.transit_gateway_policy_table.tags[0].key #=> String
resp.transit_gateway_policy_table.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_id (required, String) —

    The ID of the transit gateway used for the policy table.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags specification for the transit gateway policy table created during the request.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13652
13653
13654
13655
 
# File 'lib/aws-sdk-ec2/client.rb', line 13652

def create_transit_gateway_policy_table(params = {}, options = {})
  req = build_request(:create_transit_gateway_policy_table, params)
  req.send_request(options)
end

#create_transit_gateway_prefix_list_reference(params = {}) ⇒ Types::CreateTransitGatewayPrefixListReferenceResult

Creates a reference (route) to a prefix list in a specified transit gateway route table.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_prefix_list_reference({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  prefix_list_id: "PrefixListResourceId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId",
  blackhole: false,
  dry_run: false,
})

Response structure


resp.transit_gateway_prefix_list_reference.transit_gateway_route_table_id #=> String
resp.transit_gateway_prefix_list_reference.prefix_list_id #=> String
resp.transit_gateway_prefix_list_reference.prefix_list_owner_id #=> String
resp.transit_gateway_prefix_list_reference.state #=> String, one of "pending", "available", "modifying", "deleting"
resp.transit_gateway_prefix_list_reference.blackhole #=> Boolean
resp.transit_gateway_prefix_list_reference.transit_gateway_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_prefix_list_reference.transit_gateway_attachment.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.transit_gateway_prefix_list_reference.transit_gateway_attachment.resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :prefix_list_id (required, String) —

    The ID of the prefix list that is used for destination matches.

  • :transit_gateway_attachment_id (String) —

    The ID of the attachment to which traffic is routed.

  • :blackhole (Boolean) —

    Indicates whether to drop traffic that matches this route.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13707
13708
13709
13710
 
# File 'lib/aws-sdk-ec2/client.rb', line 13707

def create_transit_gateway_prefix_list_reference(params = {}, options = {})
  req = build_request(:create_transit_gateway_prefix_list_reference, params)
  req.send_request(options)
end

#create_transit_gateway_route(params = {}) ⇒ Types::CreateTransitGatewayRouteResult

Creates a static route for the specified transit gateway route table.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_route({
  destination_cidr_block: "String", # required
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId",
  blackhole: false,
  dry_run: false,
})

Response structure


resp.route.destination_cidr_block #=> String
resp.route.prefix_list_id #=> String
resp.route.transit_gateway_route_table_announcement_id #=> String
resp.route.transit_gateway_attachments #=> Array
resp.route.transit_gateway_attachments[0].resource_id #=> String
resp.route.transit_gateway_attachments[0].transit_gateway_attachment_id #=> String
resp.route.transit_gateway_attachments[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.route.type #=> String, one of "static", "propagated"
resp.route.state #=> String, one of "pending", "active", "blackhole", "deleting", "deleted"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_cidr_block (required, String) —

    The CIDR range used for destination matches. Routing decisions are based on the most specific match.

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :transit_gateway_attachment_id (String) —

    The ID of the attachment.

  • :blackhole (Boolean) —

    Indicates whether to drop traffic that matches this route.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13763
13764
13765
13766
 
# File 'lib/aws-sdk-ec2/client.rb', line 13763

def create_transit_gateway_route(params = {}, options = {})
  req = build_request(:create_transit_gateway_route, params)
  req.send_request(options)
end

#create_transit_gateway_route_table(params = {}) ⇒ Types::CreateTransitGatewayRouteTableResult

Creates a route table for the specified transit gateway.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_route_table({
  transit_gateway_id: "TransitGatewayId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.transit_gateway_route_table.transit_gateway_route_table_id #=> String
resp.transit_gateway_route_table.transit_gateway_id #=> String
resp.transit_gateway_route_table.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_route_table.default_association_route_table #=> Boolean
resp.transit_gateway_route_table.default_propagation_route_table #=> Boolean
resp.transit_gateway_route_table.creation_time #=> Time
resp.transit_gateway_route_table.tags #=> Array
resp.transit_gateway_route_table.tags[0].key #=> String
resp.transit_gateway_route_table.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_id (required, String) —

    The ID of the transit gateway.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the transit gateway route table.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13820
13821
13822
13823
 
# File 'lib/aws-sdk-ec2/client.rb', line 13820

def create_transit_gateway_route_table(params = {}, options = {})
  req = build_request(:create_transit_gateway_route_table, params)
  req.send_request(options)
end

#create_transit_gateway_route_table_announcement(params = {}) ⇒ Types::CreateTransitGatewayRouteTableAnnouncementResult

Advertises a new transit gateway route table.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_route_table_announcement({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  peering_attachment_id: "TransitGatewayAttachmentId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.transit_gateway_route_table_announcement.transit_gateway_route_table_announcement_id #=> String
resp.transit_gateway_route_table_announcement.transit_gateway_id #=> String
resp.transit_gateway_route_table_announcement.core_network_id #=> String
resp.transit_gateway_route_table_announcement.peer_transit_gateway_id #=> String
resp.transit_gateway_route_table_announcement.peer_core_network_id #=> String
resp.transit_gateway_route_table_announcement.peering_attachment_id #=> String
resp.transit_gateway_route_table_announcement.announcement_direction #=> String, one of "outgoing", "incoming"
resp.transit_gateway_route_table_announcement.transit_gateway_route_table_id #=> String
resp.transit_gateway_route_table_announcement.state #=> String, one of "available", "pending", "failing", "failed", "deleting", "deleted"
resp.transit_gateway_route_table_announcement.creation_time #=> Time
resp.transit_gateway_route_table_announcement.tags #=> Array
resp.transit_gateway_route_table_announcement.tags[0].key #=> String
resp.transit_gateway_route_table_announcement.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :peering_attachment_id (required, String) —

    The ID of the peering attachment.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags specifications applied to the transit gateway route table announcement.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13886
13887
13888
13889
 
# File 'lib/aws-sdk-ec2/client.rb', line 13886

def create_transit_gateway_route_table_announcement(params = {}, options = {})
  req = build_request(:create_transit_gateway_route_table_announcement, params)
  req.send_request(options)
end

#create_transit_gateway_vpc_attachment(params = {}) ⇒ Types::CreateTransitGatewayVpcAttachmentResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_vpc_attachment({
  transit_gateway_id: "TransitGatewayId", # required
  vpc_id: "VpcId", # required
  subnet_ids: ["SubnetId"], # required
  options: {
    dns_support: "enable", # accepts enable, disable
    security_group_referencing_support: "enable", # accepts enable, disable
    ipv_6_support: "enable", # accepts enable, disable
    appliance_mode_support: "enable", # accepts enable, disable
  },
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Response structure


resp.transit_gateway_vpc_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_vpc_attachment.transit_gateway_id #=> String
resp.transit_gateway_vpc_attachment.vpc_id #=> String
resp.transit_gateway_vpc_attachment.vpc_owner_id #=> String
resp.transit_gateway_vpc_attachment.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_vpc_attachment.subnet_ids #=> Array
resp.transit_gateway_vpc_attachment.subnet_ids[0] #=> String
resp.transit_gateway_vpc_attachment.creation_time #=> Time
resp.transit_gateway_vpc_attachment.options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.ipv_6_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.appliance_mode_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.tags #=> Array
resp.transit_gateway_vpc_attachment.tags[0].key #=> String
resp.transit_gateway_vpc_attachment.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_id (required, String) —

    The ID of the transit gateway.

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :subnet_ids (required, 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 (Types::CreateTransitGatewayVpcAttachmentRequestOptions) —

    The VPC attachment options.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the VPC attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



13976
13977
13978
13979
 
# File 'lib/aws-sdk-ec2/client.rb', line 13976

def create_transit_gateway_vpc_attachment(params = {}, options = {})
  req = build_request(:create_transit_gateway_vpc_attachment, params)
  req.send_request(options)
end

#create_verified_access_endpoint(params = {}) ⇒ Types::CreateVerifiedAccessEndpointResult

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

Examples:

Request syntax with placeholder values


resp = client.create_verified_access_endpoint({
  verified_access_group_id: "VerifiedAccessGroupId", # required
  endpoint_type: "load-balancer", # required, accepts load-balancer, network-interface
  attachment_type: "vpc", # required, accepts vpc
  domain_certificate_arn: "CertificateArn", # required
  application_domain: "String", # required
  endpoint_domain_prefix: "String", # required
  security_group_ids: ["SecurityGroupId"],
  load_balancer_options: {
    protocol: "http", # accepts http, https
    port: 1,
    load_balancer_arn: "LoadBalancerArn",
    subnet_ids: ["SubnetId"],
  },
  network_interface_options: {
    network_interface_id: "NetworkInterfaceId",
    protocol: "http", # accepts http, https
    port: 1,
  },
  description: "String",
  policy_document: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
  dry_run: false,
  sse_specification: {
    customer_managed_key_enabled: false,
    kms_key_arn: "KmsKeyArn",
  },
})

Response structure


resp.verified_access_endpoint.verified_access_instance_id #=> String
resp.verified_access_endpoint.verified_access_group_id #=> String
resp.verified_access_endpoint.verified_access_endpoint_id #=> String
resp.verified_access_endpoint.application_domain #=> String
resp.verified_access_endpoint.endpoint_type #=> String, one of "load-balancer", "network-interface"
resp.verified_access_endpoint.attachment_type #=> String, one of "vpc"
resp.verified_access_endpoint.domain_certificate_arn #=> String
resp.verified_access_endpoint.endpoint_domain #=> String
resp.verified_access_endpoint.device_validation_domain #=> String
resp.verified_access_endpoint.security_group_ids #=> Array
resp.verified_access_endpoint.security_group_ids[0] #=> String
resp.verified_access_endpoint.load_balancer_options.protocol #=> String, one of "http", "https"
resp.verified_access_endpoint.load_balancer_options.port #=> Integer
resp.verified_access_endpoint.load_balancer_options.load_balancer_arn #=> String
resp.verified_access_endpoint.load_balancer_options.subnet_ids #=> Array
resp.verified_access_endpoint.load_balancer_options.subnet_ids[0] #=> String
resp.verified_access_endpoint.network_interface_options.network_interface_id #=> String
resp.verified_access_endpoint.network_interface_options.protocol #=> String, one of "http", "https"
resp.verified_access_endpoint.network_interface_options.port #=> Integer
resp.verified_access_endpoint.status.code #=> String, one of "pending", "active", "updating", "deleting", "deleted"
resp.verified_access_endpoint.status.message #=> String
resp.verified_access_endpoint.description #=> String
resp.verified_access_endpoint.creation_time #=> String
resp.verified_access_endpoint.last_updated_time #=> String
resp.verified_access_endpoint.deletion_time #=> String
resp.verified_access_endpoint.tags #=> Array
resp.verified_access_endpoint.tags[0].key #=> String
resp.verified_access_endpoint.tags[0].value #=> String
resp.verified_access_endpoint.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_endpoint.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_group_id (required, String) —

    The ID of the Verified Access group to associate the endpoint with.

  • :endpoint_type (required, String) —

    The type of Verified Access endpoint to create.

  • :attachment_type (required, String) —

    The type of attachment.

  • :domain_certificate_arn (required, 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.

  • :application_domain (required, String) —

    The DNS name for users to reach your application.

  • :endpoint_domain_prefix (required, String) —

    A custom identifier that is prepended to the DNS name that is generated for the endpoint.

  • :security_group_ids (Array<String>) —

    The IDs of the security groups to associate with the Verified Access endpoint. Required if ‘AttachmentType` is set to `vpc`.

  • :load_balancer_options (Types::CreateVerifiedAccessEndpointLoadBalancerOptions) —

    The load balancer details. This parameter is required if the endpoint type is ‘load-balancer`.

  • :network_interface_options (Types::CreateVerifiedAccessEndpointEniOptions) —

    The network interface details. This parameter is required if the endpoint type is ‘network-interface`.

  • :description (String) —

    A description for the Verified Access endpoint.

  • :policy_document (String) —

    The Verified Access policy document.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the Verified Access endpoint.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :sse_specification (Types::VerifiedAccessSseSpecificationRequest) —

    The options for server side encryption.

Returns:

See Also:



14131
14132
14133
14134
 
# File 'lib/aws-sdk-ec2/client.rb', line 14131

def create_verified_access_endpoint(params = {}, options = {})
  req = build_request(:create_verified_access_endpoint, params)
  req.send_request(options)
end

#create_verified_access_group(params = {}) ⇒ Types::CreateVerifiedAccessGroupResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_verified_access_group({
  verified_access_instance_id: "VerifiedAccessInstanceId", # required
  description: "String",
  policy_document: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
  dry_run: false,
  sse_specification: {
    customer_managed_key_enabled: false,
    kms_key_arn: "KmsKeyArn",
  },
})

Response structure


resp.verified_access_group.verified_access_group_id #=> String
resp.verified_access_group.verified_access_instance_id #=> String
resp.verified_access_group.description #=> String
resp.verified_access_group.owner #=> String
resp.verified_access_group.verified_access_group_arn #=> String
resp.verified_access_group.creation_time #=> String
resp.verified_access_group.last_updated_time #=> String
resp.verified_access_group.deletion_time #=> String
resp.verified_access_group.tags #=> Array
resp.verified_access_group.tags[0].key #=> String
resp.verified_access_group.tags[0].value #=> String
resp.verified_access_group.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_group.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_instance_id (required, String) —

    The ID of the Verified Access instance.

  • :description (String) —

    A description for the Verified Access group.

  • :policy_document (String) —

    The Verified Access policy document.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the Verified Access group.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :sse_specification (Types::VerifiedAccessSseSpecificationRequest) —

    The options for server side encryption.

Returns:

See Also:



14225
14226
14227
14228
 
# File 'lib/aws-sdk-ec2/client.rb', line 14225

def create_verified_access_group(params = {}, options = {})
  req = build_request(:create_verified_access_group, params)
  req.send_request(options)
end

#create_verified_access_instance(params = {}) ⇒ Types::CreateVerifiedAccessInstanceResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_verified_access_instance({
  description: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
  dry_run: false,
  fips_enabled: false,
})

Response structure


resp.verified_access_instance.verified_access_instance_id #=> String
resp.verified_access_instance.description #=> String
resp.verified_access_instance.verified_access_trust_providers #=> Array
resp.verified_access_instance.verified_access_trust_providers[0].verified_access_trust_provider_id #=> String
resp.verified_access_instance.verified_access_trust_providers[0].description #=> String
resp.verified_access_instance.verified_access_trust_providers[0].trust_provider_type #=> String, one of "user", "device"
resp.verified_access_instance.verified_access_trust_providers[0].user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_instance.verified_access_trust_providers[0].device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_instance.creation_time #=> String
resp.verified_access_instance.last_updated_time #=> String
resp.verified_access_instance.tags #=> Array
resp.verified_access_instance.tags[0].key #=> String
resp.verified_access_instance.tags[0].value #=> String
resp.verified_access_instance.fips_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the Verified Access instance.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the Verified Access instance.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :fips_enabled (Boolean) —

    Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.

Returns:

See Also:



14307
14308
14309
14310
 
# File 'lib/aws-sdk-ec2/client.rb', line 14307

def create_verified_access_instance(params = {}, options = {})
  req = build_request(:create_verified_access_instance, params)
  req.send_request(options)
end

#create_verified_access_trust_provider(params = {}) ⇒ Types::CreateVerifiedAccessTrustProviderResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_verified_access_trust_provider({
  trust_provider_type: "user", # required, accepts user, device
  user_trust_provider_type: "iam-identity-center", # accepts iam-identity-center, oidc
  device_trust_provider_type: "jamf", # accepts jamf, crowdstrike, jumpcloud
  oidc_options: {
    issuer: "String",
    authorization_endpoint: "String",
    token_endpoint: "String",
    user_info_endpoint: "String",
    client_id: "String",
    client_secret: "ClientSecretType",
    scope: "String",
  },
  device_options: {
    tenant_id: "String",
    public_signing_key_url: "String",
  },
  policy_reference_name: "String", # required
  description: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String",
  dry_run: false,
  sse_specification: {
    customer_managed_key_enabled: false,
    kms_key_arn: "KmsKeyArn",
  },
})

Response structure


resp.verified_access_trust_provider.verified_access_trust_provider_id #=> String
resp.verified_access_trust_provider.description #=> String
resp.verified_access_trust_provider.trust_provider_type #=> String, one of "user", "device"
resp.verified_access_trust_provider.user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_trust_provider.device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_trust_provider.oidc_options.issuer #=> String
resp.verified_access_trust_provider.oidc_options.authorization_endpoint #=> String
resp.verified_access_trust_provider.oidc_options.token_endpoint #=> String
resp.verified_access_trust_provider.oidc_options. #=> String
resp.verified_access_trust_provider.oidc_options.client_id #=> String
resp.verified_access_trust_provider.oidc_options.client_secret #=> String
resp.verified_access_trust_provider.oidc_options.scope #=> String
resp.verified_access_trust_provider.device_options.tenant_id #=> String
resp.verified_access_trust_provider.device_options.public_signing_key_url #=> String
resp.verified_access_trust_provider.policy_reference_name #=> String
resp.verified_access_trust_provider.creation_time #=> String
resp.verified_access_trust_provider.last_updated_time #=> String
resp.verified_access_trust_provider.tags #=> Array
resp.verified_access_trust_provider.tags[0].key #=> String
resp.verified_access_trust_provider.tags[0].value #=> String
resp.verified_access_trust_provider.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_trust_provider.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_provider_type (required, String) —

    The type of trust provider.

  • :user_trust_provider_type (String) —

    The type of user-based trust provider. This parameter is required when the provider type is ‘user`.

  • :device_trust_provider_type (String) —

    The type of device-based trust provider. This parameter is required when the provider type is ‘device`.

  • :oidc_options (Types::CreateVerifiedAccessTrustProviderOidcOptions) —

    The options for a OpenID Connect-compatible user-identity trust provider. This parameter is required when the provider type is ‘user`.

  • :device_options (Types::CreateVerifiedAccessTrustProviderDeviceOptions) —

    The options for a device-based trust provider. This parameter is required when the provider type is ‘device`.

  • :policy_reference_name (required, String) —

    The identifier to be used when working with policy rules.

  • :description (String) —

    A description for the Verified Access trust provider.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the Verified Access trust provider.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :sse_specification (Types::VerifiedAccessSseSpecificationRequest) —

    The options for server side encryption.

Returns:

See Also:



14440
14441
14442
14443
 
# File 'lib/aws-sdk-ec2/client.rb', line 14440

def create_verified_access_trust_provider(params = {}, options = {})
  req = build_request(:create_verified_access_trust_provider, params)
  req.send_request(options)
end

#create_volume(params = {}) ⇒ Types::Volume

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][2

in the *Amazon EC2 User Guide*.

For more information, see [Create an Amazon EBS volume] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html [3]: docs.aws.amazon.com/ebs/latest/userguide/ebs-creating-volume.html

Examples:

Example: To create a new volume


# This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.

resp = client.create_volume({
  availability_zone: "us-east-1a", 
  size: 80, 
  volume_type: "gp2", 
})

resp.to_h outputs the following:
{
  availability_zone: "us-east-1a", 
  create_time: Time.parse("2016-08-29T18:52:32.724Z"), 
  encrypted: false, 
  iops: 240, 
  size: 80, 
  snapshot_id: "", 
  state: "creating", 
  volume_id: "vol-6b60b7c7", 
  volume_type: "gp2", 
}

Example: 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``.

resp = client.create_volume({
  availability_zone: "us-east-1a", 
  iops: 1000, 
  snapshot_id: "snap-066877671789bd71b", 
  volume_type: "io1", 
})

resp.to_h outputs the following:
{
  attachments: [
  ], 
  availability_zone: "us-east-1a", 
  create_time: Time.parse("2016-08-29T18:52:32.724Z"), 
  iops: 1000, 
  size: 500, 
  snapshot_id: "snap-066877671789bd71b", 
  state: "creating", 
  tags: [
  ], 
  volume_id: "vol-1234567890abcdef0", 
  volume_type: "io1", 
}

Request syntax with placeholder values


resp = client.create_volume({
  availability_zone: "AvailabilityZoneName", # required
  encrypted: false,
  iops: 1,
  kms_key_id: "KmsKeyId",
  outpost_arn: "String",
  size: 1,
  snapshot_id: "SnapshotId",
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  multi_attach_enabled: false,
  throughput: 1,
  client_token: "String",
  dry_run: false,
})

Response structure


resp.outpost_arn #=> String
resp.iops #=> Integer
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.fast_restored #=> Boolean
resp.multi_attach_enabled #=> Boolean
resp.throughput #=> Integer
resp.sse_type #=> String, one of "sse-ebs", "sse-kms", "none"
resp.volume_id #=> String
resp.size #=> Integer
resp.snapshot_id #=> String
resp.availability_zone #=> String
resp.state #=> String, one of "creating", "available", "in-use", "deleting", "deleted", "error"
resp.create_time #=> Time
resp.attachments #=> Array
resp.attachments[0].delete_on_termination #=> Boolean
resp.attachments[0].associated_resource #=> String
resp.attachments[0].instance_owning_service #=> String
resp.attachments[0].volume_id #=> String
resp.attachments[0].instance_id #=> String
resp.attachments[0].device #=> String
resp.attachments[0].state #=> String, one of "attaching", "attached", "detaching", "detached", "busy"
resp.attachments[0].attach_time #=> Time
resp.encrypted #=> Boolean
resp.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :availability_zone (required, 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][1

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

    [1]: docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default [2]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances

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

    [1]: docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html

  • :kms_key_id (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.

  • :outpost_arn (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

  • :snapshot_id (String) —

    The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

  • :volume_type (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`

    [1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the volume during creation.

  • :multi_attach_enabled (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*.

    [1]: docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html [2]: docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



14770
14771
14772
14773
 
# File 'lib/aws-sdk-ec2/client.rb', line 14770

def create_volume(params = {}, options = {})
  req = build_request(:create_volume, params)
  req.send_request(options)
end

#create_vpc(params = {}) ⇒ Types::CreateVpcResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html [3]: docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html [4]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html

Examples:

Example: To create a VPC


# This example creates a VPC with the specified CIDR block.

resp = client.create_vpc({
  cidr_block: "10.0.0.0/16", 
})

resp.to_h outputs the following:
{
  vpc: {
    cidr_block: "10.0.0.0/16", 
    dhcp_options_id: "dopt-7a8b9c2d", 
    instance_tenancy: "default", 
    state: "pending", 
    vpc_id: "vpc-a01106c2", 
  }, 
}

Request syntax with placeholder values


resp = client.create_vpc({
  cidr_block: "String",
  ipv_6_pool: "Ipv6PoolEc2Id",
  ipv_6_cidr_block: "String",
  ipv_4_ipam_pool_id: "IpamPoolId",
  ipv_4_netmask_length: 1,
  ipv_6_ipam_pool_id: "IpamPoolId",
  ipv_6_netmask_length: 1,
  ipv_6_cidr_block_network_border_group: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  instance_tenancy: "default", # accepts default, dedicated, host
  amazon_provided_ipv_6_cidr_block: false,
})

Response structure


resp.vpc.owner_id #=> String
resp.vpc.instance_tenancy #=> String, one of "default", "dedicated", "host"
resp.vpc.ipv_6_cidr_block_association_set #=> Array
resp.vpc.ipv_6_cidr_block_association_set[0].association_id #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.status_message #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].network_border_group #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_pool #=> String
resp.vpc.ipv_6_cidr_block_association_set[0].ipv_6_address_attribute #=> String, one of "public", "private"
resp.vpc.ipv_6_cidr_block_association_set[0].ip_source #=> String, one of "amazon", "byoip", "none"
resp.vpc.cidr_block_association_set #=> Array
resp.vpc.cidr_block_association_set[0].association_id #=> String
resp.vpc.cidr_block_association_set[0].cidr_block #=> String
resp.vpc.cidr_block_association_set[0].cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.vpc.cidr_block_association_set[0].cidr_block_state.status_message #=> String
resp.vpc.is_default #=> Boolean
resp.vpc.tags #=> Array
resp.vpc.tags[0].key #=> String
resp.vpc.tags[0].value #=> String
resp.vpc.vpc_id #=> String
resp.vpc.state #=> String, one of "pending", "available"
resp.vpc.cidr_block #=> String
resp.vpc.dhcp_options_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr_block (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`.

  • :ipv_6_pool (String) —

    The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

  • :ipv_6_cidr_block (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.

  • :ipv_4_ipam_pool_id (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*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

  • :ipv_4_netmask_length (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*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

  • :ipv_6_ipam_pool_id (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*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

  • :ipv_6_netmask_length (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*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

  • :ipv_6_cidr_block_network_border_group (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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the VPC.

  • :dry_run (Boolean) —

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

  • :instance_tenancy (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`

  • :amazon_provided_ipv_6_cidr_block (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.

Returns:

See Also:



14975
14976
14977
14978
 
# File 'lib/aws-sdk-ec2/client.rb', line 14975

def create_vpc(params = {}, options = {})
  req = build_request(:create_vpc, params)
  req.send_request(options)
end

#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResult

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

[1]: docs.aws.amazon.com/vpc/latest/privatelink/

Examples:

Request syntax with placeholder values


resp = client.create_vpc_endpoint({
  dry_run: false,
  vpc_endpoint_type: "Interface", # accepts Interface, Gateway, GatewayLoadBalancer
  vpc_id: "VpcId", # required
  service_name: "String", # required
  policy_document: "String",
  route_table_ids: ["RouteTableId"],
  subnet_ids: ["SubnetId"],
  security_group_ids: ["SecurityGroupId"],
  ip_address_type: "ipv4", # accepts ipv4, dualstack, ipv6
  dns_options: {
    dns_record_ip_type: "ipv4", # accepts ipv4, dualstack, ipv6, service-defined
    private_dns_only_for_inbound_resolver_endpoint: false,
  },
  client_token: "String",
  private_dns_enabled: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  subnet_configurations: [
    {
      subnet_id: "SubnetId",
      ipv_4: "String",
      ipv_6: "String",
    },
  ],
})

Response structure


resp.vpc_endpoint.vpc_endpoint_id #=> String
resp.vpc_endpoint.vpc_endpoint_type #=> String, one of "Interface", "Gateway", "GatewayLoadBalancer"
resp.vpc_endpoint.vpc_id #=> String
resp.vpc_endpoint.service_name #=> String
resp.vpc_endpoint.state #=> String, one of "PendingAcceptance", "Pending", "Available", "Deleting", "Deleted", "Rejected", "Failed", "Expired"
resp.vpc_endpoint.policy_document #=> String
resp.vpc_endpoint.route_table_ids #=> Array
resp.vpc_endpoint.route_table_ids[0] #=> String
resp.vpc_endpoint.subnet_ids #=> Array
resp.vpc_endpoint.subnet_ids[0] #=> String
resp.vpc_endpoint.groups #=> Array
resp.vpc_endpoint.groups[0].group_id #=> String
resp.vpc_endpoint.groups[0].group_name #=> String
resp.vpc_endpoint.ip_address_type #=> String, one of "ipv4", "dualstack", "ipv6"
resp.vpc_endpoint.dns_options.dns_record_ip_type #=> String, one of "ipv4", "dualstack", "ipv6", "service-defined"
resp.vpc_endpoint.dns_options.private_dns_only_for_inbound_resolver_endpoint #=> Boolean
resp.vpc_endpoint.private_dns_enabled #=> Boolean
resp.vpc_endpoint.requester_managed #=> Boolean
resp.vpc_endpoint.network_interface_ids #=> Array
resp.vpc_endpoint.network_interface_ids[0] #=> String
resp.vpc_endpoint.dns_entries #=> Array
resp.vpc_endpoint.dns_entries[0].dns_name #=> String
resp.vpc_endpoint.dns_entries[0].hosted_zone_id #=> String
resp.vpc_endpoint.creation_timestamp #=> Time
resp.vpc_endpoint.tags #=> Array
resp.vpc_endpoint.tags[0].key #=> String
resp.vpc_endpoint.tags[0].value #=> String
resp.vpc_endpoint.owner_id #=> String
resp.vpc_endpoint.last_error.message #=> String
resp.vpc_endpoint.last_error.code #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_endpoint_type (String) —

    The type of endpoint.

    Default: Gateway

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :service_name (required, String) —

    The name of the endpoint service.

  • :policy_document (String) — default: 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.

  • :route_table_ids (Array<String>) — default: Gateway endpoint —

    The route table IDs.

  • :subnet_ids (Array<String>) — default: 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.

  • :security_group_ids (Array<String>) — default: 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.

  • :ip_address_type (String) —

    The IP address type for the endpoint.

  • :dns_options (Types::DnsOptionsSpecification) —

    The DNS options for the endpoint.

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :private_dns_enabled (Boolean) — default: 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`

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to associate with the endpoint.

  • :subnet_configurations (Array<Types::SubnetConfiguration>) —

    The subnet configurations for the endpoint.

Returns:

See Also:



15145
15146
15147
15148
 
# File 'lib/aws-sdk-ec2/client.rb', line 15145

def create_vpc_endpoint(params = {}, options = {})
  req = build_request(:create_vpc_endpoint, params)
  req.send_request(options)
end

#create_vpc_endpoint_connection_notification(params = {}) ⇒ Types::CreateVpcEndpointConnectionNotificationResult

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.

[1]: docs.aws.amazon.com/sns/latest/dg/CreateTopic.html

Examples:

Request syntax with placeholder values


resp = client.create_vpc_endpoint_connection_notification({
  dry_run: false,
  service_id: "VpcEndpointServiceId",
  vpc_endpoint_id: "VpcEndpointId",
  connection_notification_arn: "String", # required
  connection_events: ["String"], # required
  client_token: "String",
})

Response structure


resp.connection_notification.connection_notification_id #=> String
resp.connection_notification.service_id #=> String
resp.connection_notification.vpc_endpoint_id #=> String
resp.connection_notification.connection_notification_type #=> String, one of "Topic"
resp.connection_notification.connection_notification_arn #=> String
resp.connection_notification.connection_events #=> Array
resp.connection_notification.connection_events[0] #=> String
resp.connection_notification.connection_notification_state #=> String, one of "Enabled", "Disabled"
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_id (String) —

    The ID of the endpoint service.

  • :vpc_endpoint_id (String) —

    The ID of the endpoint.

  • :connection_notification_arn (required, String) —

    The ARN of the SNS topic for the notifications.

  • :connection_events (required, Array<String>) —

    The endpoint events for which to receive notifications. Valid values are ‘Accept`, `Connect`, `Delete`, and `Reject`.

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



15222
15223
15224
15225
 
# File 'lib/aws-sdk-ec2/client.rb', line 15222

def create_vpc_endpoint_connection_notification(params = {}, options = {})
  req = build_request(:create_vpc_endpoint_connection_notification, params)
  req.send_request(options)
end

#create_vpc_endpoint_service_configuration(params = {}) ⇒ Types::CreateVpcEndpointServiceConfigurationResult

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:

  • A [Network Load Balancer]. Service consumers connect to your service using an interface endpoint.

  • A [Gateway Load Balancer]. Service consumers connect to your service using a Gateway Load Balancer endpoint.

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

[1]: docs.aws.amazon.com/elasticloadbalancing/latest/network/ [2]: docs.aws.amazon.com/elasticloadbalancing/latest/gateway/ [3]: docs.aws.amazon.com/vpc/latest/privatelink/

Examples:

Request syntax with placeholder values


resp = client.create_vpc_endpoint_service_configuration({
  dry_run: false,
  acceptance_required: false,
  private_dns_name: "String",
  network_load_balancer_arns: ["String"],
  gateway_load_balancer_arns: ["String"],
  supported_ip_address_types: ["String"],
  client_token: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.service_configuration.service_type #=> Array
resp.service_configuration.service_type[0].service_type #=> String, one of "Interface", "Gateway", "GatewayLoadBalancer"
resp.service_configuration.service_id #=> String
resp.service_configuration.service_name #=> String
resp.service_configuration.service_state #=> String, one of "Pending", "Available", "Deleting", "Deleted", "Failed"
resp.service_configuration.availability_zones #=> Array
resp.service_configuration.availability_zones[0] #=> String
resp.service_configuration.acceptance_required #=> Boolean
resp.service_configuration.manages_vpc_endpoints #=> Boolean
resp.service_configuration.network_load_balancer_arns #=> Array
resp.service_configuration.network_load_balancer_arns[0] #=> String
resp.service_configuration.gateway_load_balancer_arns #=> Array
resp.service_configuration.gateway_load_balancer_arns[0] #=> String
resp.service_configuration.supported_ip_address_types #=> Array
resp.service_configuration.supported_ip_address_types[0] #=> String, one of "ipv4", "ipv6"
resp.service_configuration.base_endpoint_dns_names #=> Array
resp.service_configuration.base_endpoint_dns_names[0] #=> String
resp.service_configuration.private_dns_name #=> String
resp.service_configuration.private_dns_name_configuration.state #=> String, one of "pendingVerification", "verified", "failed"
resp.service_configuration.private_dns_name_configuration.type #=> String
resp.service_configuration.private_dns_name_configuration.value #=> String
resp.service_configuration.private_dns_name_configuration.name #=> String
resp.service_configuration.payer_responsibility #=> String, one of "ServiceOwner"
resp.service_configuration.tags #=> Array
resp.service_configuration.tags[0].key #=> String
resp.service_configuration.tags[0].value #=> String
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :acceptance_required (Boolean) —

    Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.

  • :private_dns_name (String) — default: Interface endpoint configuration —

    The private DNS name to assign to the VPC endpoint service.

  • :network_load_balancer_arns (Array<String>) —

    The Amazon Resource Names (ARNs) of the Network Load Balancers.

  • :gateway_load_balancer_arns (Array<String>) —

    The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

  • :supported_ip_address_types (Array<String>) —

    The supported IP address types. The possible values are ‘ipv4` and `ipv6`.

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to associate with the service.

Returns:

See Also:



15349
15350
15351
15352
 
# File 'lib/aws-sdk-ec2/client.rb', line 15349

def create_vpc_endpoint_service_configuration(params = {}, options = {})
  req = build_request(:create_vpc_endpoint_service_configuration, params)
  req.send_request(options)
end

#create_vpc_peering_connection(params = {}) ⇒ Types::CreateVpcPeeringConnectionResult

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 markdown=“1”> Limitations and rules apply to a VPC peering connection. For more information, see the [VPC peering limitations] in the *VPC Peering Guide*.

</note>

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

[1]: docs.aws.amazon.com/vpc/latest/peering/vpc-peering-basics.html#vpc-peering-limitations

Examples:

Request syntax with placeholder values


resp = client.create_vpc_peering_connection({
  peer_region: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  vpc_id: "VpcId", # required
  peer_vpc_id: "String",
  peer_owner_id: "String",
})

Response structure


resp.vpc_peering_connection.accepter_vpc_info.cidr_block #=> String
resp.vpc_peering_connection.accepter_vpc_info.ipv_6_cidr_block_set #=> Array
resp.vpc_peering_connection.accepter_vpc_info.ipv_6_cidr_block_set[0].ipv_6_cidr_block #=> String
resp.vpc_peering_connection.accepter_vpc_info.cidr_block_set #=> Array
resp.vpc_peering_connection.accepter_vpc_info.cidr_block_set[0].cidr_block #=> String
resp.vpc_peering_connection.accepter_vpc_info.owner_id #=> String
resp.vpc_peering_connection.accepter_vpc_info.peering_options.allow_dns_resolution_from_remote_vpc #=> Boolean
resp.vpc_peering_connection.accepter_vpc_info.peering_options.allow_egress_from_local_classic_link_to_remote_vpc #=> Boolean
resp.vpc_peering_connection.accepter_vpc_info.peering_options.allow_egress_from_local_vpc_to_remote_classic_link #=> Boolean
resp.vpc_peering_connection.accepter_vpc_info.vpc_id #=> String
resp.vpc_peering_connection.accepter_vpc_info.region #=> String
resp.vpc_peering_connection.expiration_time #=> Time
resp.vpc_peering_connection.requester_vpc_info.cidr_block #=> String
resp.vpc_peering_connection.requester_vpc_info.ipv_6_cidr_block_set #=> Array
resp.vpc_peering_connection.requester_vpc_info.ipv_6_cidr_block_set[0].ipv_6_cidr_block #=> String
resp.vpc_peering_connection.requester_vpc_info.cidr_block_set #=> Array
resp.vpc_peering_connection.requester_vpc_info.cidr_block_set[0].cidr_block #=> String
resp.vpc_peering_connection.requester_vpc_info.owner_id #=> String
resp.vpc_peering_connection.requester_vpc_info.peering_options.allow_dns_resolution_from_remote_vpc #=> Boolean
resp.vpc_peering_connection.requester_vpc_info.peering_options.allow_egress_from_local_classic_link_to_remote_vpc #=> Boolean
resp.vpc_peering_connection.requester_vpc_info.peering_options.allow_egress_from_local_vpc_to_remote_classic_link #=> Boolean
resp.vpc_peering_connection.requester_vpc_info.vpc_id #=> String
resp.vpc_peering_connection.requester_vpc_info.region #=> String
resp.vpc_peering_connection.status.code #=> String, one of "initiating-request", "pending-acceptance", "active", "deleted", "rejected", "failed", "expired", "provisioning", "deleting"
resp.vpc_peering_connection.status.message #=> String
resp.vpc_peering_connection.tags #=> Array
resp.vpc_peering_connection.tags[0].key #=> String
resp.vpc_peering_connection.tags[0].value #=> String
resp.vpc_peering_connection.vpc_peering_connection_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :peer_region (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.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to assign to the peering connection.

  • :dry_run (Boolean) —

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

  • :vpc_id (required, String) —

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

  • :peer_vpc_id (String) —

    The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.

  • :peer_owner_id (String) —

    The Amazon Web Services account ID of the owner of the accepter VPC.

    Default: Your Amazon Web Services account ID

Returns:

See Also:



15467
15468
15469
15470
 
# File 'lib/aws-sdk-ec2/client.rb', line 15467

def create_vpc_peering_connection(params = {}, options = {})
  req = build_request(:create_vpc_peering_connection, params)
  req.send_request(options)
end

#create_vpn_connection(params = {}) ⇒ Types::CreateVpnConnectionResult

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

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html

Examples:

Request syntax with placeholder values


resp = client.create_vpn_connection({
  customer_gateway_id: "CustomerGatewayId", # required
  type: "String", # required
  vpn_gateway_id: "VpnGatewayId",
  transit_gateway_id: "TransitGatewayId",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  options: {
    enable_acceleration: false,
    tunnel_inside_ip_version: "ipv4", # accepts ipv4, ipv6
    tunnel_options: [
      {
        tunnel_inside_cidr: "String",
        tunnel_inside_ipv_6_cidr: "String",
        pre_shared_key: "preSharedKey",
        phase_1_lifetime_seconds: 1,
        phase_2_lifetime_seconds: 1,
        rekey_margin_time_seconds: 1,
        rekey_fuzz_percentage: 1,
        replay_window_size: 1,
        dpd_timeout_seconds: 1,
        dpd_timeout_action: "String",
        phase_1_encryption_algorithms: [
          {
            value: "String",
          },
        ],
        phase_2_encryption_algorithms: [
          {
            value: "String",
          },
        ],
        phase_1_integrity_algorithms: [
          {
            value: "String",
          },
        ],
        phase_2_integrity_algorithms: [
          {
            value: "String",
          },
        ],
        phase_1_dh_group_numbers: [
          {
            value: 1,
          },
        ],
        phase_2_dh_group_numbers: [
          {
            value: 1,
          },
        ],
        ike_versions: [
          {
            value: "String",
          },
        ],
        startup_action: "String",
        log_options: {
          cloud_watch_log_options: {
            log_enabled: false,
            log_group_arn: "CloudWatchLogGroupArn",
            log_output_format: "String",
          },
        },
        enable_tunnel_lifecycle_control: false,
      },
    ],
    local_ipv_4_network_cidr: "String",
    remote_ipv_4_network_cidr: "String",
    local_ipv_6_network_cidr: "String",
    remote_ipv_6_network_cidr: "String",
    outside_ip_address_type: "String",
    transport_transit_gateway_attachment_id: "TransitGatewayAttachmentId",
    static_routes_only: false,
  },
})

Response structure


resp.vpn_connection.category #=> String
resp.vpn_connection.transit_gateway_id #=> String
resp.vpn_connection.core_network_arn #=> String
resp.vpn_connection.core_network_attachment_arn #=> String
resp.vpn_connection.gateway_association_state #=> String, one of "associated", "not-associated", "associating", "disassociating"
resp.vpn_connection.options.enable_acceleration #=> Boolean
resp.vpn_connection.options.static_routes_only #=> Boolean
resp.vpn_connection.options.local_ipv_4_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_4_network_cidr #=> String
resp.vpn_connection.options.local_ipv_6_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_6_network_cidr #=> String
resp.vpn_connection.options.outside_ip_address_type #=> String
resp.vpn_connection.options.transport_transit_gateway_attachment_id #=> String
resp.vpn_connection.options.tunnel_inside_ip_version #=> String, one of "ipv4", "ipv6"
resp.vpn_connection.options.tunnel_options #=> Array
resp.vpn_connection.options.tunnel_options[0].outside_ip_address #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_ipv_6_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].pre_shared_key #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_margin_time_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_fuzz_percentage #=> Integer
resp.vpn_connection.options.tunnel_options[0].replay_window_size #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_action #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].ike_versions #=> Array
resp.vpn_connection.options.tunnel_options[0].ike_versions[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].startup_action #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_enabled #=> Boolean
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_group_arn #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_output_format #=> String
resp.vpn_connection.options.tunnel_options[0].enable_tunnel_lifecycle_control #=> Boolean
resp.vpn_connection.routes #=> Array
resp.vpn_connection.routes[0].destination_cidr_block #=> String
resp.vpn_connection.routes[0].source #=> String, one of "Static"
resp.vpn_connection.routes[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.tags #=> Array
resp.vpn_connection.tags[0].key #=> String
resp.vpn_connection.tags[0].value #=> String
resp.vpn_connection.vgw_telemetry #=> Array
resp.vpn_connection.vgw_telemetry[0].accepted_route_count #=> Integer
resp.vpn_connection.vgw_telemetry[0].last_status_change #=> Time
resp.vpn_connection.vgw_telemetry[0].outside_ip_address #=> String
resp.vpn_connection.vgw_telemetry[0].status #=> String, one of "UP", "DOWN"
resp.vpn_connection.vgw_telemetry[0].status_message #=> String
resp.vpn_connection.vgw_telemetry[0].certificate_arn #=> String
resp.vpn_connection.vpn_connection_id #=> String
resp.vpn_connection.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.customer_gateway_configuration #=> String
resp.vpn_connection.type #=> String, one of "ipsec.1"
resp.vpn_connection.customer_gateway_id #=> String
resp.vpn_connection.vpn_gateway_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :customer_gateway_id (required, String) —

    The ID of the customer gateway.

  • :type (required, String) —

    The type of VPN connection (‘ipsec.1`).

  • :vpn_gateway_id (String) —

    The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

  • :transit_gateway_id (String) —

    The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the VPN connection.

  • :dry_run (Boolean) —

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

    The options for the VPN connection.

Returns:

See Also:



15689
15690
15691
15692
 
# File 'lib/aws-sdk-ec2/client.rb', line 15689

def create_vpn_connection(params = {}, options = {})
  req = build_request(:create_vpn_connection, params)
  req.send_request(options)
end

#create_vpn_connection_route(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html

Examples:

Request syntax with placeholder values


resp = client.create_vpn_connection_route({
  destination_cidr_block: "String", # required
  vpn_connection_id: "VpnConnectionId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_cidr_block (required, String) —

    The CIDR block associated with the local subnet of the customer network.

  • :vpn_connection_id (required, String) —

    The ID of the VPN connection.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



15726
15727
15728
15729
 
# File 'lib/aws-sdk-ec2/client.rb', line 15726

def create_vpn_connection_route(params = {}, options = {})
  req = build_request(:create_vpn_connection_route, params)
  req.send_request(options)
end

#create_vpn_gateway(params = {}) ⇒ Types::CreateVpnGatewayResult

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

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html

Examples:

Request syntax with placeholder values


resp = client.create_vpn_gateway({
  availability_zone: "String",
  type: "ipsec.1", # required, accepts ipsec.1
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  amazon_side_asn: 1,
  dry_run: false,
})

Response structure


resp.vpn_gateway.amazon_side_asn #=> Integer
resp.vpn_gateway.tags #=> Array
resp.vpn_gateway.tags[0].key #=> String
resp.vpn_gateway.tags[0].value #=> String
resp.vpn_gateway.vpn_gateway_id #=> String
resp.vpn_gateway.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_gateway.type #=> String, one of "ipsec.1"
resp.vpn_gateway.availability_zone #=> String
resp.vpn_gateway.vpc_attachments #=> Array
resp.vpn_gateway.vpc_attachments[0].vpc_id #=> String
resp.vpn_gateway.vpc_attachments[0].state #=> String, one of "attaching", "attached", "detaching", "detached"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :availability_zone (String) —

    The Availability Zone for the virtual private gateway.

  • :type (required, String) —

    The type of VPN connection this virtual private gateway supports.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the virtual private gateway.

  • :amazon_side_asn (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

  • :dry_run (Boolean) —

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

Returns:

See Also:



15807
15808
15809
15810
 
# File 'lib/aws-sdk-ec2/client.rb', line 15807

def create_vpn_gateway(params = {}, options = {})
  req = build_request(:create_vpn_gateway, params)
  req.send_request(options)
end

#delete_carrier_gateway(params = {}) ⇒ Types::DeleteCarrierGatewayResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteRoute.html

Examples:

Request syntax with placeholder values


resp = client.delete_carrier_gateway({
  carrier_gateway_id: "CarrierGatewayId", # required
  dry_run: false,
})

Response structure


resp.carrier_gateway.carrier_gateway_id #=> String
resp.carrier_gateway.vpc_id #=> String
resp.carrier_gateway.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.carrier_gateway.owner_id #=> String
resp.carrier_gateway.tags #=> Array
resp.carrier_gateway.tags[0].key #=> String
resp.carrier_gateway.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :carrier_gateway_id (required, String) —

    The ID of the carrier gateway.

  • :dry_run (Boolean) —

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

Returns:

See Also:



15856
15857
15858
15859
 
# File 'lib/aws-sdk-ec2/client.rb', line 15856

def delete_carrier_gateway(params = {}, options = {})
  req = build_request(:delete_carrier_gateway, params)
  req.send_request(options)
end

#delete_client_vpn_endpoint(params = {}) ⇒ Types::DeleteClientVpnEndpointResult

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.

Examples:

Request syntax with placeholder values


resp = client.delete_client_vpn_endpoint({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  dry_run: false,
})

Response structure


resp.status.code #=> String, one of "pending-associate", "available", "deleting", "deleted"
resp.status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN to be deleted.

  • :dry_run (Boolean) —

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

Returns:

See Also:



15893
15894
15895
15896
 
# File 'lib/aws-sdk-ec2/client.rb', line 15893

def delete_client_vpn_endpoint(params = {}, options = {})
  req = build_request(:delete_client_vpn_endpoint, params)
  req.send_request(options)
end

#delete_client_vpn_route(params = {}) ⇒ Types::DeleteClientVpnRouteResult

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.

Examples:

Request syntax with placeholder values


resp = client.delete_client_vpn_route({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  target_vpc_subnet_id: "SubnetId",
  destination_cidr_block: "String", # required
  dry_run: false,
})

Response structure


resp.status.code #=> String, one of "creating", "active", "failed", "deleting"
resp.status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint from which the route is to be deleted.

  • :target_vpc_subnet_id (String) —

    The ID of the target subnet used by the route.

  • :destination_cidr_block (required, String) —

    The IPv4 address range, in CIDR notation, of the route to be deleted.

  • :dry_run (Boolean) —

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

Returns:

See Also:



15942
15943
15944
15945
 
# File 'lib/aws-sdk-ec2/client.rb', line 15942

def delete_client_vpn_route(params = {}, options = {})
  req = build_request(:delete_client_vpn_route, params)
  req.send_request(options)
end

#delete_coip_cidr(params = {}) ⇒ Types::DeleteCoipCidrResult

Deletes a range of customer-owned IP addresses.

Examples:

Request syntax with placeholder values


resp = client.delete_coip_cidr({
  cidr: "String", # required
  coip_pool_id: "Ipv4PoolCoipId", # required
  dry_run: false,
})

Response structure


resp.coip_cidr.cidr #=> String
resp.coip_cidr.coip_pool_id #=> String
resp.coip_cidr.local_gateway_route_table_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr (required, String) —

    A customer-owned IP address range that you want to delete.

  • :coip_pool_id (required, String) —

    The ID of the customer-owned address pool.

  • :dry_run (Boolean) —

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

Returns:

See Also:



15983
15984
15985
15986
 
# File 'lib/aws-sdk-ec2/client.rb', line 15983

def delete_coip_cidr(params = {}, options = {})
  req = build_request(:delete_coip_cidr, params)
  req.send_request(options)
end

#delete_coip_pool(params = {}) ⇒ Types::DeleteCoipPoolResult

Deletes a pool of customer-owned IP (CoIP) addresses.

Examples:

Request syntax with placeholder values


resp = client.delete_coip_pool({
  coip_pool_id: "Ipv4PoolCoipId", # required
  dry_run: false,
})

Response structure


resp.coip_pool.pool_id #=> String
resp.coip_pool.pool_cidrs #=> Array
resp.coip_pool.pool_cidrs[0] #=> String
resp.coip_pool.local_gateway_route_table_id #=> String
resp.coip_pool.tags #=> Array
resp.coip_pool.tags[0].key #=> String
resp.coip_pool.tags[0].value #=> String
resp.coip_pool.pool_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :coip_pool_id (required, String) —

    The ID of the CoIP pool that you want to delete.

  • :dry_run (Boolean) —

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

Returns:

See Also:



16025
16026
16027
16028
 
# File 'lib/aws-sdk-ec2/client.rb', line 16025

def delete_coip_pool(params = {}, options = {})
  req = build_request(:delete_coip_pool, params)
  req.send_request(options)
end

#delete_customer_gateway(params = {}) ⇒ Struct

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

Examples:

Example: To delete a customer gateway


# This example deletes the specified customer gateway.

resp = client.delete_customer_gateway({
  customer_gateway_id: "cgw-0e11f167", 
})

Request syntax with placeholder values


resp = client.delete_customer_gateway({
  customer_gateway_id: "CustomerGatewayId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :customer_gateway_id (required, String) —

    The ID of the customer gateway.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



16064
16065
16066
16067
 
# File 'lib/aws-sdk-ec2/client.rb', line 16064

def delete_customer_gateway(params = {}, options = {})
  req = build_request(:delete_customer_gateway, params)
  req.send_request(options)
end

#delete_dhcp_options(params = {}) ⇒ Struct

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.

Examples:

Example: To delete a DHCP options set


# This example deletes the specified DHCP options set.

resp = client.delete_dhcp_options({
  dhcp_options_id: "dopt-d9070ebb", 
})

Request syntax with placeholder values


resp = client.delete_dhcp_options({
  dhcp_options_id: "DhcpOptionsId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dhcp_options_id (required, String) —

    The ID of the DHCP options set.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



16105
16106
16107
16108
 
# File 'lib/aws-sdk-ec2/client.rb', line 16105

def delete_dhcp_options(params = {}, options = {})
  req = build_request(:delete_dhcp_options, params)
  req.send_request(options)
end

#delete_egress_only_internet_gateway(params = {}) ⇒ Types::DeleteEgressOnlyInternetGatewayResult

Deletes an egress-only internet gateway.

Examples:

Request syntax with placeholder values


resp = client.delete_egress_only_internet_gateway({
  dry_run: false,
  egress_only_internet_gateway_id: "EgressOnlyInternetGatewayId", # required
})

Response structure


resp.return_code #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The ID of the egress-only internet gateway.

Returns:

See Also:



16140
16141
16142
16143
 
# File 'lib/aws-sdk-ec2/client.rb', line 16140

def delete_egress_only_internet_gateway(params = {}, options = {})
  req = build_request(:delete_egress_only_internet_gateway, params)
  req.send_request(options)
end

#delete_fleets(params = {}) ⇒ Types::DeleteFleetsResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet

Examples:

Request syntax with placeholder values


resp = client.delete_fleets({
  dry_run: false,
  fleet_ids: ["FleetId"], # required
  terminate_instances: false, # required
})

Response structure


resp.successful_fleet_deletions #=> Array
resp.successful_fleet_deletions[0].current_fleet_state #=> String, one of "submitted", "active", "deleted", "failed", "deleted_running", "deleted_terminating", "modifying"
resp.successful_fleet_deletions[0].previous_fleet_state #=> String, one of "submitted", "active", "deleted", "failed", "deleted_running", "deleted_terminating", "modifying"
resp.successful_fleet_deletions[0].fleet_id #=> String
resp.unsuccessful_fleet_deletions #=> Array
resp.unsuccessful_fleet_deletions[0].error.code #=> String, one of "fleetIdDoesNotExist", "fleetIdMalformed", "fleetNotInDeletableState", "unexpectedError"
resp.unsuccessful_fleet_deletions[0].error.message #=> String
resp.unsuccessful_fleet_deletions[0].fleet_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :fleet_ids (required, 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.

  • :terminate_instances (required, 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.

Returns:

See Also:



16232
16233
16234
16235
 
# File 'lib/aws-sdk-ec2/client.rb', line 16232

def delete_fleets(params = {}, options = {})
  req = build_request(:delete_fleets, params)
  req.send_request(options)
end

#delete_flow_logs(params = {}) ⇒ Types::DeleteFlowLogsResult

Deletes one or more flow logs.

Examples:

Request syntax with placeholder values


resp = client.delete_flow_logs({
  dry_run: false,
  flow_log_ids: ["VpcFlowLogId"], # required
})

Response structure


resp.unsuccessful #=> Array
resp.unsuccessful[0].error.code #=> String
resp.unsuccessful[0].error.message #=> String
resp.unsuccessful[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :flow_log_ids (required, Array<String>) —

    One or more flow log IDs.

    Constraint: Maximum of 1000 flow log IDs.

Returns:

See Also:



16272
16273
16274
16275
 
# File 'lib/aws-sdk-ec2/client.rb', line 16272

def delete_flow_logs(params = {}, options = {})
  req = build_request(:delete_flow_logs, params)
  req.send_request(options)
end

#delete_fpga_image(params = {}) ⇒ Types::DeleteFpgaImageResult

Deletes the specified Amazon FPGA Image (AFI).

Examples:

Request syntax with placeholder values


resp = client.delete_fpga_image({
  dry_run: false,
  fpga_image_id: "FpgaImageId", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :fpga_image_id (required, String) —

    The ID of the AFI.

Returns:

See Also:



16307
16308
16309
16310
 
# File 'lib/aws-sdk-ec2/client.rb', line 16307

def delete_fpga_image(params = {}, options = {})
  req = build_request(:delete_fpga_image, params)
  req.send_request(options)
end

#delete_instance_connect_endpoint(params = {}) ⇒ Types::DeleteInstanceConnectEndpointResult

Deletes the specified EC2 Instance Connect Endpoint.

Examples:

Request syntax with placeholder values


resp = client.delete_instance_connect_endpoint({
  dry_run: false,
  instance_connect_endpoint_id: "InstanceConnectEndpointId", # required
})

Response structure


resp.instance_connect_endpoint.owner_id #=> String
resp.instance_connect_endpoint.instance_connect_endpoint_id #=> String
resp.instance_connect_endpoint.instance_connect_endpoint_arn #=> String
resp.instance_connect_endpoint.state #=> String, one of "create-in-progress", "create-complete", "create-failed", "delete-in-progress", "delete-complete", "delete-failed"
resp.instance_connect_endpoint.state_message #=> String
resp.instance_connect_endpoint.dns_name #=> String
resp.instance_connect_endpoint.fips_dns_name #=> String
resp.instance_connect_endpoint.network_interface_ids #=> Array
resp.instance_connect_endpoint.network_interface_ids[0] #=> String
resp.instance_connect_endpoint.vpc_id #=> String
resp.instance_connect_endpoint.availability_zone #=> String
resp.instance_connect_endpoint.created_at #=> Time
resp.instance_connect_endpoint.subnet_id #=> String
resp.instance_connect_endpoint.preserve_client_ip #=> Boolean
resp.instance_connect_endpoint.security_group_ids #=> Array
resp.instance_connect_endpoint.security_group_ids[0] #=> String
resp.instance_connect_endpoint.tags #=> Array
resp.instance_connect_endpoint.tags[0].key #=> String
resp.instance_connect_endpoint.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_connect_endpoint_id (required, String) —

    The ID of the EC2 Instance Connect Endpoint to delete.

Returns:

See Also:



16360
16361
16362
16363
 
# File 'lib/aws-sdk-ec2/client.rb', line 16360

def delete_instance_connect_endpoint(params = {}, options = {})
  req = build_request(:delete_instance_connect_endpoint, params)
  req.send_request(options)
end

#delete_instance_event_window(params = {}) ⇒ Types::DeleteInstanceEventWindowResult

Deletes the specified event window.

For more information, see [Define event windows for scheduled events] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html

Examples:

Request syntax with placeholder values


resp = client.delete_instance_event_window({
  dry_run: false,
  force_delete: false,
  instance_event_window_id: "InstanceEventWindowId", # required
})

Response structure


resp.instance_event_window_state.instance_event_window_id #=> String
resp.instance_event_window_state.state #=> String, one of "creating", "deleting", "active", "deleted"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :force_delete (Boolean) —

    Specify ‘true` to force delete the event window. Use the force delete parameter if the event window is currently associated with targets.

  • :instance_event_window_id (required, String) —

    The ID of the event window.

Returns:

See Also:



16408
16409
16410
16411
 
# File 'lib/aws-sdk-ec2/client.rb', line 16408

def delete_instance_event_window(params = {}, options = {})
  req = build_request(:delete_instance_event_window, params)
  req.send_request(options)
end

#delete_internet_gateway(params = {}) ⇒ Struct

Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.

Examples:

Example: To delete an Internet gateway


# This example deletes the specified Internet gateway.

resp = client.delete_internet_gateway({
  internet_gateway_id: "igw-c0a643a9", 
})

Request syntax with placeholder values


resp = client.delete_internet_gateway({
  dry_run: false,
  internet_gateway_id: "InternetGatewayId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :internet_gateway_id (required, String) —

    The ID of the internet gateway.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



16447
16448
16449
16450
 
# File 'lib/aws-sdk-ec2/client.rb', line 16447

def delete_internet_gateway(params = {}, options = {})
  req = build_request(:delete_internet_gateway, params)
  req.send_request(options)
end

#delete_ipam(params = {}) ⇒ Types::DeleteIpamResult

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

[1]: docs.aws.amazon.com/vpc/latest/ipam/delete-ipam.html

Examples:

Request syntax with placeholder values


resp = client.delete_ipam({
  dry_run: false,
  ipam_id: "IpamId", # required
  cascade: false,
})

Response structure


resp.ipam.owner_id #=> String
resp.ipam.ipam_id #=> String
resp.ipam.ipam_arn #=> String
resp.ipam.ipam_region #=> String
resp.ipam.public_default_scope_id #=> String
resp.ipam.private_default_scope_id #=> String
resp.ipam.scope_count #=> Integer
resp.ipam.description #=> String
resp.ipam.operating_regions #=> Array
resp.ipam.operating_regions[0].region_name #=> String
resp.ipam.state #=> String, one of "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"
resp.ipam.tags #=> Array
resp.ipam.tags[0].key #=> String
resp.ipam.tags[0].value #=> String
resp.ipam.default_resource_discovery_id #=> String
resp.ipam.default_resource_discovery_association_id #=> String
resp.ipam.resource_discovery_association_count #=> Integer
resp.ipam.state_message #=> String
resp.ipam.tier #=> String, one of "free", "advanced"
resp.ipam.enable_private_gua #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_id (required, 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 markdown=“1”> 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.

      </note>

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

Returns:

See Also:



16534
16535
16536
16537
 
# File 'lib/aws-sdk-ec2/client.rb', line 16534

def delete_ipam(params = {}, options = {})
  req = build_request(:delete_ipam, params)
  req.send_request(options)
end

#delete_ipam_external_resource_verification_token(params = {}) ⇒ Types::DeleteIpamExternalResourceVerificationTokenResult

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

Examples:

Request syntax with placeholder values


resp = client.delete_ipam_external_resource_verification_token({
  dry_run: false,
  ipam_external_resource_verification_token_id: "IpamExternalResourceVerificationTokenId", # required
})

Response structure


resp.ipam_external_resource_verification_token.ipam_external_resource_verification_token_id #=> String
resp.ipam_external_resource_verification_token.ipam_external_resource_verification_token_arn #=> String
resp.ipam_external_resource_verification_token.ipam_id #=> String
resp.ipam_external_resource_verification_token.ipam_arn #=> String
resp.ipam_external_resource_verification_token.ipam_region #=> String
resp.ipam_external_resource_verification_token.token_value #=> String
resp.ipam_external_resource_verification_token.token_name #=> String
resp.ipam_external_resource_verification_token.not_after #=> Time
resp.ipam_external_resource_verification_token.status #=> String, one of "valid", "expired"
resp.ipam_external_resource_verification_token.tags #=> Array
resp.ipam_external_resource_verification_token.tags[0].key #=> String
resp.ipam_external_resource_verification_token.tags[0].value #=> String
resp.ipam_external_resource_verification_token.state #=> String, one of "create-in-progress", "create-complete", "create-failed", "delete-in-progress", "delete-complete", "delete-failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_external_resource_verification_token_id (required, String) —

    The token ID.

Returns:

See Also:



16585
16586
16587
16588
 
# File 'lib/aws-sdk-ec2/client.rb', line 16585

def delete_ipam_external_resource_verification_token(params = {}, options = {})
  req = build_request(:delete_ipam_external_resource_verification_token, params)
  req.send_request(options)
end

#delete_ipam_pool(params = {}) ⇒ Types::DeleteIpamPoolResult

Delete an IPAM pool.

<note markdown=“1”> 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].

</note>

For more information, see [Delete a pool] in the *Amazon VPC IPAM User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html [3]: docs.aws.amazon.com/vpc/latest/ipam/delete-pool-ipam.html

Examples:

Request syntax with placeholder values


resp = client.delete_ipam_pool({
  dry_run: false,
  ipam_pool_id: "IpamPoolId", # required
  cascade: false,
})

Response structure


resp.ipam_pool.owner_id #=> String
resp.ipam_pool.ipam_pool_id #=> String
resp.ipam_pool.source_ipam_pool_id #=> String
resp.ipam_pool.ipam_pool_arn #=> String
resp.ipam_pool.ipam_scope_arn #=> String
resp.ipam_pool.ipam_scope_type #=> String, one of "public", "private"
resp.ipam_pool.ipam_arn #=> String
resp.ipam_pool.ipam_region #=> String
resp.ipam_pool.locale #=> String
resp.ipam_pool.pool_depth #=> Integer
resp.ipam_pool.state #=> String, one of "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"
resp.ipam_pool.state_message #=> String
resp.ipam_pool.description #=> String
resp.ipam_pool.auto_import #=> Boolean
resp.ipam_pool.publicly_advertisable #=> Boolean
resp.ipam_pool.address_family #=> String, one of "ipv4", "ipv6"
resp.ipam_pool.allocation_min_netmask_length #=> Integer
resp.ipam_pool.allocation_max_netmask_length #=> Integer
resp.ipam_pool.allocation_default_netmask_length #=> Integer
resp.ipam_pool.allocation_resource_tags #=> Array
resp.ipam_pool.allocation_resource_tags[0].key #=> String
resp.ipam_pool.allocation_resource_tags[0].value #=> String
resp.ipam_pool.tags #=> Array
resp.ipam_pool.tags[0].key #=> String
resp.ipam_pool.tags[0].value #=> String
resp.ipam_pool.aws_service #=> String, one of "ec2"
resp.ipam_pool.public_ip_source #=> String, one of "amazon", "byoip"
resp.ipam_pool.source_resource.resource_id #=> String
resp.ipam_pool.source_resource.resource_type #=> String, one of "vpc"
resp.ipam_pool.source_resource.resource_region #=> String
resp.ipam_pool.source_resource.resource_owner #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_pool_id (required, 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.

Returns:

See Also:



16675
16676
16677
16678
 
# File 'lib/aws-sdk-ec2/client.rb', line 16675

def delete_ipam_pool(params = {}, options = {})
  req = build_request(:delete_ipam_pool, params)
  req.send_request(options)
end

#delete_ipam_resource_discovery(params = {}) ⇒ Types::DeleteIpamResourceDiscoveryResult

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.

Examples:

Request syntax with placeholder values


resp = client.delete_ipam_resource_discovery({
  dry_run: false,
  ipam_resource_discovery_id: "IpamResourceDiscoveryId", # required
})

Response structure


resp.ipam_resource_discovery.owner_id #=> String
resp.ipam_resource_discovery.ipam_resource_discovery_id #=> String
resp.ipam_resource_discovery.ipam_resource_discovery_arn #=> String
resp.ipam_resource_discovery.ipam_resource_discovery_region #=> String
resp.ipam_resource_discovery.description #=> String
resp.ipam_resource_discovery.operating_regions #=> Array
resp.ipam_resource_discovery.operating_regions[0].region_name #=> String
resp.ipam_resource_discovery.is_default #=> Boolean
resp.ipam_resource_discovery.state #=> String, one of "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"
resp.ipam_resource_discovery.tags #=> Array
resp.ipam_resource_discovery.tags[0].key #=> String
resp.ipam_resource_discovery.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_resource_discovery_id (required, String) —

    The IPAM resource discovery ID.

Returns:

See Also:



16723
16724
16725
16726
 
# File 'lib/aws-sdk-ec2/client.rb', line 16723

def delete_ipam_resource_discovery(params = {}, options = {})
  req = build_request(:delete_ipam_resource_discovery, params)
  req.send_request(options)
end

#delete_ipam_scope(params = {}) ⇒ Types::DeleteIpamScopeResult

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

[1]: docs.aws.amazon.com/vpc/latest/ipam/delete-scope-ipam.html

Examples:

Request syntax with placeholder values


resp = client.delete_ipam_scope({
  dry_run: false,
  ipam_scope_id: "IpamScopeId", # required
})

Response structure


resp.ipam_scope.owner_id #=> String
resp.ipam_scope.ipam_scope_id #=> String
resp.ipam_scope.ipam_scope_arn #=> String
resp.ipam_scope.ipam_arn #=> String
resp.ipam_scope.ipam_region #=> String
resp.ipam_scope.ipam_scope_type #=> String, one of "public", "private"
resp.ipam_scope.is_default #=> Boolean
resp.ipam_scope.description #=> String
resp.ipam_scope.pool_count #=> Integer
resp.ipam_scope.state #=> String, one of "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"
resp.ipam_scope.tags #=> Array
resp.ipam_scope.tags[0].key #=> String
resp.ipam_scope.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_scope_id (required, String) —

    The ID of the scope to delete.

Returns:

See Also:



16777
16778
16779
16780
 
# File 'lib/aws-sdk-ec2/client.rb', line 16777

def delete_ipam_scope(params = {}, options = {})
  req = build_request(:delete_ipam_scope, params)
  req.send_request(options)
end

#delete_key_pair(params = {}) ⇒ Types::DeleteKeyPairResult

Deletes the specified key pair, by removing the public key from Amazon EC2.

Examples:

Example: To delete a key pair


# This example deletes the specified key pair.

resp = client.delete_key_pair({
  key_name: "my-key-pair", 
})

Request syntax with placeholder values


resp = client.delete_key_pair({
  key_name: "KeyPairNameWithResolver",
  key_pair_id: "KeyPairId",
  dry_run: false,
})

Response structure


resp.return #=> Boolean
resp.key_pair_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_name (String) —

    The name of the key pair.

  • :key_pair_id (String) —

    The ID of the key pair.

  • :dry_run (Boolean) —

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

Returns:

See Also:



16828
16829
16830
16831
 
# File 'lib/aws-sdk-ec2/client.rb', line 16828

def delete_key_pair(params = {}, options = {})
  req = build_request(:delete_key_pair, params)
  req.send_request(options)
end

#delete_launch_template(params = {}) ⇒ Types::DeleteLaunchTemplateResult

Deletes a launch template. Deleting a launch template deletes all of its versions.

Examples:

Example: To delete a launch template


# This example deletes the specified launch template.

resp = client.delete_launch_template({
  launch_template_id: "lt-0abcd290751193123", 
})

resp.to_h outputs the following:
{
  launch_template: {
    create_time: Time.parse("2017-11-23T16:46:25.000Z"), 
    created_by: "arn:aws:iam::123456789012:root", 
    default_version_number: 2, 
    latest_version_number: 2, 
    launch_template_id: "lt-0abcd290751193123", 
    launch_template_name: "my-template", 
  }, 
}

Request syntax with placeholder values


resp = client.delete_launch_template({
  dry_run: false,
  launch_template_id: "LaunchTemplateId",
  launch_template_name: "LaunchTemplateName",
})

Response structure


resp.launch_template.launch_template_id #=> String
resp.launch_template.launch_template_name #=> String
resp.launch_template.create_time #=> Time
resp.launch_template.created_by #=> String
resp.launch_template.default_version_number #=> Integer
resp.launch_template.latest_version_number #=> Integer
resp.launch_template.tags #=> Array
resp.launch_template.tags[0].key #=> String
resp.launch_template.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :launch_template_id (String) —

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name, but not both.

  • :launch_template_name (String) —

    The name of the launch template.

    You must specify either the launch template ID or the launch template name, but not both.

Returns:

See Also:



16903
16904
16905
16906
 
# File 'lib/aws-sdk-ec2/client.rb', line 16903

def delete_launch_template(params = {}, options = {})
  req = build_request(:delete_launch_template, params)
  req.send_request(options)
end

#delete_launch_template_versions(params = {}) ⇒ Types::DeleteLaunchTemplateVersionsResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-launch-template-versions.html#delete-launch-template-version

Examples:

Example: To delete a launch template version


# This example deletes the specified launch template version.

resp = client.delete_launch_template_versions({
  launch_template_id: "lt-0abcd290751193123", 
  versions: [
    "1", 
  ], 
})

resp.to_h outputs the following:
{
  successfully_deleted_launch_template_versions: [
    {
      launch_template_id: "lt-0abcd290751193123", 
      launch_template_name: "my-template", 
      version_number: 1, 
    }, 
  ], 
  unsuccessfully_deleted_launch_template_versions: [
  ], 
}

Request syntax with placeholder values


resp = client.delete_launch_template_versions({
  dry_run: false,
  launch_template_id: "LaunchTemplateId",
  launch_template_name: "LaunchTemplateName",
  versions: ["String"], # required
})

Response structure


resp.successfully_deleted_launch_template_versions #=> Array
resp.successfully_deleted_launch_template_versions[0].launch_template_id #=> String
resp.successfully_deleted_launch_template_versions[0].launch_template_name #=> String
resp.successfully_deleted_launch_template_versions[0].version_number #=> Integer
resp.unsuccessfully_deleted_launch_template_versions #=> Array
resp.unsuccessfully_deleted_launch_template_versions[0].launch_template_id #=> String
resp.unsuccessfully_deleted_launch_template_versions[0].launch_template_name #=> String
resp.unsuccessfully_deleted_launch_template_versions[0].version_number #=> Integer
resp.unsuccessfully_deleted_launch_template_versions[0].response_error.code #=> String, one of "launchTemplateIdDoesNotExist", "launchTemplateIdMalformed", "launchTemplateNameDoesNotExist", "launchTemplateNameMalformed", "launchTemplateVersionDoesNotExist", "unexpectedError"
resp.unsuccessfully_deleted_launch_template_versions[0].response_error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :launch_template_id (String) —

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name, but not both.

  • :launch_template_name (String) —

    The name of the launch template.

    You must specify either the launch template ID or the launch template name, but not both.

  • :versions (required, Array<String>) —

    The version numbers of one or more launch template versions to delete. You can specify up to 200 launch template version numbers.

Returns:

See Also:



17005
17006
17007
17008
 
# File 'lib/aws-sdk-ec2/client.rb', line 17005

def delete_launch_template_versions(params = {}, options = {})
  req = build_request(:delete_launch_template_versions, params)
  req.send_request(options)
end

#delete_local_gateway_route(params = {}) ⇒ Types::DeleteLocalGatewayRouteResult

Deletes the specified route from the specified local gateway route table.

Examples:

Request syntax with placeholder values


resp = client.delete_local_gateway_route({
  destination_cidr_block: "String",
  local_gateway_route_table_id: "LocalGatewayRoutetableId", # required
  dry_run: false,
  destination_prefix_list_id: "PrefixListResourceId",
})

Response structure


resp.route.destination_cidr_block #=> String
resp.route.local_gateway_virtual_interface_group_id #=> String
resp.route.type #=> String, one of "static", "propagated"
resp.route.state #=> String, one of "pending", "active", "blackhole", "deleting", "deleted"
resp.route.local_gateway_route_table_id #=> String
resp.route.local_gateway_route_table_arn #=> String
resp.route.owner_id #=> String
resp.route.subnet_id #=> String
resp.route.coip_pool_id #=> String
resp.route.network_interface_id #=> String
resp.route.destination_prefix_list_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_cidr_block (String) —

    The CIDR range for the route. This must match the CIDR for the route exactly.

  • :local_gateway_route_table_id (required, String) —

    The ID of the local gateway route table.

  • :dry_run (Boolean) —

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

  • :destination_prefix_list_id (String) —

    Use a prefix list in place of ‘DestinationCidrBlock`. You cannot use `DestinationPrefixListId` and `DestinationCidrBlock` in the same request.

Returns:

See Also:



17062
17063
17064
17065
 
# File 'lib/aws-sdk-ec2/client.rb', line 17062

def delete_local_gateway_route(params = {}, options = {})
  req = build_request(:delete_local_gateway_route, params)
  req.send_request(options)
end

#delete_local_gateway_route_table(params = {}) ⇒ Types::DeleteLocalGatewayRouteTableResult

Deletes a local gateway route table.

Examples:

Request syntax with placeholder values


resp = client.delete_local_gateway_route_table({
  local_gateway_route_table_id: "LocalGatewayRoutetableId", # required
  dry_run: false,
})

Response structure


resp.local_gateway_route_table.local_gateway_route_table_id #=> String
resp.local_gateway_route_table.local_gateway_route_table_arn #=> String
resp.local_gateway_route_table.local_gateway_id #=> String
resp.local_gateway_route_table.outpost_arn #=> String
resp.local_gateway_route_table.owner_id #=> String
resp.local_gateway_route_table.state #=> String
resp.local_gateway_route_table.tags #=> Array
resp.local_gateway_route_table.tags[0].key #=> String
resp.local_gateway_route_table.tags[0].value #=> String
resp.local_gateway_route_table.mode #=> String, one of "direct-vpc-routing", "coip"
resp.local_gateway_route_table.state_reason.code #=> String
resp.local_gateway_route_table.state_reason.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_id (required, String) —

    The ID of the local gateway route table.

  • :dry_run (Boolean) —

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

Returns:

See Also:



17108
17109
17110
17111
 
# File 'lib/aws-sdk-ec2/client.rb', line 17108

def delete_local_gateway_route_table(params = {}, options = {})
  req = build_request(:delete_local_gateway_route_table, params)
  req.send_request(options)
end

#delete_local_gateway_route_table_virtual_interface_group_association(params = {}) ⇒ Types::DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult

Deletes a local gateway route table virtual interface group association.

Examples:

Request syntax with placeholder values


resp = client.delete_local_gateway_route_table_virtual_interface_group_association({
  local_gateway_route_table_virtual_interface_group_association_id: "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", # required
  dry_run: false,
})

Response structure


resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_route_table_virtual_interface_group_association_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_virtual_interface_group_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_route_table_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.local_gateway_route_table_arn #=> String
resp.local_gateway_route_table_virtual_interface_group_association.owner_id #=> String
resp.local_gateway_route_table_virtual_interface_group_association.state #=> String
resp.local_gateway_route_table_virtual_interface_group_association.tags #=> Array
resp.local_gateway_route_table_virtual_interface_group_association.tags[0].key #=> String
resp.local_gateway_route_table_virtual_interface_group_association.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_virtual_interface_group_association_id (required, String) —

    The ID of the local gateway route table virtual interface group association.

  • :dry_run (Boolean) —

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

Returns:

See Also:



17154
17155
17156
17157
 
# File 'lib/aws-sdk-ec2/client.rb', line 17154

def delete_local_gateway_route_table_virtual_interface_group_association(params = {}, options = {})
  req = build_request(:delete_local_gateway_route_table_virtual_interface_group_association, params)
  req.send_request(options)
end

#delete_local_gateway_route_table_vpc_association(params = {}) ⇒ Types::DeleteLocalGatewayRouteTableVpcAssociationResult

Deletes the specified association between a VPC and local gateway route table.

Examples:

Request syntax with placeholder values


resp = client.delete_local_gateway_route_table_vpc_association({
  local_gateway_route_table_vpc_association_id: "LocalGatewayRouteTableVpcAssociationId", # required
  dry_run: false,
})

Response structure


resp.local_gateway_route_table_vpc_association.local_gateway_route_table_vpc_association_id #=> String
resp.local_gateway_route_table_vpc_association.local_gateway_route_table_id #=> String
resp.local_gateway_route_table_vpc_association.local_gateway_route_table_arn #=> String
resp.local_gateway_route_table_vpc_association.local_gateway_id #=> String
resp.local_gateway_route_table_vpc_association.vpc_id #=> String
resp.local_gateway_route_table_vpc_association.owner_id #=> String
resp.local_gateway_route_table_vpc_association.state #=> String
resp.local_gateway_route_table_vpc_association.tags #=> Array
resp.local_gateway_route_table_vpc_association.tags[0].key #=> String
resp.local_gateway_route_table_vpc_association.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_vpc_association_id (required, String) —

    The ID of the association.

  • :dry_run (Boolean) —

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

Returns:

See Also:



17199
17200
17201
17202
 
# File 'lib/aws-sdk-ec2/client.rb', line 17199

def delete_local_gateway_route_table_vpc_association(params = {}, options = {})
  req = build_request(:delete_local_gateway_route_table_vpc_association, params)
  req.send_request(options)
end

#delete_managed_prefix_list(params = {}) ⇒ Types::DeleteManagedPrefixListResult

Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.

Examples:

Request syntax with placeholder values


resp = client.delete_managed_prefix_list({
  dry_run: false,
  prefix_list_id: "PrefixListResourceId", # required
})

Response structure


resp.prefix_list.prefix_list_id #=> String
resp.prefix_list.address_family #=> String
resp.prefix_list.state #=> String, one of "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"
resp.prefix_list.state_message #=> String
resp.prefix_list.prefix_list_arn #=> String
resp.prefix_list.prefix_list_name #=> String
resp.prefix_list.max_entries #=> Integer
resp.prefix_list.version #=> Integer
resp.prefix_list.tags #=> Array
resp.prefix_list.tags[0].key #=> String
resp.prefix_list.tags[0].value #=> String
resp.prefix_list.owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The ID of the prefix list.

Returns:

See Also:



17246
17247
17248
17249
 
# File 'lib/aws-sdk-ec2/client.rb', line 17246

def delete_managed_prefix_list(params = {}, options = {})
  req = build_request(:delete_managed_prefix_list, params)
  req.send_request(options)
end

#delete_nat_gateway(params = {}) ⇒ Types::DeleteNatGatewayResult

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.

Examples:

Example: To delete a NAT gateway


# This example deletes the specified NAT gateway.

resp = client.delete_nat_gateway({
  nat_gateway_id: "nat-04ae55e711cec5680", 
})

resp.to_h outputs the following:
{
  nat_gateway_id: "nat-04ae55e711cec5680", 
}

Request syntax with placeholder values


resp = client.delete_nat_gateway({
  dry_run: false,
  nat_gateway_id: "NatGatewayId", # required
})

Response structure


resp.nat_gateway_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :nat_gateway_id (required, String) —

    The ID of the NAT gateway.

Returns:

See Also:



17298
17299
17300
17301
 
# File 'lib/aws-sdk-ec2/client.rb', line 17298

def delete_nat_gateway(params = {}, options = {})
  req = build_request(:delete_nat_gateway, params)
  req.send_request(options)
end

#delete_network_acl(params = {}) ⇒ Struct

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.

Examples:

Example: To delete a network ACL


# This example deletes the specified network ACL.

resp = client.delete_network_acl({
  network_acl_id: "acl-5fb85d36", 
})

Request syntax with placeholder values


resp = client.delete_network_acl({
  dry_run: false,
  network_acl_id: "NetworkAclId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_acl_id (required, String) —

    The ID of the network ACL.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



17338
17339
17340
17341
 
# File 'lib/aws-sdk-ec2/client.rb', line 17338

def delete_network_acl(params = {}, options = {})
  req = build_request(:delete_network_acl, params)
  req.send_request(options)
end

#delete_network_acl_entry(params = {}) ⇒ Struct

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

Examples:

Example: To delete a network ACL entry


# This example deletes ingress rule number 100 from the specified network ACL.

resp = client.delete_network_acl_entry({
  egress: true, 
  network_acl_id: "acl-5fb85d36", 
  rule_number: 100, 
})

Request syntax with placeholder values


resp = client.delete_network_acl_entry({
  dry_run: false,
  network_acl_id: "NetworkAclId", # required
  rule_number: 1, # required
  egress: false, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_acl_id (required, String) —

    The ID of the network ACL.

  • :rule_number (required, Integer) —

    The rule number of the entry to delete.

  • :egress (required, Boolean) —

    Indicates whether the rule is an egress rule.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



17387
17388
17389
17390
 
# File 'lib/aws-sdk-ec2/client.rb', line 17387

def delete_network_acl_entry(params = {}, options = {})
  req = build_request(:delete_network_acl_entry, params)
  req.send_request(options)
end

#delete_network_insights_access_scope(params = {}) ⇒ Types::DeleteNetworkInsightsAccessScopeResult

Deletes the specified Network Access Scope.

Examples:

Request syntax with placeholder values


resp = client.delete_network_insights_access_scope({
  dry_run: false,
  network_insights_access_scope_id: "NetworkInsightsAccessScopeId", # required
})

Response structure


resp.network_insights_access_scope_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_insights_access_scope_id (required, String) —

    The ID of the Network Access Scope.

Returns:

See Also:



17422
17423
17424
17425
 
# File 'lib/aws-sdk-ec2/client.rb', line 17422

def delete_network_insights_access_scope(params = {}, options = {})
  req = build_request(:delete_network_insights_access_scope, params)
  req.send_request(options)
end

#delete_network_insights_access_scope_analysis(params = {}) ⇒ Types::DeleteNetworkInsightsAccessScopeAnalysisResult

Deletes the specified Network Access Scope analysis.

Examples:

Request syntax with placeholder values


resp = client.delete_network_insights_access_scope_analysis({
  network_insights_access_scope_analysis_id: "NetworkInsightsAccessScopeAnalysisId", # required
  dry_run: false,
})

Response structure


resp.network_insights_access_scope_analysis_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_insights_access_scope_analysis_id (required, String) —

    The ID of the Network Access Scope analysis.

  • :dry_run (Boolean) —

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

Returns:

See Also:



17457
17458
17459
17460
 
# File 'lib/aws-sdk-ec2/client.rb', line 17457

def delete_network_insights_access_scope_analysis(params = {}, options = {})
  req = build_request(:delete_network_insights_access_scope_analysis, params)
  req.send_request(options)
end

#delete_network_insights_analysis(params = {}) ⇒ Types::DeleteNetworkInsightsAnalysisResult

Deletes the specified network insights analysis.

Examples:

Request syntax with placeholder values


resp = client.delete_network_insights_analysis({
  dry_run: false,
  network_insights_analysis_id: "NetworkInsightsAnalysisId", # required
})

Response structure


resp.network_insights_analysis_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_insights_analysis_id (required, String) —

    The ID of the network insights analysis.

Returns:

See Also:



17492
17493
17494
17495
 
# File 'lib/aws-sdk-ec2/client.rb', line 17492

def delete_network_insights_analysis(params = {}, options = {})
  req = build_request(:delete_network_insights_analysis, params)
  req.send_request(options)
end

#delete_network_insights_path(params = {}) ⇒ Types::DeleteNetworkInsightsPathResult

Deletes the specified path.

Examples:

Request syntax with placeholder values


resp = client.delete_network_insights_path({
  dry_run: false,
  network_insights_path_id: "NetworkInsightsPathId", # required
})

Response structure


resp.network_insights_path_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_insights_path_id (required, String) —

    The ID of the path.

Returns:

See Also:



17527
17528
17529
17530
 
# File 'lib/aws-sdk-ec2/client.rb', line 17527

def delete_network_insights_path(params = {}, options = {})
  req = build_request(:delete_network_insights_path, params)
  req.send_request(options)
end

#delete_network_interface(params = {}) ⇒ Struct

Deletes the specified network interface. You must detach the network interface before you can delete it.

Examples:

Example: To delete a network interface


# This example deletes the specified network interface.

resp = client.delete_network_interface({
  network_interface_id: "eni-e5aa89a3", 
})

Request syntax with placeholder values


resp = client.delete_network_interface({
  dry_run: false,
  network_interface_id: "NetworkInterfaceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_interface_id (required, String) —

    The ID of the network interface.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



17566
17567
17568
17569
 
# File 'lib/aws-sdk-ec2/client.rb', line 17566

def delete_network_interface(params = {}, options = {})
  req = build_request(:delete_network_interface, params)
  req.send_request(options)
end

#delete_network_interface_permission(params = {}) ⇒ Types::DeleteNetworkInterfacePermissionResult

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.

Examples:

Request syntax with placeholder values


resp = client.delete_network_interface_permission({
  network_interface_permission_id: "NetworkInterfacePermissionId", # required
  force: false,
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_interface_permission_id (required, 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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



17609
17610
17611
17612
 
# File 'lib/aws-sdk-ec2/client.rb', line 17609

def delete_network_interface_permission(params = {}, options = {})
  req = build_request(:delete_network_interface_permission, params)
  req.send_request(options)
end

#delete_placement_group(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html

Examples:

Example: To delete a placement group


# This example deletes the specified placement group.

resp = client.delete_placement_group({
  group_name: "my-cluster", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_placement_group({
  dry_run: false,
  group_name: "PlacementGroupName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :group_name (required, String) —

    The name of the placement group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



17658
17659
17660
17661
 
# File 'lib/aws-sdk-ec2/client.rb', line 17658

def delete_placement_group(params = {}, options = {})
  req = build_request(:delete_placement_group, params)
  req.send_request(options)
end

#delete_public_ipv_4_pool(params = {}) ⇒ Types::DeletePublicIpv4PoolResult

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.

Examples:

Request syntax with placeholder values


resp = client.delete_public_ipv_4_pool({
  dry_run: false,
  pool_id: "Ipv4PoolEc2Id", # required
  network_border_group: "String",
})

Response structure


resp.return_value #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :pool_id (required, String) —

    The ID of the public IPv4 pool you want to delete.

  • :network_border_group (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail

Returns:

See Also:



17708
17709
17710
17711
 
# File 'lib/aws-sdk-ec2/client.rb', line 17708

def delete_public_ipv_4_pool(params = {}, options = {})
  req = build_request(:delete_public_ipv_4_pool, params)
  req.send_request(options)
end

#delete_queued_reserved_instances(params = {}) ⇒ Types::DeleteQueuedReservedInstancesResult

Deletes the queued purchases for the specified Reserved Instances.

Examples:

Request syntax with placeholder values


resp = client.delete_queued_reserved_instances({
  dry_run: false,
  reserved_instances_ids: ["ReservationId"], # required
})

Response structure


resp.successful_queued_purchase_deletions #=> Array
resp.successful_queued_purchase_deletions[0].reserved_instances_id #=> String
resp.failed_queued_purchase_deletions #=> Array
resp.failed_queued_purchase_deletions[0].error.code #=> String, one of "reserved-instances-id-invalid", "reserved-instances-not-in-queued-state", "unexpected-error"
resp.failed_queued_purchase_deletions[0].error.message #=> String
resp.failed_queued_purchase_deletions[0].reserved_instances_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :reserved_instances_ids (required, Array<String>) —

    The IDs of the Reserved Instances.

Returns:

See Also:



17749
17750
17751
17752
 
# File 'lib/aws-sdk-ec2/client.rb', line 17749

def delete_queued_reserved_instances(params = {}, options = {})
  req = build_request(:delete_queued_reserved_instances, params)
  req.send_request(options)
end

#delete_route(params = {}) ⇒ Struct

Deletes the specified route from the specified route table.

Examples:

Example: To delete a route


# This example deletes the specified route from the specified route table.

resp = client.delete_route({
  destination_cidr_block: "0.0.0.0/0", 
  route_table_id: "rtb-22574640", 
})

Request syntax with placeholder values


resp = client.delete_route({
  destination_prefix_list_id: "PrefixListResourceId",
  dry_run: false,
  route_table_id: "RouteTableId", # required
  destination_cidr_block: "String",
  destination_ipv_6_cidr_block: "String",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_prefix_list_id (String) —

    The ID of the prefix list for the route.

  • :dry_run (Boolean) —

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

  • :route_table_id (required, String) —

    The ID of the route table.

  • :destination_cidr_block (String) —

    The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

  • :destination_ipv_6_cidr_block (String) —

    The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



17802
17803
17804
17805
 
# File 'lib/aws-sdk-ec2/client.rb', line 17802

def delete_route(params = {}, options = {})
  req = build_request(:delete_route, params)
  req.send_request(options)
end

#delete_route_table(params = {}) ⇒ Struct

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.

Examples:

Example: To delete a route table


# This example deletes the specified route table.

resp = client.delete_route_table({
  route_table_id: "rtb-22574640", 
})

Request syntax with placeholder values


resp = client.delete_route_table({
  dry_run: false,
  route_table_id: "RouteTableId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :route_table_id (required, String) —

    The ID of the route table.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



17842
17843
17844
17845
 
# File 'lib/aws-sdk-ec2/client.rb', line 17842

def delete_route_table(params = {}, options = {})
  req = build_request(:delete_route_table, params)
  req.send_request(options)
end

#delete_security_group(params = {}) ⇒ Struct

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

Examples:

Example: To delete a security group


# This example deletes the specified security group.

resp = client.delete_security_group({
  group_id: "sg-903004f8", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_security_group({
  group_id: "SecurityGroupId",
  group_name: "SecurityGroupName",
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_id (String) —

    The ID of the security group.

  • :group_name (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.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



17894
17895
17896
17897
 
# File 'lib/aws-sdk-ec2/client.rb', line 17894

def delete_security_group(params = {}, options = {})
  req = build_request(:delete_security_group, params)
  req.send_request(options)
end

#delete_snapshot(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-deleting-snapshot.html

Examples:

Example: To delete a snapshot


# This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output
# is returned.

resp = client.delete_snapshot({
  snapshot_id: "snap-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_snapshot({
  snapshot_id: "SnapshotId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The ID of the EBS snapshot.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



17956
17957
17958
17959
 
# File 'lib/aws-sdk-ec2/client.rb', line 17956

def delete_snapshot(params = {}, options = {})
  req = build_request(:delete_snapshot, params)
  req.send_request(options)
end

#delete_spot_datafeed_subscription(params = {}) ⇒ Struct

Deletes the data feed for Spot Instances.

Examples:

Example: To cancel a Spot Instance data feed subscription


# This example deletes a Spot data feed subscription for the account.

resp = client.delete_spot_datafeed_subscription({
})

Request syntax with placeholder values


resp = client.delete_spot_datafeed_subscription({
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



17989
17990
17991
17992
 
# File 'lib/aws-sdk-ec2/client.rb', line 17989

def delete_spot_datafeed_subscription(params = {}, options = {})
  req = build_request(:delete_spot_datafeed_subscription, params)
  req.send_request(options)
end

#delete_subnet(params = {}) ⇒ Struct

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

Examples:

Example: To delete a subnet


# This example deletes the specified subnet.

resp = client.delete_subnet({
  subnet_id: "subnet-9d4a7b6c", 
})

Request syntax with placeholder values


resp = client.delete_subnet({
  subnet_id: "SubnetId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subnet_id (required, String) —

    The ID of the subnet.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



18028
18029
18030
18031
 
# File 'lib/aws-sdk-ec2/client.rb', line 18028

def delete_subnet(params = {}, options = {})
  req = build_request(:delete_subnet, params)
  req.send_request(options)
end

#delete_subnet_cidr_reservation(params = {}) ⇒ Types::DeleteSubnetCidrReservationResult

Deletes a subnet CIDR reservation.

Examples:

Request syntax with placeholder values


resp = client.delete_subnet_cidr_reservation({
  subnet_cidr_reservation_id: "SubnetCidrReservationId", # required
  dry_run: false,
})

Response structure


resp.deleted_subnet_cidr_reservation.subnet_cidr_reservation_id #=> String
resp.deleted_subnet_cidr_reservation.subnet_id #=> String
resp.deleted_subnet_cidr_reservation.cidr #=> String
resp.deleted_subnet_cidr_reservation.reservation_type #=> String, one of "prefix", "explicit"
resp.deleted_subnet_cidr_reservation.owner_id #=> String
resp.deleted_subnet_cidr_reservation.description #=> String
resp.deleted_subnet_cidr_reservation.tags #=> Array
resp.deleted_subnet_cidr_reservation.tags[0].key #=> String
resp.deleted_subnet_cidr_reservation.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subnet_cidr_reservation_id (required, String) —

    The ID of the subnet CIDR reservation.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18071
18072
18073
18074
 
# File 'lib/aws-sdk-ec2/client.rb', line 18071

def delete_subnet_cidr_reservation(params = {}, options = {})
  req = build_request(:delete_subnet_cidr_reservation, params)
  req.send_request(options)
end

#delete_tags(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html

Examples:

Example: To delete a tag from a resource


# This example deletes the tag Stack=test from the specified image.

resp = client.delete_tags({
  resources: [
    "ami-78a54011", 
  ], 
  tags: [
    {
      key: "Stack", 
      value: "test", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.delete_tags({
  dry_run: false,
  resources: ["TaggableResourceId"], # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

    If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the ‘aws:` prefix).

    Constraints: Up to 1000 tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



18147
18148
18149
18150
 
# File 'lib/aws-sdk-ec2/client.rb', line 18147

def delete_tags(params = {}, options = {})
  req = build_request(:delete_tags, params)
  req.send_request(options)
end

#delete_traffic_mirror_filter(params = {}) ⇒ Types::DeleteTrafficMirrorFilterResult

Deletes the specified Traffic Mirror filter.

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

Examples:

Request syntax with placeholder values


resp = client.delete_traffic_mirror_filter({
  traffic_mirror_filter_id: "TrafficMirrorFilterId", # required
  dry_run: false,
})

Response structure


resp.traffic_mirror_filter_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_filter_id (required, String) —

    The ID of the Traffic Mirror filter.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18185
18186
18187
18188
 
# File 'lib/aws-sdk-ec2/client.rb', line 18185

def delete_traffic_mirror_filter(params = {}, options = {})
  req = build_request(:delete_traffic_mirror_filter, params)
  req.send_request(options)
end

#delete_traffic_mirror_filter_rule(params = {}) ⇒ Types::DeleteTrafficMirrorFilterRuleResult

Deletes the specified Traffic Mirror rule.

Examples:

Request syntax with placeholder values


resp = client.delete_traffic_mirror_filter_rule({
  traffic_mirror_filter_rule_id: "TrafficMirrorFilterRuleIdWithResolver", # required
  dry_run: false,
})

Response structure


resp.traffic_mirror_filter_rule_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_filter_rule_id (required, String) —

    The ID of the Traffic Mirror rule.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18220
18221
18222
18223
 
# File 'lib/aws-sdk-ec2/client.rb', line 18220

def delete_traffic_mirror_filter_rule(params = {}, options = {})
  req = build_request(:delete_traffic_mirror_filter_rule, params)
  req.send_request(options)
end

#delete_traffic_mirror_session(params = {}) ⇒ Types::DeleteTrafficMirrorSessionResult

Deletes the specified Traffic Mirror session.

Examples:

Request syntax with placeholder values


resp = client.delete_traffic_mirror_session({
  traffic_mirror_session_id: "TrafficMirrorSessionId", # required
  dry_run: false,
})

Response structure


resp.traffic_mirror_session_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_session_id (required, String) —

    The ID of the Traffic Mirror session.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18255
18256
18257
18258
 
# File 'lib/aws-sdk-ec2/client.rb', line 18255

def delete_traffic_mirror_session(params = {}, options = {})
  req = build_request(:delete_traffic_mirror_session, params)
  req.send_request(options)
end

#delete_traffic_mirror_target(params = {}) ⇒ Types::DeleteTrafficMirrorTargetResult

Deletes the specified Traffic Mirror target.

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

Examples:

Request syntax with placeholder values


resp = client.delete_traffic_mirror_target({
  traffic_mirror_target_id: "TrafficMirrorTargetId", # required
  dry_run: false,
})

Response structure


resp.traffic_mirror_target_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_target_id (required, String) —

    The ID of the Traffic Mirror target.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18293
18294
18295
18296
 
# File 'lib/aws-sdk-ec2/client.rb', line 18293

def delete_traffic_mirror_target(params = {}, options = {})
  req = build_request(:delete_traffic_mirror_target, params)
  req.send_request(options)
end

#delete_transit_gateway(params = {}) ⇒ Types::DeleteTransitGatewayResult

Deletes the specified transit gateway.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway({
  transit_gateway_id: "TransitGatewayId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway.transit_gateway_id #=> String
resp.transit_gateway.transit_gateway_arn #=> String
resp.transit_gateway.state #=> String, one of "pending", "available", "modifying", "deleting", "deleted"
resp.transit_gateway.owner_id #=> String
resp.transit_gateway.description #=> String
resp.transit_gateway.creation_time #=> Time
resp.transit_gateway.options.amazon_side_asn #=> Integer
resp.transit_gateway.options.transit_gateway_cidr_blocks #=> Array
resp.transit_gateway.options.transit_gateway_cidr_blocks[0] #=> String
resp.transit_gateway.options.auto_accept_shared_attachments #=> String, one of "enable", "disable"
resp.transit_gateway.options.default_route_table_association #=> String, one of "enable", "disable"
resp.transit_gateway.options.association_default_route_table_id #=> String
resp.transit_gateway.options.default_route_table_propagation #=> String, one of "enable", "disable"
resp.transit_gateway.options.propagation_default_route_table_id #=> String
resp.transit_gateway.options.vpn_ecmp_support #=> String, one of "enable", "disable"
resp.transit_gateway.options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateway.options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateway.options.multicast_support #=> String, one of "enable", "disable"
resp.transit_gateway.tags #=> Array
resp.transit_gateway.tags[0].key #=> String
resp.transit_gateway.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_id (required, String) —

    The ID of the transit gateway.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18348
18349
18350
18351
 
# File 'lib/aws-sdk-ec2/client.rb', line 18348

def delete_transit_gateway(params = {}, options = {})
  req = build_request(:delete_transit_gateway, params)
  req.send_request(options)
end

#delete_transit_gateway_connect(params = {}) ⇒ Types::DeleteTransitGatewayConnectResult

Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_connect({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_connect.transit_gateway_attachment_id #=> String
resp.transit_gateway_connect.transport_transit_gateway_attachment_id #=> String
resp.transit_gateway_connect.transit_gateway_id #=> String
resp.transit_gateway_connect.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_connect.creation_time #=> Time
resp.transit_gateway_connect.options.protocol #=> String, one of "gre"
resp.transit_gateway_connect.tags #=> Array
resp.transit_gateway_connect.tags[0].key #=> String
resp.transit_gateway_connect.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the Connect attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18392
18393
18394
18395
 
# File 'lib/aws-sdk-ec2/client.rb', line 18392

def delete_transit_gateway_connect(params = {}, options = {})
  req = build_request(:delete_transit_gateway_connect, params)
  req.send_request(options)
end

#delete_transit_gateway_connect_peer(params = {}) ⇒ Types::DeleteTransitGatewayConnectPeerResult

Deletes the specified Connect peer.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_connect_peer({
  transit_gateway_connect_peer_id: "TransitGatewayConnectPeerId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_connect_peer.transit_gateway_attachment_id #=> String
resp.transit_gateway_connect_peer.transit_gateway_connect_peer_id #=> String
resp.transit_gateway_connect_peer.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_connect_peer.creation_time #=> Time
resp.transit_gateway_connect_peer.connect_peer_configuration.transit_gateway_address #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.peer_address #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.inside_cidr_blocks #=> Array
resp.transit_gateway_connect_peer.connect_peer_configuration.inside_cidr_blocks[0] #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.protocol #=> String, one of "gre"
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations #=> Array
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].transit_gateway_asn #=> Integer
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].peer_asn #=> Integer
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].transit_gateway_address #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].peer_address #=> String
resp.transit_gateway_connect_peer.connect_peer_configuration.bgp_configurations[0].bgp_status #=> String, one of "up", "down"
resp.transit_gateway_connect_peer.tags #=> Array
resp.transit_gateway_connect_peer.tags[0].key #=> String
resp.transit_gateway_connect_peer.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_connect_peer_id (required, String) —

    The ID of the Connect peer.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18444
18445
18446
18447
 
# File 'lib/aws-sdk-ec2/client.rb', line 18444

def delete_transit_gateway_connect_peer(params = {}, options = {})
  req = build_request(:delete_transit_gateway_connect_peer, params)
  req.send_request(options)
end

#delete_transit_gateway_multicast_domain(params = {}) ⇒ Types::DeleteTransitGatewayMulticastDomainResult

Deletes the specified transit gateway multicast domain.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_multicast_domain({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_multicast_domain.transit_gateway_multicast_domain_id #=> String
resp.transit_gateway_multicast_domain.transit_gateway_id #=> String
resp.transit_gateway_multicast_domain.transit_gateway_multicast_domain_arn #=> String
resp.transit_gateway_multicast_domain.owner_id #=> String
resp.transit_gateway_multicast_domain.options.igmpv_2_support #=> String, one of "enable", "disable"
resp.transit_gateway_multicast_domain.options.static_sources_support #=> String, one of "enable", "disable"
resp.transit_gateway_multicast_domain.options.auto_accept_shared_associations #=> String, one of "enable", "disable"
resp.transit_gateway_multicast_domain.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_multicast_domain.creation_time #=> Time
resp.transit_gateway_multicast_domain.tags #=> Array
resp.transit_gateway_multicast_domain.tags[0].key #=> String
resp.transit_gateway_multicast_domain.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (required, String) —

    The ID of the transit gateway multicast domain.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18490
18491
18492
18493
 
# File 'lib/aws-sdk-ec2/client.rb', line 18490

def delete_transit_gateway_multicast_domain(params = {}, options = {})
  req = build_request(:delete_transit_gateway_multicast_domain, params)
  req.send_request(options)
end

#delete_transit_gateway_peering_attachment(params = {}) ⇒ Types::DeleteTransitGatewayPeeringAttachmentResult

Deletes a transit gateway peering attachment.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_peering_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_peering_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachment.accepter_transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.region #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.region #=> String
resp.transit_gateway_peering_attachment.options.dynamic_routing #=> String, one of "enable", "disable"
resp.transit_gateway_peering_attachment.status.code #=> String
resp.transit_gateway_peering_attachment.status.message #=> String
resp.transit_gateway_peering_attachment.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_peering_attachment.creation_time #=> Time
resp.transit_gateway_peering_attachment.tags #=> Array
resp.transit_gateway_peering_attachment.tags[0].key #=> String
resp.transit_gateway_peering_attachment.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the transit gateway peering attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18542
18543
18544
18545
 
# File 'lib/aws-sdk-ec2/client.rb', line 18542

def delete_transit_gateway_peering_attachment(params = {}, options = {})
  req = build_request(:delete_transit_gateway_peering_attachment, params)
  req.send_request(options)
end

#delete_transit_gateway_policy_table(params = {}) ⇒ Types::DeleteTransitGatewayPolicyTableResult

Deletes the specified transit gateway policy table.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_policy_table({
  transit_gateway_policy_table_id: "TransitGatewayPolicyTableId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_policy_table.transit_gateway_policy_table_id #=> String
resp.transit_gateway_policy_table.transit_gateway_id #=> String
resp.transit_gateway_policy_table.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_policy_table.creation_time #=> Time
resp.transit_gateway_policy_table.tags #=> Array
resp.transit_gateway_policy_table.tags[0].key #=> String
resp.transit_gateway_policy_table.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_policy_table_id (required, String) —

    The transit gateway policy table to delete.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18583
18584
18585
18586
 
# File 'lib/aws-sdk-ec2/client.rb', line 18583

def delete_transit_gateway_policy_table(params = {}, options = {})
  req = build_request(:delete_transit_gateway_policy_table, params)
  req.send_request(options)
end

#delete_transit_gateway_prefix_list_reference(params = {}) ⇒ Types::DeleteTransitGatewayPrefixListReferenceResult

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_prefix_list_reference({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  prefix_list_id: "PrefixListResourceId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_prefix_list_reference.transit_gateway_route_table_id #=> String
resp.transit_gateway_prefix_list_reference.prefix_list_id #=> String
resp.transit_gateway_prefix_list_reference.prefix_list_owner_id #=> String
resp.transit_gateway_prefix_list_reference.state #=> String, one of "pending", "available", "modifying", "deleting"
resp.transit_gateway_prefix_list_reference.blackhole #=> Boolean
resp.transit_gateway_prefix_list_reference.transit_gateway_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_prefix_list_reference.transit_gateway_attachment.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.transit_gateway_prefix_list_reference.transit_gateway_attachment.resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the route table.

  • :prefix_list_id (required, String) —

    The ID of the prefix list.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18630
18631
18632
18633
 
# File 'lib/aws-sdk-ec2/client.rb', line 18630

def delete_transit_gateway_prefix_list_reference(params = {}, options = {})
  req = build_request(:delete_transit_gateway_prefix_list_reference, params)
  req.send_request(options)
end

#delete_transit_gateway_route(params = {}) ⇒ Types::DeleteTransitGatewayRouteResult

Deletes the specified route from the specified transit gateway route table.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_route({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  destination_cidr_block: "String", # required
  dry_run: false,
})

Response structure


resp.route.destination_cidr_block #=> String
resp.route.prefix_list_id #=> String
resp.route.transit_gateway_route_table_announcement_id #=> String
resp.route.transit_gateway_attachments #=> Array
resp.route.transit_gateway_attachments[0].resource_id #=> String
resp.route.transit_gateway_attachments[0].transit_gateway_attachment_id #=> String
resp.route.transit_gateway_attachments[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.route.type #=> String, one of "static", "propagated"
resp.route.state #=> String, one of "pending", "active", "blackhole", "deleting", "deleted"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :destination_cidr_block (required, String) —

    The CIDR range for the route. This must match the CIDR for the route exactly.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18679
18680
18681
18682
 
# File 'lib/aws-sdk-ec2/client.rb', line 18679

def delete_transit_gateway_route(params = {}, options = {})
  req = build_request(:delete_transit_gateway_route, params)
  req.send_request(options)
end

#delete_transit_gateway_route_table(params = {}) ⇒ Types::DeleteTransitGatewayRouteTableResult

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.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_route_table({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_route_table.transit_gateway_route_table_id #=> String
resp.transit_gateway_route_table.transit_gateway_id #=> String
resp.transit_gateway_route_table.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_route_table.default_association_route_table #=> Boolean
resp.transit_gateway_route_table.default_propagation_route_table #=> Boolean
resp.transit_gateway_route_table.creation_time #=> Time
resp.transit_gateway_route_table.tags #=> Array
resp.transit_gateway_route_table.tags[0].key #=> String
resp.transit_gateway_route_table.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18726
18727
18728
18729
 
# File 'lib/aws-sdk-ec2/client.rb', line 18726

def delete_transit_gateway_route_table(params = {}, options = {})
  req = build_request(:delete_transit_gateway_route_table, params)
  req.send_request(options)
end

#delete_transit_gateway_route_table_announcement(params = {}) ⇒ Types::DeleteTransitGatewayRouteTableAnnouncementResult

Advertises to the transit gateway that a transit gateway route table is deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_route_table_announcement({
  transit_gateway_route_table_announcement_id: "TransitGatewayRouteTableAnnouncementId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_route_table_announcement.transit_gateway_route_table_announcement_id #=> String
resp.transit_gateway_route_table_announcement.transit_gateway_id #=> String
resp.transit_gateway_route_table_announcement.core_network_id #=> String
resp.transit_gateway_route_table_announcement.peer_transit_gateway_id #=> String
resp.transit_gateway_route_table_announcement.peer_core_network_id #=> String
resp.transit_gateway_route_table_announcement.peering_attachment_id #=> String
resp.transit_gateway_route_table_announcement.announcement_direction #=> String, one of "outgoing", "incoming"
resp.transit_gateway_route_table_announcement.transit_gateway_route_table_id #=> String
resp.transit_gateway_route_table_announcement.state #=> String, one of "available", "pending", "failing", "failed", "deleting", "deleted"
resp.transit_gateway_route_table_announcement.creation_time #=> Time
resp.transit_gateway_route_table_announcement.tags #=> Array
resp.transit_gateway_route_table_announcement.tags[0].key #=> String
resp.transit_gateway_route_table_announcement.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_announcement_id (required, String) —

    The transit gateway route table ID that’s being deleted.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18774
18775
18776
18777
 
# File 'lib/aws-sdk-ec2/client.rb', line 18774

def delete_transit_gateway_route_table_announcement(params = {}, options = {})
  req = build_request(:delete_transit_gateway_route_table_announcement, params)
  req.send_request(options)
end

#delete_transit_gateway_vpc_attachment(params = {}) ⇒ Types::DeleteTransitGatewayVpcAttachmentResult

Deletes the specified VPC attachment.

Examples:

Request syntax with placeholder values


resp = client.delete_transit_gateway_vpc_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_vpc_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_vpc_attachment.transit_gateway_id #=> String
resp.transit_gateway_vpc_attachment.vpc_id #=> String
resp.transit_gateway_vpc_attachment.vpc_owner_id #=> String
resp.transit_gateway_vpc_attachment.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_vpc_attachment.subnet_ids #=> Array
resp.transit_gateway_vpc_attachment.subnet_ids[0] #=> String
resp.transit_gateway_vpc_attachment.creation_time #=> Time
resp.transit_gateway_vpc_attachment.options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.ipv_6_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.appliance_mode_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.tags #=> Array
resp.transit_gateway_vpc_attachment.tags[0].key #=> String
resp.transit_gateway_vpc_attachment.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



18823
18824
18825
18826
 
# File 'lib/aws-sdk-ec2/client.rb', line 18823

def delete_transit_gateway_vpc_attachment(params = {}, options = {})
  req = build_request(:delete_transit_gateway_vpc_attachment, params)
  req.send_request(options)
end

#delete_verified_access_endpoint(params = {}) ⇒ Types::DeleteVerifiedAccessEndpointResult

Delete an Amazon Web Services Verified Access endpoint.

Examples:

Request syntax with placeholder values


resp = client.delete_verified_access_endpoint({
  verified_access_endpoint_id: "VerifiedAccessEndpointId", # required
  client_token: "String",
  dry_run: false,
})

Response structure


resp.verified_access_endpoint.verified_access_instance_id #=> String
resp.verified_access_endpoint.verified_access_group_id #=> String
resp.verified_access_endpoint.verified_access_endpoint_id #=> String
resp.verified_access_endpoint.application_domain #=> String
resp.verified_access_endpoint.endpoint_type #=> String, one of "load-balancer", "network-interface"
resp.verified_access_endpoint.attachment_type #=> String, one of "vpc"
resp.verified_access_endpoint.domain_certificate_arn #=> String
resp.verified_access_endpoint.endpoint_domain #=> String
resp.verified_access_endpoint.device_validation_domain #=> String
resp.verified_access_endpoint.security_group_ids #=> Array
resp.verified_access_endpoint.security_group_ids[0] #=> String
resp.verified_access_endpoint.load_balancer_options.protocol #=> String, one of "http", "https"
resp.verified_access_endpoint.load_balancer_options.port #=> Integer
resp.verified_access_endpoint.load_balancer_options.load_balancer_arn #=> String
resp.verified_access_endpoint.load_balancer_options.subnet_ids #=> Array
resp.verified_access_endpoint.load_balancer_options.subnet_ids[0] #=> String
resp.verified_access_endpoint.network_interface_options.network_interface_id #=> String
resp.verified_access_endpoint.network_interface_options.protocol #=> String, one of "http", "https"
resp.verified_access_endpoint.network_interface_options.port #=> Integer
resp.verified_access_endpoint.status.code #=> String, one of "pending", "active", "updating", "deleting", "deleted"
resp.verified_access_endpoint.status.message #=> String
resp.verified_access_endpoint.description #=> String
resp.verified_access_endpoint.creation_time #=> String
resp.verified_access_endpoint.last_updated_time #=> String
resp.verified_access_endpoint.deletion_time #=> String
resp.verified_access_endpoint.tags #=> Array
resp.verified_access_endpoint.tags[0].key #=> String
resp.verified_access_endpoint.tags[0].value #=> String
resp.verified_access_endpoint.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_endpoint.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_endpoint_id (required, String) —

    The ID of the Verified Access endpoint.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



18900
18901
18902
18903
 
# File 'lib/aws-sdk-ec2/client.rb', line 18900

def delete_verified_access_endpoint(params = {}, options = {})
  req = build_request(:delete_verified_access_endpoint, params)
  req.send_request(options)
end

#delete_verified_access_group(params = {}) ⇒ Types::DeleteVerifiedAccessGroupResult

Delete an Amazon Web Services Verified Access group.

Examples:

Request syntax with placeholder values


resp = client.delete_verified_access_group({
  verified_access_group_id: "VerifiedAccessGroupId", # required
  client_token: "String",
  dry_run: false,
})

Response structure


resp.verified_access_group.verified_access_group_id #=> String
resp.verified_access_group.verified_access_instance_id #=> String
resp.verified_access_group.description #=> String
resp.verified_access_group.owner #=> String
resp.verified_access_group.verified_access_group_arn #=> String
resp.verified_access_group.creation_time #=> String
resp.verified_access_group.last_updated_time #=> String
resp.verified_access_group.deletion_time #=> String
resp.verified_access_group.tags #=> Array
resp.verified_access_group.tags[0].key #=> String
resp.verified_access_group.tags[0].value #=> String
resp.verified_access_group.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_group.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_group_id (required, String) —

    The ID of the Verified Access group.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



18960
18961
18962
18963
 
# File 'lib/aws-sdk-ec2/client.rb', line 18960

def delete_verified_access_group(params = {}, options = {})
  req = build_request(:delete_verified_access_group, params)
  req.send_request(options)
end

#delete_verified_access_instance(params = {}) ⇒ Types::DeleteVerifiedAccessInstanceResult

Delete an Amazon Web Services Verified Access instance.

Examples:

Request syntax with placeholder values


resp = client.delete_verified_access_instance({
  verified_access_instance_id: "VerifiedAccessInstanceId", # required
  dry_run: false,
  client_token: "String",
})

Response structure


resp.verified_access_instance.verified_access_instance_id #=> String
resp.verified_access_instance.description #=> String
resp.verified_access_instance.verified_access_trust_providers #=> Array
resp.verified_access_instance.verified_access_trust_providers[0].verified_access_trust_provider_id #=> String
resp.verified_access_instance.verified_access_trust_providers[0].description #=> String
resp.verified_access_instance.verified_access_trust_providers[0].trust_provider_type #=> String, one of "user", "device"
resp.verified_access_instance.verified_access_trust_providers[0].user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_instance.verified_access_trust_providers[0].device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_instance.creation_time #=> String
resp.verified_access_instance.last_updated_time #=> String
resp.verified_access_instance.tags #=> Array
resp.verified_access_instance.tags[0].key #=> String
resp.verified_access_instance.tags[0].value #=> String
resp.verified_access_instance.fips_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_instance_id (required, String) —

    The ID of the Verified Access instance.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



19021
19022
19023
19024
 
# File 'lib/aws-sdk-ec2/client.rb', line 19021

def delete_verified_access_instance(params = {}, options = {})
  req = build_request(:delete_verified_access_instance, params)
  req.send_request(options)
end

#delete_verified_access_trust_provider(params = {}) ⇒ Types::DeleteVerifiedAccessTrustProviderResult

Delete an Amazon Web Services Verified Access trust provider.

Examples:

Request syntax with placeholder values


resp = client.delete_verified_access_trust_provider({
  verified_access_trust_provider_id: "VerifiedAccessTrustProviderId", # required
  dry_run: false,
  client_token: "String",
})

Response structure


resp.verified_access_trust_provider.verified_access_trust_provider_id #=> String
resp.verified_access_trust_provider.description #=> String
resp.verified_access_trust_provider.trust_provider_type #=> String, one of "user", "device"
resp.verified_access_trust_provider.user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_trust_provider.device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_trust_provider.oidc_options.issuer #=> String
resp.verified_access_trust_provider.oidc_options.authorization_endpoint #=> String
resp.verified_access_trust_provider.oidc_options.token_endpoint #=> String
resp.verified_access_trust_provider.oidc_options. #=> String
resp.verified_access_trust_provider.oidc_options.client_id #=> String
resp.verified_access_trust_provider.oidc_options.client_secret #=> String
resp.verified_access_trust_provider.oidc_options.scope #=> String
resp.verified_access_trust_provider.device_options.tenant_id #=> String
resp.verified_access_trust_provider.device_options.public_signing_key_url #=> String
resp.verified_access_trust_provider.policy_reference_name #=> String
resp.verified_access_trust_provider.creation_time #=> String
resp.verified_access_trust_provider.last_updated_time #=> String
resp.verified_access_trust_provider.tags #=> Array
resp.verified_access_trust_provider.tags[0].key #=> String
resp.verified_access_trust_provider.tags[0].value #=> String
resp.verified_access_trust_provider.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_trust_provider.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_trust_provider_id (required, String) —

    The ID of the Verified Access trust provider.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



19090
19091
19092
19093
 
# File 'lib/aws-sdk-ec2/client.rb', line 19090

def delete_verified_access_trust_provider(params = {}, options = {})
  req = build_request(:delete_verified_access_trust_provider, params)
  req.send_request(options)
end

#delete_volume(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-deleting-volume.html

Examples:

Example: 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.

resp = client.delete_volume({
  volume_id: "vol-049df61146c4d7901", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_volume({
  volume_id: "VolumeId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :volume_id (required, String) —

    The ID of the volume.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19143
19144
19145
19146
 
# File 'lib/aws-sdk-ec2/client.rb', line 19143

def delete_volume(params = {}, options = {})
  req = build_request(:delete_volume, params)
  req.send_request(options)
end

#delete_vpc(params = {}) ⇒ Struct

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.

Examples:

Example: To delete a VPC


# This example deletes the specified VPC.

resp = client.delete_vpc({
  vpc_id: "vpc-a01106c2", 
})

Request syntax with placeholder values


resp = client.delete_vpc({
  vpc_id: "VpcId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19187
19188
19189
19190
 
# File 'lib/aws-sdk-ec2/client.rb', line 19187

def delete_vpc(params = {}, options = {})
  req = build_request(:delete_vpc, params)
  req.send_request(options)
end

#delete_vpc_endpoint_connection_notifications(params = {}) ⇒ Types::DeleteVpcEndpointConnectionNotificationsResult

Deletes the specified VPC endpoint connection notifications.

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_endpoint_connection_notifications({
  dry_run: false,
  connection_notification_ids: ["ConnectionNotificationId"], # required
})

Response structure


resp.unsuccessful #=> Array
resp.unsuccessful[0].error.code #=> String
resp.unsuccessful[0].error.message #=> String
resp.unsuccessful[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :connection_notification_ids (required, Array<String>) —

    The IDs of the notifications.

Returns:

See Also:



19225
19226
19227
19228
 
# File 'lib/aws-sdk-ec2/client.rb', line 19225

def delete_vpc_endpoint_connection_notifications(params = {}, options = {})
  req = build_request(:delete_vpc_endpoint_connection_notifications, params)
  req.send_request(options)
end

#delete_vpc_endpoint_service_configurations(params = {}) ⇒ Types::DeleteVpcEndpointServiceConfigurationsResult

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.

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_endpoint_service_configurations({
  dry_run: false,
  service_ids: ["VpcEndpointServiceId"], # required
})

Response structure


resp.unsuccessful #=> Array
resp.unsuccessful[0].error.code #=> String
resp.unsuccessful[0].error.message #=> String
resp.unsuccessful[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_ids (required, Array<String>) —

    The IDs of the services.

Returns:

See Also:



19266
19267
19268
19269
 
# File 'lib/aws-sdk-ec2/client.rb', line 19266

def delete_vpc_endpoint_service_configurations(params = {}, options = {})
  req = build_request(:delete_vpc_endpoint_service_configurations, params)
  req.send_request(options)
end

#delete_vpc_endpoints(params = {}) ⇒ Types::DeleteVpcEndpointsResult

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.

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_endpoints({
  dry_run: false,
  vpc_endpoint_ids: ["VpcEndpointId"], # required
})

Response structure


resp.unsuccessful #=> Array
resp.unsuccessful[0].error.code #=> String
resp.unsuccessful[0].error.message #=> String
resp.unsuccessful[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_endpoint_ids (required, Array<String>) —

    The IDs of the VPC endpoints.

Returns:

See Also:



19315
19316
19317
19318
 
# File 'lib/aws-sdk-ec2/client.rb', line 19315

def delete_vpc_endpoints(params = {}, options = {})
  req = build_request(:delete_vpc_endpoints, params)
  req.send_request(options)
end

#delete_vpc_peering_connection(params = {}) ⇒ Types::DeleteVpcPeeringConnectionResult

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.

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_peering_connection({
  dry_run: false,
  vpc_peering_connection_id: "VpcPeeringConnectionId", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_peering_connection_id (required, String) —

    The ID of the VPC peering connection.

Returns:

See Also:



19355
19356
19357
19358
 
# File 'lib/aws-sdk-ec2/client.rb', line 19355

def delete_vpc_peering_connection(params = {}, options = {})
  req = build_request(:delete_vpc_peering_connection, params)
  req.send_request(options)
end

#delete_vpn_connection(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_vpn_connection({
  vpn_connection_id: "VpnConnectionId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpn_connection_id (required, String) —

    The ID of the VPN connection.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19399
19400
19401
19402
 
# File 'lib/aws-sdk-ec2/client.rb', line 19399

def delete_vpn_connection(params = {}, options = {})
  req = build_request(:delete_vpn_connection, params)
  req.send_request(options)
end

#delete_vpn_connection_route(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_vpn_connection_route({
  destination_cidr_block: "String", # required
  vpn_connection_id: "VpnConnectionId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_cidr_block (required, String) —

    The CIDR block associated with the local subnet of the customer network.

  • :vpn_connection_id (required, String) —

    The ID of the VPN connection.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19429
19430
19431
19432
 
# File 'lib/aws-sdk-ec2/client.rb', line 19429

def delete_vpn_connection_route(params = {}, options = {})
  req = build_request(:delete_vpn_connection_route, params)
  req.send_request(options)
end

#delete_vpn_gateway(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_vpn_gateway({
  vpn_gateway_id: "VpnGatewayId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpn_gateway_id (required, String) —

    The ID of the virtual private gateway.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19461
19462
19463
19464
 
# File 'lib/aws-sdk-ec2/client.rb', line 19461

def delete_vpn_gateway(params = {}, options = {})
  req = build_request(:delete_vpn_gateway, params)
  req.send_request(options)
end

#deprovision_byoip_cidr(params = {}) ⇒ Types::DeprovisionByoipCidrResult

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.

Examples:

Request syntax with placeholder values


resp = client.deprovision_byoip_cidr({
  cidr: "String", # required
  dry_run: false,
})

Response structure


resp.byoip_cidr.cidr #=> String
resp.byoip_cidr.description #=> String
resp.byoip_cidr.asn_associations #=> Array
resp.byoip_cidr.asn_associations[0].asn #=> String
resp.byoip_cidr.asn_associations[0].cidr #=> String
resp.byoip_cidr.asn_associations[0].status_message #=> String
resp.byoip_cidr.asn_associations[0].state #=> String, one of "disassociated", "failed-disassociation", "failed-association", "pending-disassociation", "pending-association", "associated"
resp.byoip_cidr.status_message #=> String
resp.byoip_cidr.state #=> String, one of "advertised", "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned", "provisioned-not-publicly-advertisable"
resp.byoip_cidr.network_border_group #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr (required, String) —

    The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

  • :dry_run (Boolean) —

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

Returns:

See Also:



19512
19513
19514
19515
 
# File 'lib/aws-sdk-ec2/client.rb', line 19512

def deprovision_byoip_cidr(params = {}, options = {})
  req = build_request(:deprovision_byoip_cidr, params)
  req.send_request(options)
end

#deprovision_ipam_byoasn(params = {}) ⇒ Types::DeprovisionIpamByoasnResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIpamByoasn.html [2]: docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html

Examples:

Request syntax with placeholder values


resp = client.deprovision_ipam_byoasn({
  dry_run: false,
  ipam_id: "IpamId", # required
  asn: "String", # required
})

Response structure


resp.byoasn.asn #=> String
resp.byoasn.ipam_id #=> String
resp.byoasn.status_message #=> String
resp.byoasn.state #=> String, one of "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :ipam_id (required, String) —

    The IPAM ID.

  • :asn (required, String) —

    An ASN.

Returns:

See Also:



19563
19564
19565
19566
 
# File 'lib/aws-sdk-ec2/client.rb', line 19563

def deprovision_ipam_byoasn(params = {}, options = {})
  req = build_request(:deprovision_ipam_byoasn, params)
  req.send_request(options)
end

#deprovision_ipam_pool_cidr(params = {}) ⇒ Types::DeprovisionIpamPoolCidrResult

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

[1]: docs.aws.amazon.com/vpc/latest/ipam/depro-pool-cidr-ipam.html

Examples:

Request syntax with placeholder values


resp = client.deprovision_ipam_pool_cidr({
  dry_run: false,
  ipam_pool_id: "IpamPoolId", # required
  cidr: "String",
})

Response structure


resp.ipam_pool_cidr.cidr #=> String
resp.ipam_pool_cidr.state #=> String, one of "pending-provision", "provisioned", "failed-provision", "pending-deprovision", "deprovisioned", "failed-deprovision", "pending-import", "failed-import"
resp.ipam_pool_cidr.failure_reason.code #=> String, one of "cidr-not-available", "limit-exceeded"
resp.ipam_pool_cidr.failure_reason.message #=> String
resp.ipam_pool_cidr.ipam_pool_cidr_id #=> String
resp.ipam_pool_cidr.netmask_length #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_pool_id (required, 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.

Returns:

See Also:



19614
19615
19616
19617
 
# File 'lib/aws-sdk-ec2/client.rb', line 19614

def deprovision_ipam_pool_cidr(params = {}, options = {})
  req = build_request(:deprovision_ipam_pool_cidr, params)
  req.send_request(options)
end

#deprovision_public_ipv_4_pool_cidr(params = {}) ⇒ Types::DeprovisionPublicIpv4PoolCidrResult

Deprovision a CIDR from a public IPv4 pool.

Examples:

Request syntax with placeholder values


resp = client.deprovision_public_ipv_4_pool_cidr({
  dry_run: false,
  pool_id: "Ipv4PoolEc2Id", # required
  cidr: "String", # required
})

Response structure


resp.pool_id #=> String
resp.deprovisioned_addresses #=> Array
resp.deprovisioned_addresses[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :pool_id (required, String) —

    The ID of the pool that you want to deprovision the CIDR from.

  • :cidr (required, 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.

Returns:

See Also:



19660
19661
19662
19663
 
# File 'lib/aws-sdk-ec2/client.rb', line 19660

def deprovision_public_ipv_4_pool_cidr(params = {}, options = {})
  req = build_request(:deprovision_public_ipv_4_pool_cidr, params)
  req.send_request(options)
end

#deregister_image(params = {}) ⇒ Struct

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html

Examples:

Request syntax with placeholder values


resp = client.deregister_image({
  image_id: "ImageId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19709
19710
19711
19712
 
# File 'lib/aws-sdk-ec2/client.rb', line 19709

def deregister_image(params = {}, options = {})
  req = build_request(:deregister_image, params)
  req.send_request(options)
end

#deregister_instance_event_notification_attributes(params = {}) ⇒ Types::DeregisterInstanceEventNotificationAttributesResult

Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.

Examples:

Request syntax with placeholder values


resp = client.deregister_instance_event_notification_attributes({
  dry_run: false,
  instance_tag_attribute: { # required
    include_all_tags_of_instance: false,
    instance_tag_keys: ["String"],
  },
})

Response structure


resp.instance_tag_attribute.instance_tag_keys #=> Array
resp.instance_tag_attribute.instance_tag_keys[0] #=> String
resp.instance_tag_attribute.include_all_tags_of_instance #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_tag_attribute (required, Types::DeregisterInstanceTagAttributeRequest) —

    Information about the tag keys to deregister.

Returns:

See Also:



19751
19752
19753
19754
 
# File 'lib/aws-sdk-ec2/client.rb', line 19751

def deregister_instance_event_notification_attributes(params = {}, options = {})
  req = build_request(:deregister_instance_event_notification_attributes, params)
  req.send_request(options)
end

#deregister_transit_gateway_multicast_group_members(params = {}) ⇒ Types::DeregisterTransitGatewayMulticastGroupMembersResult

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

Examples:

Request syntax with placeholder values


resp = client.deregister_transit_gateway_multicast_group_members({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId",
  group_ip_address: "String",
  network_interface_ids: ["NetworkInterfaceId"],
  dry_run: false,
})

Response structure


resp.deregistered_multicast_group_members.transit_gateway_multicast_domain_id #=> String
resp.deregistered_multicast_group_members.deregistered_network_interface_ids #=> Array
resp.deregistered_multicast_group_members.deregistered_network_interface_ids[0] #=> String
resp.deregistered_multicast_group_members.group_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (String) —

    The ID of the transit gateway multicast domain.

  • :group_ip_address (String) —

    The IP address assigned to the transit gateway multicast group.

  • :network_interface_ids (Array<String>) —

    The IDs of the group members’ network interfaces.

  • :dry_run (Boolean) —

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

Returns:

See Also:



19798
19799
19800
19801
 
# File 'lib/aws-sdk-ec2/client.rb', line 19798

def deregister_transit_gateway_multicast_group_members(params = {}, options = {})
  req = build_request(:deregister_transit_gateway_multicast_group_members, params)
  req.send_request(options)
end

#deregister_transit_gateway_multicast_group_sources(params = {}) ⇒ Types::DeregisterTransitGatewayMulticastGroupSourcesResult

Deregisters the specified sources (network interfaces) from the transit gateway multicast group.

Examples:

Request syntax with placeholder values


resp = client.deregister_transit_gateway_multicast_group_sources({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId",
  group_ip_address: "String",
  network_interface_ids: ["NetworkInterfaceId"],
  dry_run: false,
})

Response structure


resp.deregistered_multicast_group_sources.transit_gateway_multicast_domain_id #=> String
resp.deregistered_multicast_group_sources.deregistered_network_interface_ids #=> Array
resp.deregistered_multicast_group_sources.deregistered_network_interface_ids[0] #=> String
resp.deregistered_multicast_group_sources.group_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (String) —

    The ID of the transit gateway multicast domain.

  • :group_ip_address (String) —

    The IP address assigned to the transit gateway multicast group.

  • :network_interface_ids (Array<String>) —

    The IDs of the group sources’ network interfaces.

  • :dry_run (Boolean) —

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

Returns:

See Also:



19845
19846
19847
19848
 
# File 'lib/aws-sdk-ec2/client.rb', line 19845

def deregister_transit_gateway_multicast_group_sources(params = {}, options = {})
  req = build_request(:deregister_transit_gateway_multicast_group_sources, params)
  req.send_request(options)
end

#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResult

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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-on-demand-instances.html#ec2-on-demand-instances-limits

Examples:

Example: To describe a single attribute for your AWS account


# This example describes the supported-platforms attribute for your AWS account.

resp = client.({
  attribute_names: [
    "supported-platforms", 
  ], 
})

resp.to_h outputs the following:
{
  account_attributes: [
    {
      attribute_name: "supported-platforms", 
      attribute_values: [
        {
          attribute_value: "EC2", 
        }, 
        {
          attribute_value: "VPC", 
        }, 
      ], 
    }, 
  ], 
}

Example: To describe all attributes for your AWS account


# This example describes the attributes for your AWS account.

resp = client.({
})

resp.to_h outputs the following:
{
  account_attributes: [
    {
      attribute_name: "supported-platforms", 
      attribute_values: [
        {
          attribute_value: "EC2", 
        }, 
        {
          attribute_value: "VPC", 
        }, 
      ], 
    }, 
    {
      attribute_name: "vpc-max-security-groups-per-interface", 
      attribute_values: [
        {
          attribute_value: "5", 
        }, 
      ], 
    }, 
    {
      attribute_name: "max-elastic-ips", 
      attribute_values: [
        {
          attribute_value: "5", 
        }, 
      ], 
    }, 
    {
      attribute_name: "max-instances", 
      attribute_values: [
        {
          attribute_value: "20", 
        }, 
      ], 
    }, 
    {
      attribute_name: "vpc-max-elastic-ips", 
      attribute_values: [
        {
          attribute_value: "5", 
        }, 
      ], 
    }, 
    {
      attribute_name: "default-vpc", 
      attribute_values: [
        {
          attribute_value: "none", 
        }, 
      ], 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.({
  dry_run: false,
  attribute_names: ["supported-platforms"], # accepts supported-platforms, default-vpc
})

Response structure


resp. #=> Array
resp.[0].attribute_name #=> String
resp.[0].attribute_values #=> Array
resp.[0].attribute_values[0].attribute_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :attribute_names (Array<String>) —

    The account attribute names.

Returns:

See Also:



20005
20006
20007
20008
 
# File 'lib/aws-sdk-ec2/client.rb', line 20005

def (params = {}, options = {})
  req = build_request(:describe_account_attributes, params)
  req.send_request(options)
end

#describe_address_transfers(params = {}) ⇒ Types::DescribeAddressTransfersResult

Describes an Elastic IP address transfer. For more information, see

Transfer Elastic IP addresses][1

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.

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_address_transfers({
  allocation_ids: ["AllocationId"],
  next_token: "String",
  max_results: 1,
  dry_run: false,
})

Response structure


resp.address_transfers #=> Array
resp.address_transfers[0].public_ip #=> String
resp.address_transfers[0].allocation_id #=> String
resp.address_transfers[0]. #=> String
resp.address_transfers[0].transfer_offer_expiration_timestamp #=> Time
resp.address_transfers[0].transfer_offer_accepted_timestamp #=> Time
resp.address_transfers[0].address_transfer_status #=> String, one of "pending", "disabled", "accepted"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_ids (Array<String>) —

    The allocation IDs of Elastic IP addresses.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of address transfers to return in one page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



20075
20076
20077
20078
 
# File 'lib/aws-sdk-ec2/client.rb', line 20075

def describe_address_transfers(params = {}, options = {})
  req = build_request(:describe_address_transfers, params)
  req.send_request(options)
end

#describe_addresses(params = {}) ⇒ Types::DescribeAddressesResult

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

Examples:

Example: To describe your Elastic IP addresses


# This example describes your Elastic IP addresses.

resp = client.describe_addresses({
})

resp.to_h outputs the following:
{
  addresses: [
    {
      domain: "standard", 
      instance_id: "i-1234567890abcdef0", 
      public_ip: "198.51.100.0", 
    }, 
    {
      allocation_id: "eipalloc-12345678", 
      association_id: "eipassoc-12345678", 
      domain: "vpc", 
      instance_id: "i-1234567890abcdef0", 
      network_interface_id: "eni-12345678", 
      network_interface_owner_id: "123456789012", 
      private_ip_address: "10.0.1.241", 
      public_ip: "203.0.113.0", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_addresses({
  public_ips: ["String"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  allocation_ids: ["AllocationId"],
})

Response structure


resp.addresses #=> Array
resp.addresses[0].allocation_id #=> String
resp.addresses[0].association_id #=> String
resp.addresses[0].domain #=> String, one of "vpc", "standard"
resp.addresses[0].network_interface_id #=> String
resp.addresses[0].network_interface_owner_id #=> String
resp.addresses[0].private_ip_address #=> String
resp.addresses[0].tags #=> Array
resp.addresses[0].tags[0].key #=> String
resp.addresses[0].tags[0].value #=> String
resp.addresses[0].public_ipv_4_pool #=> String
resp.addresses[0].network_border_group #=> String
resp.addresses[0].customer_owned_ip #=> String
resp.addresses[0].customer_owned_ipv_4_pool #=> String
resp.addresses[0].carrier_ip #=> String
resp.addresses[0].instance_id #=> String
resp.addresses[0].public_ip #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :public_ips (Array<String>) —

    One or more Elastic IP addresses.

    Default: Describes all your Elastic IP addresses.

  • :dry_run (Boolean) —

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

    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`:&lt;key&gt; - 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.

  • :allocation_ids (Array<String>) —

    Information about the allocation IDs.

Returns:

See Also:



20203
20204
20205
20206
 
# File 'lib/aws-sdk-ec2/client.rb', line 20203

def describe_addresses(params = {}, options = {})
  req = build_request(:describe_addresses, params)
  req.send_request(options)
end

#describe_addresses_attribute(params = {}) ⇒ Types::DescribeAddressesAttributeResult

Describes the attributes of the specified Elastic IP addresses. For requirements, see [Using reverse DNS for email applications].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_addresses_attribute({
  allocation_ids: ["AllocationId"],
  attribute: "domain-name", # accepts domain-name
  next_token: "NextToken",
  max_results: 1,
  dry_run: false,
})

Response structure


resp.addresses #=> Array
resp.addresses[0].public_ip #=> String
resp.addresses[0].allocation_id #=> String
resp.addresses[0].ptr_record #=> String
resp.addresses[0].ptr_record_update.value #=> String
resp.addresses[0].ptr_record_update.status #=> String
resp.addresses[0].ptr_record_update.reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_ids (Array<String>) —

    [EC2-VPC] The allocation IDs.

  • :attribute (String) —

    The attribute of the IP address.

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



20267
20268
20269
20270
 
# File 'lib/aws-sdk-ec2/client.rb', line 20267

def describe_addresses_attribute(params = {}, options = {})
  req = build_request(:describe_addresses_attribute, params)
  req.send_request(options)
end

#describe_aggregate_id_format(params = {}) ⇒ Types::DescribeAggregateIdFormatResult

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

Examples:

Request syntax with placeholder values


resp = client.describe_aggregate_id_format({
  dry_run: false,
})

Response structure


resp.use_long_ids_aggregated #=> Boolean
resp.statuses #=> Array
resp.statuses[0].deadline #=> Time
resp.statuses[0].resource #=> String
resp.statuses[0].use_long_ids #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



20321
20322
20323
20324
 
# File 'lib/aws-sdk-ec2/client.rb', line 20321

def describe_aggregate_id_format(params = {}, options = {})
  req = build_request(:describe_aggregate_id_format, params)
  req.send_request(options)
end

#describe_availability_zones(params = {}) ⇒ Types::DescribeAvailabilityZonesResult

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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html

Examples:

Example: 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.

resp = client.describe_availability_zones({
})

resp.to_h outputs the following:
{
  availability_zones: [
    {
      messages: [
      ], 
      region_name: "us-east-1", 
      state: "available", 
      zone_name: "us-east-1b", 
    }, 
    {
      messages: [
      ], 
      region_name: "us-east-1", 
      state: "available", 
      zone_name: "us-east-1c", 
    }, 
    {
      messages: [
      ], 
      region_name: "us-east-1", 
      state: "available", 
      zone_name: "us-east-1d", 
    }, 
    {
      messages: [
      ], 
      region_name: "us-east-1", 
      state: "available", 
      zone_name: "us-east-1e", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_availability_zones({
  zone_names: ["String"],
  zone_ids: ["String"],
  all_availability_zones: false,
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.availability_zones #=> Array
resp.availability_zones[0].opt_in_status #=> String, one of "opt-in-not-required", "opted-in", "not-opted-in"
resp.availability_zones[0].messages #=> Array
resp.availability_zones[0].messages[0].message #=> String
resp.availability_zones[0].region_name #=> String
resp.availability_zones[0].zone_name #=> String
resp.availability_zones[0].zone_id #=> String
resp.availability_zones[0].group_name #=> String
resp.availability_zones[0].network_border_group #=> String
resp.availability_zones[0].zone_type #=> String
resp.availability_zones[0].parent_zone_name #=> String
resp.availability_zones[0].parent_zone_id #=> String
resp.availability_zones[0].state #=> String, one of "available", "information", "impaired", "unavailable", "constrained"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :zone_names (Array<String>) —

    The names of the Availability Zones, Local Zones, and Wavelength Zones.

  • :zone_ids (Array<String>) —

    The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

  • :all_availability_zones (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.

  • :dry_run (Boolean) —

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

    The filters.

    • ‘group-name` - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, `us-west-2-lax-1`) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, `us-east-1-wl1`).

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

Returns:

See Also:



20486
20487
20488
20489
 
# File 'lib/aws-sdk-ec2/client.rb', line 20486

def describe_availability_zones(params = {}, options = {})
  req = build_request(:describe_availability_zones, params)
  req.send_request(options)
end

#describe_aws_network_performance_metric_subscriptions(params = {}) ⇒ Types::DescribeAwsNetworkPerformanceMetricSubscriptionsResult

Describes the current Infrastructure Performance metric subscriptions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_aws_network_performance_metric_subscriptions({
  max_results: 1,
  next_token: "String",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.next_token #=> String
resp.subscriptions #=> Array
resp.subscriptions[0].source #=> String
resp.subscriptions[0].destination #=> String
resp.subscriptions[0].metric #=> String, one of "aggregate-latency"
resp.subscriptions[0].statistic #=> String, one of "p50"
resp.subscriptions[0].period #=> String, one of "five-minutes", "fifteen-minutes", "one-hour", "three-hours", "one-day", "one-week"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters.

  • :dry_run (Boolean) —

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

Returns:

See Also:



20545
20546
20547
20548
 
# File 'lib/aws-sdk-ec2/client.rb', line 20545

def describe_aws_network_performance_metric_subscriptions(params = {}, options = {})
  req = build_request(:describe_aws_network_performance_metric_subscriptions, params)
  req.send_request(options)
end

#describe_bundle_tasks(params = {}) ⇒ Types::DescribeBundleTasksResult

Describes the specified bundle tasks or all of your bundle tasks.

<note markdown=“1”> 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>

<note markdown=“1”> 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.

</note>

The following waiters are defined for this operation (see #wait_until for detailed usage):

* bundle_task_complete

Examples:

Request syntax with placeholder values


resp = client.describe_bundle_tasks({
  bundle_ids: ["BundleId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.bundle_tasks #=> Array
resp.bundle_tasks[0].instance_id #=> String
resp.bundle_tasks[0].bundle_id #=> String
resp.bundle_tasks[0].state #=> String, one of "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed"
resp.bundle_tasks[0].start_time #=> Time
resp.bundle_tasks[0].update_time #=> Time
resp.bundle_tasks[0].storage.s3.aws_access_key_id #=> String
resp.bundle_tasks[0].storage.s3.bucket #=> String
resp.bundle_tasks[0].storage.s3.prefix #=> String
resp.bundle_tasks[0].storage.s3.upload_policy #=> String
resp.bundle_tasks[0].storage.s3.upload_policy_signature #=> String
resp.bundle_tasks[0].progress #=> String
resp.bundle_tasks[0].bundle_task_error.code #=> String
resp.bundle_tasks[0].bundle_task_error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bundle_ids (Array<String>) —

    The bundle task IDs.

    Default: Describes all your bundle tasks.

  • :dry_run (Boolean) —

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

    The filters.

    • ‘bundle-id` - The ID of the bundle task.

    • ‘error-code` - If the task failed, the error code returned.

    • ‘error-message` - If the task failed, the error message returned.

    • ‘instance-id` - The ID of the instance.

    • ‘progress` - The level of task completion, as a percentage (for example, 20%).

    • ‘s3-bucket` - The Amazon S3 bucket to store the AMI.

    • ‘s3-prefix` - The beginning of the AMI name.

    • ‘start-time` - The time the task started (for example, 2013-09-15T17:15:20.000Z).

    • ‘state` - The state of the task (`pending` | `waiting-for-shutdown` | `bundling` | `storing` | `cancelling` | `complete` | `failed`).

    • ‘update-time` - The time of the most recent update for the task.

Returns:

See Also:



20646
20647
20648
20649
 
# File 'lib/aws-sdk-ec2/client.rb', line 20646

def describe_bundle_tasks(params = {}, options = {})
  req = build_request(:describe_bundle_tasks, params)
  req.send_request(options)
end

#describe_byoip_cidrs(params = {}) ⇒ Types::DescribeByoipCidrsResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_byoip_cidrs({
  dry_run: false,
  max_results: 1, # required
  next_token: "NextToken",
})

Response structure


resp.byoip_cidrs #=> Array
resp.byoip_cidrs[0].cidr #=> String
resp.byoip_cidrs[0].description #=> String
resp.byoip_cidrs[0].asn_associations #=> Array
resp.byoip_cidrs[0].asn_associations[0].asn #=> String
resp.byoip_cidrs[0].asn_associations[0].cidr #=> String
resp.byoip_cidrs[0].asn_associations[0].status_message #=> String
resp.byoip_cidrs[0].asn_associations[0].state #=> String, one of "disassociated", "failed-disassociation", "failed-association", "pending-disassociation", "pending-association", "associated"
resp.byoip_cidrs[0].status_message #=> String
resp.byoip_cidrs[0].state #=> String, one of "advertised", "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned", "provisioned-not-publicly-advertisable"
resp.byoip_cidrs[0].network_border_group #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :max_results (required, 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.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



20705
20706
20707
20708
 
# File 'lib/aws-sdk-ec2/client.rb', line 20705

def describe_byoip_cidrs(params = {}, options = {})
  req = build_request(:describe_byoip_cidrs, params)
  req.send_request(options)
end

#describe_capacity_block_offerings(params = {}) ⇒ Types::DescribeCapacityBlockOfferingsResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_capacity_block_offerings({
  dry_run: false,
  instance_type: "String",
  instance_count: 1,
  start_date_range: Time.now,
  end_date_range: Time.now,
  capacity_duration_hours: 1, # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.capacity_block_offerings #=> Array
resp.capacity_block_offerings[0].capacity_block_offering_id #=> String
resp.capacity_block_offerings[0].instance_type #=> String
resp.capacity_block_offerings[0].availability_zone #=> String
resp.capacity_block_offerings[0].instance_count #=> Integer
resp.capacity_block_offerings[0].start_date #=> Time
resp.capacity_block_offerings[0].end_date #=> Time
resp.capacity_block_offerings[0].capacity_block_duration_hours #=> Integer
resp.capacity_block_offerings[0].upfront_fee #=> String
resp.capacity_block_offerings[0].currency_code #=> String
resp.capacity_block_offerings[0].tenancy #=> String, one of "default", "dedicated"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_type (String) —

    The type of instance for which the Capacity Block offering reserves capacity.

  • :instance_count (Integer) —

    The number of instances for which to reserve capacity.

  • :start_date_range (Time, DateTime, Date, Integer, String) —

    The earliest start date for the Capacity Block offering.

  • :end_date_range (Time, DateTime, Date, Integer, String) —

    The latest end date for the Capacity Block offering.

  • :capacity_duration_hours (required, Integer) —

    The number of hours for which to reserve Capacity Block.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



20787
20788
20789
20790
 
# File 'lib/aws-sdk-ec2/client.rb', line 20787

def describe_capacity_block_offerings(params = {}, options = {})
  req = build_request(:describe_capacity_block_offerings, params)
  req.send_request(options)
end

#describe_capacity_reservation_billing_requests(params = {}) ⇒ Types::DescribeCapacityReservationBillingRequestsResult

Describes a request to assign the billing of the unused capacity of a Capacity Reservation. For more information, see [ Billing assignment for shared Amazon EC2 Capacity Reservations].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/transfer-billing.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_capacity_reservation_billing_requests({
  capacity_reservation_ids: ["CapacityReservationId"],
  role: "odcr-owner", # required, accepts odcr-owner, unused-reservation-billing-owner
  next_token: "String",
  max_results: 1,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.next_token #=> String
resp.capacity_reservation_billing_requests #=> Array
resp.capacity_reservation_billing_requests[0].capacity_reservation_id #=> String
resp.capacity_reservation_billing_requests[0].requested_by #=> String
resp.capacity_reservation_billing_requests[0].unused_reservation_billing_owner_id #=> String
resp.capacity_reservation_billing_requests[0].last_update_time #=> Time
resp.capacity_reservation_billing_requests[0].status #=> String, one of "pending", "accepted", "rejected", "cancelled", "revoked", "expired"
resp.capacity_reservation_billing_requests[0].status_message #=> String
resp.capacity_reservation_billing_requests[0].capacity_reservation_info.instance_type #=> String
resp.capacity_reservation_billing_requests[0].capacity_reservation_info.availability_zone #=> String
resp.capacity_reservation_billing_requests[0].capacity_reservation_info.tenancy #=> String, one of "default", "dedicated"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_reservation_ids (Array<String>) —

    The ID of the Capacity Reservation.

  • :role (required, String) —

    Specify one of the following:

    • ‘odcr-owner` - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the `requested-by` filter.

    • ‘unused-reservation-billing-owner` - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the `unused-reservation-billing-owner` filter.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘status` - The state of the request (`pending` | `accepted` | `rejected` | `cancelled` | `revoked` | `expired`).

    • ‘requested-by` - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify `requested-by` for Role.

    • ‘unused-reservation-billing-owner` - The ID of the consumer account to which the request was sent. Not supported if you specify `unused-reservation-billing-owner` for Role.

  • :dry_run (Boolean) —

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

Returns:

See Also:



20888
20889
20890
20891
 
# File 'lib/aws-sdk-ec2/client.rb', line 20888

def describe_capacity_reservation_billing_requests(params = {}, options = {})
  req = build_request(:describe_capacity_reservation_billing_requests, params)
  req.send_request(options)
end

#describe_capacity_reservation_fleets(params = {}) ⇒ Types::DescribeCapacityReservationFleetsResult

Describes one or more Capacity Reservation Fleets.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_capacity_reservation_fleets({
  capacity_reservation_fleet_ids: ["CapacityReservationFleetId"],
  next_token: "String",
  max_results: 1,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.capacity_reservation_fleets #=> Array
resp.capacity_reservation_fleets[0].capacity_reservation_fleet_id #=> String
resp.capacity_reservation_fleets[0].capacity_reservation_fleet_arn #=> String
resp.capacity_reservation_fleets[0].state #=> String, one of "submitted", "modifying", "active", "partially_fulfilled", "expiring", "expired", "cancelling", "cancelled", "failed"
resp.capacity_reservation_fleets[0].total_target_capacity #=> Integer
resp.capacity_reservation_fleets[0].total_fulfilled_capacity #=> Float
resp.capacity_reservation_fleets[0].tenancy #=> String, one of "default"
resp.capacity_reservation_fleets[0].end_date #=> Time
resp.capacity_reservation_fleets[0].create_time #=> Time
resp.capacity_reservation_fleets[0].instance_match_criteria #=> String, one of "open"
resp.capacity_reservation_fleets[0].allocation_strategy #=> String
resp.capacity_reservation_fleets[0].instance_type_specifications #=> Array
resp.capacity_reservation_fleets[0].instance_type_specifications[0].capacity_reservation_id #=> String
resp.capacity_reservation_fleets[0].instance_type_specifications[0].availability_zone_id #=> String
resp.capacity_reservation_fleets[0].instance_type_specifications[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.capacity_reservation_fleets[0].instance_type_specifications[0].instance_platform #=> String, one of "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"
resp.capacity_reservation_fleets[0].instance_type_specifications[0].availability_zone #=> String
resp.capacity_reservation_fleets[0].instance_type_specifications[0].total_instance_count #=> Integer
resp.capacity_reservation_fleets[0].instance_type_specifications[0].fulfilled_capacity #=> Float
resp.capacity_reservation_fleets[0].instance_type_specifications[0].ebs_optimized #=> Boolean
resp.capacity_reservation_fleets[0].instance_type_specifications[0].create_date #=> Time
resp.capacity_reservation_fleets[0].instance_type_specifications[0].weight #=> Float
resp.capacity_reservation_fleets[0].instance_type_specifications[0].priority #=> Integer
resp.capacity_reservation_fleets[0].tags #=> Array
resp.capacity_reservation_fleets[0].tags[0].key #=> String
resp.capacity_reservation_fleets[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_reservation_fleet_ids (Array<String>) —

    The IDs of the Capacity Reservation Fleets to describe.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :filters (Array<Types::Filter>) —

    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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



20987
20988
20989
20990
 
# File 'lib/aws-sdk-ec2/client.rb', line 20987

def describe_capacity_reservation_fleets(params = {}, options = {})
  req = build_request(:describe_capacity_reservation_fleets, params)
  req.send_request(options)
end

#describe_capacity_reservations(params = {}) ⇒ Types::DescribeCapacityReservationsResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_capacity_reservations({
  capacity_reservation_ids: ["CapacityReservationId"],
  next_token: "String",
  max_results: 1,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.next_token #=> String
resp.capacity_reservations #=> Array
resp.capacity_reservations[0].capacity_reservation_id #=> String
resp.capacity_reservations[0].owner_id #=> String
resp.capacity_reservations[0].capacity_reservation_arn #=> String
resp.capacity_reservations[0].availability_zone_id #=> String
resp.capacity_reservations[0].instance_type #=> String
resp.capacity_reservations[0].instance_platform #=> String, one of "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"
resp.capacity_reservations[0].availability_zone #=> String
resp.capacity_reservations[0].tenancy #=> String, one of "default", "dedicated"
resp.capacity_reservations[0].total_instance_count #=> Integer
resp.capacity_reservations[0].available_instance_count #=> Integer
resp.capacity_reservations[0].ebs_optimized #=> Boolean
resp.capacity_reservations[0].ephemeral_storage #=> Boolean
resp.capacity_reservations[0].state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "scheduled", "payment-pending", "payment-failed"
resp.capacity_reservations[0].start_date #=> Time
resp.capacity_reservations[0].end_date #=> Time
resp.capacity_reservations[0].end_date_type #=> String, one of "unlimited", "limited"
resp.capacity_reservations[0].instance_match_criteria #=> String, one of "open", "targeted"
resp.capacity_reservations[0].create_date #=> Time
resp.capacity_reservations[0].tags #=> Array
resp.capacity_reservations[0].tags[0].key #=> String
resp.capacity_reservations[0].tags[0].value #=> String
resp.capacity_reservations[0].outpost_arn #=> String
resp.capacity_reservations[0].capacity_reservation_fleet_id #=> String
resp.capacity_reservations[0].placement_group_arn #=> String
resp.capacity_reservations[0].capacity_allocations #=> Array
resp.capacity_reservations[0].capacity_allocations[0].allocation_type #=> String, one of "used"
resp.capacity_reservations[0].capacity_allocations[0].count #=> Integer
resp.capacity_reservations[0].reservation_type #=> String, one of "default", "capacity-block"
resp.capacity_reservations[0].unused_reservation_billing_owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_reservation_ids (Array<String>) —

    The ID of the Capacity Reservation.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :filters (Array<Types::Filter>) —

    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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



21163
21164
21165
21166
 
# File 'lib/aws-sdk-ec2/client.rb', line 21163

def describe_capacity_reservations(params = {}, options = {})
  req = build_request(:describe_capacity_reservations, params)
  req.send_request(options)
end

#describe_carrier_gateways(params = {}) ⇒ Types::DescribeCarrierGatewaysResult

Describes one or more of your carrier gateways.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_carrier_gateways({
  carrier_gateway_ids: ["CarrierGatewayId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.carrier_gateways #=> Array
resp.carrier_gateways[0].carrier_gateway_id #=> String
resp.carrier_gateways[0].vpc_id #=> String
resp.carrier_gateways[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.carrier_gateways[0].owner_id #=> String
resp.carrier_gateways[0].tags #=> Array
resp.carrier_gateways[0].tags[0].key #=> String
resp.carrier_gateways[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :carrier_gateway_ids (Array<String>) —

    One or more carrier gateway IDs.

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘carrier-gateway-id` - The ID of the carrier gateway.

    • ‘state` - The state of the carrier gateway (`pending` | `failed` | `available` | `deleting` | `deleted`).

    • ‘owner-id` - The Amazon Web Services account ID of the owner of the carrier gateway.

    • ‘tag`:&lt;key&gt; - 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.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



21248
21249
21250
21251
 
# File 'lib/aws-sdk-ec2/client.rb', line 21248

def describe_carrier_gateways(params = {}, options = {})
  req = build_request(:describe_carrier_gateways, params)
  req.send_request(options)
end

#describe_classic_link_instances(params = {}) ⇒ Types::DescribeClassicLinkInstancesResult

<note markdown=“1”> This action is deprecated.

</note>

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_classic_link_instances({
  dry_run: false,
  instance_ids: ["InstanceId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.instances #=> Array
resp.instances[0].groups #=> Array
resp.instances[0].groups[0].group_id #=> String
resp.instances[0].groups[0].group_name #=> String
resp.instances[0].instance_id #=> String
resp.instances[0].tags #=> Array
resp.instances[0].tags[0].key #=> String
resp.instances[0].tags[0].value #=> String
resp.instances[0].vpc_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_ids (Array<String>) —

    The instance IDs. Must be instances linked to a VPC through ClassicLink.

  • :filters (Array<Types::Filter>) —

    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`:&lt;key&gt; - 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.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



21347
21348
21349
21350
 
# File 'lib/aws-sdk-ec2/client.rb', line 21347

def describe_classic_link_instances(params = {}, options = {})
  req = build_request(:describe_classic_link_instances, params)
  req.send_request(options)
end

#describe_client_vpn_authorization_rules(params = {}) ⇒ Types::DescribeClientVpnAuthorizationRulesResult

Describes the authorization rules for a specified Client VPN endpoint.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_client_vpn_authorization_rules({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  dry_run: false,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
})

Response structure


resp.authorization_rules #=> Array
resp.authorization_rules[0].client_vpn_endpoint_id #=> String
resp.authorization_rules[0].description #=> String
resp.authorization_rules[0].group_id #=> String
resp.authorization_rules[0].access_all #=> Boolean
resp.authorization_rules[0].destination_cidr #=> String
resp.authorization_rules[0].status.code #=> String, one of "authorizing", "active", "failed", "revoking"
resp.authorization_rules[0].status.message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint.

  • :dry_run (Boolean) —

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

  • :next_token (String) —

    The token to retrieve the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

    • ‘description` - The description of the authorization rule.

    • ‘destination-cidr` - The CIDR of the network to which the authorization rule applies.

    • ‘group-id` - The ID of the Active Directory group to which the authorization rule grants access.

  • :max_results (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.

Returns:

See Also:



21420
21421
21422
21423
 
# File 'lib/aws-sdk-ec2/client.rb', line 21420

def describe_client_vpn_authorization_rules(params = {}, options = {})
  req = build_request(:describe_client_vpn_authorization_rules, params)
  req.send_request(options)
end

#describe_client_vpn_connections(params = {}) ⇒ Types::DescribeClientVpnConnectionsResult

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_client_vpn_connections({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  dry_run: false,
})

Response structure


resp.connections #=> Array
resp.connections[0].client_vpn_endpoint_id #=> String
resp.connections[0].timestamp #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].username #=> String
resp.connections[0].connection_established_time #=> String
resp.connections[0].ingress_bytes #=> String
resp.connections[0].egress_bytes #=> String
resp.connections[0].ingress_packets #=> String
resp.connections[0].egress_packets #=> String
resp.connections[0].client_ip #=> String
resp.connections[0].common_name #=> String
resp.connections[0].status.code #=> String, one of "active", "failed-to-terminate", "terminating", "terminated"
resp.connections[0].status.message #=> String
resp.connections[0].connection_end_time #=> String
resp.connections[0].posture_compliance_statuses #=> Array
resp.connections[0].posture_compliance_statuses[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

    • ‘connection-id` - The ID of the connection.

    • ‘username` - For Active Directory client authentication, the user name of the client who established the client connection.

  • :next_token (String) —

    The token to retrieve the next page of results.

  • :max_results (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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



21501
21502
21503
21504
 
# File 'lib/aws-sdk-ec2/client.rb', line 21501

def describe_client_vpn_connections(params = {}, options = {})
  req = build_request(:describe_client_vpn_connections, params)
  req.send_request(options)
end

#describe_client_vpn_endpoints(params = {}) ⇒ Types::DescribeClientVpnEndpointsResult

Describes one or more Client VPN endpoints in the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_client_vpn_endpoints({
  client_vpn_endpoint_ids: ["ClientVpnEndpointId"],
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.client_vpn_endpoints #=> Array
resp.client_vpn_endpoints[0].client_vpn_endpoint_id #=> String
resp.client_vpn_endpoints[0].description #=> String
resp.client_vpn_endpoints[0].status.code #=> String, one of "pending-associate", "available", "deleting", "deleted"
resp.client_vpn_endpoints[0].status.message #=> String
resp.client_vpn_endpoints[0].creation_time #=> String
resp.client_vpn_endpoints[0].deletion_time #=> String
resp.client_vpn_endpoints[0].dns_name #=> String
resp.client_vpn_endpoints[0].client_cidr_block #=> String
resp.client_vpn_endpoints[0].dns_servers #=> Array
resp.client_vpn_endpoints[0].dns_servers[0] #=> String
resp.client_vpn_endpoints[0].split_tunnel #=> Boolean
resp.client_vpn_endpoints[0].vpn_protocol #=> String, one of "openvpn"
resp.client_vpn_endpoints[0].transport_protocol #=> String, one of "tcp", "udp"
resp.client_vpn_endpoints[0].vpn_port #=> Integer
resp.client_vpn_endpoints[0].associated_target_networks #=> Array
resp.client_vpn_endpoints[0].associated_target_networks[0].network_id #=> String
resp.client_vpn_endpoints[0].associated_target_networks[0].network_type #=> String, one of "vpc"
resp.client_vpn_endpoints[0].server_certificate_arn #=> String
resp.client_vpn_endpoints[0].authentication_options #=> Array
resp.client_vpn_endpoints[0].authentication_options[0].type #=> String, one of "certificate-authentication", "directory-service-authentication", "federated-authentication"
resp.client_vpn_endpoints[0].authentication_options[0].active_directory.directory_id #=> String
resp.client_vpn_endpoints[0].authentication_options[0].mutual_authentication.client_root_certificate_chain #=> String
resp.client_vpn_endpoints[0].authentication_options[0].federated_authentication.saml_provider_arn #=> String
resp.client_vpn_endpoints[0].authentication_options[0].federated_authentication.self_service_saml_provider_arn #=> String
resp.client_vpn_endpoints[0].connection_log_options.enabled #=> Boolean
resp.client_vpn_endpoints[0].connection_log_options.cloudwatch_log_group #=> String
resp.client_vpn_endpoints[0].connection_log_options.cloudwatch_log_stream #=> String
resp.client_vpn_endpoints[0].tags #=> Array
resp.client_vpn_endpoints[0].tags[0].key #=> String
resp.client_vpn_endpoints[0].tags[0].value #=> String
resp.client_vpn_endpoints[0].security_group_ids #=> Array
resp.client_vpn_endpoints[0].security_group_ids[0] #=> String
resp.client_vpn_endpoints[0].vpc_id #=> String
resp.client_vpn_endpoints[0].self_service_portal_url #=> String
resp.client_vpn_endpoints[0].client_connect_options.enabled #=> Boolean
resp.client_vpn_endpoints[0].client_connect_options.lambda_function_arn #=> String
resp.client_vpn_endpoints[0].client_connect_options.status.code #=> String, one of "applying", "applied"
resp.client_vpn_endpoints[0].client_connect_options.status.message #=> String
resp.client_vpn_endpoints[0].session_timeout_hours #=> Integer
resp.client_vpn_endpoints[0]..enabled #=> Boolean
resp.client_vpn_endpoints[0]..banner_text #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_ids (Array<String>) —

    The ID of the Client VPN endpoint.

  • :max_results (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.

  • :next_token (String) —

    The token to retrieve the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

    • ‘endpoint-id` - The ID of the Client VPN endpoint.

    • ‘transport-protocol` - The transport protocol (`tcp` | `udp`).

  • :dry_run (Boolean) —

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

Returns:

See Also:



21604
21605
21606
21607
 
# File 'lib/aws-sdk-ec2/client.rb', line 21604

def describe_client_vpn_endpoints(params = {}, options = {})
  req = build_request(:describe_client_vpn_endpoints, params)
  req.send_request(options)
end

#describe_client_vpn_routes(params = {}) ⇒ Types::DescribeClientVpnRoutesResult

Describes the routes for the specified Client VPN endpoint.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_client_vpn_routes({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  dry_run: false,
})

Response structure


resp.routes #=> Array
resp.routes[0].client_vpn_endpoint_id #=> String
resp.routes[0].destination_cidr #=> String
resp.routes[0].target_subnet #=> String
resp.routes[0].type #=> String
resp.routes[0].origin #=> String
resp.routes[0].status.code #=> String, one of "creating", "active", "failed", "deleting"
resp.routes[0].status.message #=> String
resp.routes[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

    • ‘destination-cidr` - The CIDR of the route destination.

    • ‘origin` - How the route was associated with the Client VPN endpoint (`associate` | `add-route`).

    • ‘target-subnet` - The ID of the subnet through which traffic is routed.

  • :max_results (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.

  • :next_token (String) —

    The token to retrieve the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



21678
21679
21680
21681
 
# File 'lib/aws-sdk-ec2/client.rb', line 21678

def describe_client_vpn_routes(params = {}, options = {})
  req = build_request(:describe_client_vpn_routes, params)
  req.send_request(options)
end

#describe_client_vpn_target_networks(params = {}) ⇒ Types::DescribeClientVpnTargetNetworksResult

Describes the target networks associated with the specified Client VPN endpoint.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_client_vpn_target_networks({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  association_ids: ["String"],
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.client_vpn_target_networks #=> Array
resp.client_vpn_target_networks[0].association_id #=> String
resp.client_vpn_target_networks[0].vpc_id #=> String
resp.client_vpn_target_networks[0].target_network_id #=> String
resp.client_vpn_target_networks[0].client_vpn_endpoint_id #=> String
resp.client_vpn_target_networks[0].status.code #=> String, one of "associating", "associated", "association-failed", "disassociating", "disassociated"
resp.client_vpn_target_networks[0].status.message #=> String
resp.client_vpn_target_networks[0].security_groups #=> Array
resp.client_vpn_target_networks[0].security_groups[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint.

  • :association_ids (Array<String>) —

    The IDs of the target network associations.

  • :max_results (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.

  • :next_token (String) —

    The token to retrieve the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

    • ‘association-id` - The ID of the association.

    • ‘target-network-id` - The ID of the subnet specified as the target network.

    • ‘vpc-id` - The ID of the VPC in which the target network is located.

  • :dry_run (Boolean) —

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

Returns:

See Also:



21756
21757
21758
21759
 
# File 'lib/aws-sdk-ec2/client.rb', line 21756

def describe_client_vpn_target_networks(params = {}, options = {})
  req = build_request(:describe_client_vpn_target_networks, params)
  req.send_request(options)
end

#describe_coip_pools(params = {}) ⇒ Types::DescribeCoipPoolsResult

Describes the specified customer-owned address pools or all of your customer-owned address pools.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_coip_pools({
  pool_ids: ["Ipv4PoolCoipId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.coip_pools #=> Array
resp.coip_pools[0].pool_id #=> String
resp.coip_pools[0].pool_cidrs #=> Array
resp.coip_pools[0].pool_cidrs[0] #=> String
resp.coip_pools[0].local_gateway_route_table_id #=> String
resp.coip_pools[0].tags #=> Array
resp.coip_pools[0].tags[0].key #=> String
resp.coip_pools[0].tags[0].value #=> String
resp.coip_pools[0].pool_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_ids (Array<String>) —

    The IDs of the address pools.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



21828
21829
21830
21831
 
# File 'lib/aws-sdk-ec2/client.rb', line 21828

def describe_coip_pools(params = {}, options = {})
  req = build_request(:describe_coip_pools, params)
  req.send_request(options)
end

#describe_conversion_tasks(params = {}) ⇒ Types::DescribeConversionTasksResult

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

[1]: docs.aws.amazon.com/vm-import/latest/userguide/ [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html

The following waiters are defined for this operation (see #wait_until for detailed usage):

* conversion_task_cancelled
* conversion_task_completed
* conversion_task_deleted

Examples:

Request syntax with placeholder values


resp = client.describe_conversion_tasks({
  dry_run: false,
  conversion_task_ids: ["ConversionTaskId"],
})

Response structure


resp.conversion_tasks #=> Array
resp.conversion_tasks[0].conversion_task_id #=> String
resp.conversion_tasks[0].expiration_time #=> String
resp.conversion_tasks[0].import_instance.description #=> String
resp.conversion_tasks[0].import_instance.instance_id #=> String
resp.conversion_tasks[0].import_instance.platform #=> String, one of "Windows"
resp.conversion_tasks[0].import_instance.volumes #=> Array
resp.conversion_tasks[0].import_instance.volumes[0].availability_zone #=> String
resp.conversion_tasks[0].import_instance.volumes[0].bytes_converted #=> Integer
resp.conversion_tasks[0].import_instance.volumes[0].description #=> String
resp.conversion_tasks[0].import_instance.volumes[0].image.checksum #=> String
resp.conversion_tasks[0].import_instance.volumes[0].image.format #=> String, one of "VMDK", "RAW", "VHD"
resp.conversion_tasks[0].import_instance.volumes[0].image.import_manifest_url #=> String
resp.conversion_tasks[0].import_instance.volumes[0].image.size #=> Integer
resp.conversion_tasks[0].import_instance.volumes[0].status #=> String
resp.conversion_tasks[0].import_instance.volumes[0].status_message #=> String
resp.conversion_tasks[0].import_instance.volumes[0].volume.id #=> String
resp.conversion_tasks[0].import_instance.volumes[0].volume.size #=> Integer
resp.conversion_tasks[0].import_volume.availability_zone #=> String
resp.conversion_tasks[0].import_volume.bytes_converted #=> Integer
resp.conversion_tasks[0].import_volume.description #=> String
resp.conversion_tasks[0].import_volume.image.checksum #=> String
resp.conversion_tasks[0].import_volume.image.format #=> String, one of "VMDK", "RAW", "VHD"
resp.conversion_tasks[0].import_volume.image.import_manifest_url #=> String
resp.conversion_tasks[0].import_volume.image.size #=> Integer
resp.conversion_tasks[0].import_volume.volume.id #=> String
resp.conversion_tasks[0].import_volume.volume.size #=> Integer
resp.conversion_tasks[0].state #=> String, one of "active", "cancelling", "cancelled", "completed"
resp.conversion_tasks[0].status_message #=> String
resp.conversion_tasks[0].tags #=> Array
resp.conversion_tasks[0].tags[0].key #=> String
resp.conversion_tasks[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :conversion_task_ids (Array<String>) —

    The conversion task IDs.

Returns:

See Also:



21910
21911
21912
21913
 
# File 'lib/aws-sdk-ec2/client.rb', line 21910

def describe_conversion_tasks(params = {}, options = {})
  req = build_request(:describe_conversion_tasks, params)
  req.send_request(options)
end

#describe_customer_gateways(params = {}) ⇒ Types::DescribeCustomerGatewaysResult

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

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html

The following waiters are defined for this operation (see #wait_until for detailed usage):

* customer_gateway_available

Examples:

Example: To describe a customer gateway


# This example describes the specified customer gateway.

resp = client.describe_customer_gateways({
  customer_gateway_ids: [
    "cgw-0e11f167", 
  ], 
})

resp.to_h outputs the following:
{
  customer_gateways: [
    {
      bgp_asn: "65534", 
      customer_gateway_id: "cgw-0e11f167", 
      ip_address: "12.1.2.3", 
      state: "available", 
      type: "ipsec.1", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_customer_gateways({
  customer_gateway_ids: ["CustomerGatewayId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.customer_gateways #=> Array
resp.customer_gateways[0].certificate_arn #=> String
resp.customer_gateways[0].device_name #=> String
resp.customer_gateways[0].tags #=> Array
resp.customer_gateways[0].tags[0].key #=> String
resp.customer_gateways[0].tags[0].value #=> String
resp.customer_gateways[0].bgp_asn_extended #=> String
resp.customer_gateways[0].customer_gateway_id #=> String
resp.customer_gateways[0].state #=> String
resp.customer_gateways[0].type #=> String
resp.customer_gateways[0].ip_address #=> String
resp.customer_gateways[0].bgp_asn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :customer_gateway_ids (Array<String>) —

    One or more customer gateway IDs.

    Default: Describes all your customer gateways.

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘bgp-asn` - The customer gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

    • ‘customer-gateway-id` - The ID of the customer gateway.

    • ‘ip-address` - The IP address of the customer gateway 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`:&lt;key&gt; - 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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



22027
22028
22029
22030
 
# File 'lib/aws-sdk-ec2/client.rb', line 22027

def describe_customer_gateways(params = {}, options = {})
  req = build_request(:describe_customer_gateways, params)
  req.send_request(options)
end

#describe_dhcp_options(params = {}) ⇒ Types::DescribeDhcpOptionsResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe a DHCP options set


# This example describes the specified DHCP options set.

resp = client.describe_dhcp_options({
  dhcp_options_ids: [
    "dopt-d9070ebb", 
  ], 
})

resp.to_h outputs the following:
{
  dhcp_options: [
    {
      dhcp_configurations: [
        {
          key: "domain-name-servers", 
          values: [
            {
              value: "10.2.5.2", 
            }, 
            {
              value: "10.2.5.1", 
            }, 
          ], 
        }, 
      ], 
      dhcp_options_id: "dopt-d9070ebb", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_dhcp_options({
  dhcp_options_ids: ["DhcpOptionsId"],
  next_token: "String",
  max_results: 1,
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.dhcp_options #=> Array
resp.dhcp_options[0].owner_id #=> String
resp.dhcp_options[0].tags #=> Array
resp.dhcp_options[0].tags[0].key #=> String
resp.dhcp_options[0].tags[0].value #=> String
resp.dhcp_options[0].dhcp_options_id #=> String
resp.dhcp_options[0].dhcp_configurations #=> Array
resp.dhcp_options[0].dhcp_configurations[0].key #=> String
resp.dhcp_options[0].dhcp_configurations[0].values #=> Array
resp.dhcp_options[0].dhcp_configurations[0].values[0] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dhcp_options_ids (Array<String>) —

    The IDs of DHCP option sets.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

    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`:&lt;key&gt; - 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.

Returns:

See Also:



22161
22162
22163
22164
 
# File 'lib/aws-sdk-ec2/client.rb', line 22161

def describe_dhcp_options(params = {}, options = {})
  req = build_request(:describe_dhcp_options, params)
  req.send_request(options)
end

#describe_egress_only_internet_gateways(params = {}) ⇒ Types::DescribeEgressOnlyInternetGatewaysResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_egress_only_internet_gateways({
  dry_run: false,
  egress_only_internet_gateway_ids: ["EgressOnlyInternetGatewayId"],
  max_results: 1,
  next_token: "String",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.egress_only_internet_gateways #=> Array
resp.egress_only_internet_gateways[0].attachments #=> Array
resp.egress_only_internet_gateways[0].attachments[0].state #=> String, one of "attaching", "attached", "detaching", "detached"
resp.egress_only_internet_gateways[0].attachments[0].vpc_id #=> String
resp.egress_only_internet_gateways[0].egress_only_internet_gateway_id #=> String
resp.egress_only_internet_gateways[0].tags #=> Array
resp.egress_only_internet_gateways[0].tags[0].key #=> String
resp.egress_only_internet_gateways[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The IDs of the egress-only internet gateways.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘tag`:&lt;key&gt; - 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.

Returns:

See Also:



22245
22246
22247
22248
 
# File 'lib/aws-sdk-ec2/client.rb', line 22245

def describe_egress_only_internet_gateways(params = {}, options = {})
  req = build_request(:describe_egress_only_internet_gateways, params)
  req.send_request(options)
end

#describe_elastic_gpus(params = {}) ⇒ Types::DescribeElasticGpusResult

<note markdown=“1”> Amazon Elastic Graphics reached end of life on January 8, 2024.

</note>

Describes the Elastic Graphics accelerator associated with your instances.

Examples:

Request syntax with placeholder values


resp = client.describe_elastic_gpus({
  elastic_gpu_ids: ["ElasticGpuId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.elastic_gpu_set #=> Array
resp.elastic_gpu_set[0].elastic_gpu_id #=> String
resp.elastic_gpu_set[0].availability_zone #=> String
resp.elastic_gpu_set[0].elastic_gpu_type #=> String
resp.elastic_gpu_set[0].elastic_gpu_health.status #=> String, one of "OK", "IMPAIRED"
resp.elastic_gpu_set[0].elastic_gpu_state #=> String, one of "ATTACHED"
resp.elastic_gpu_set[0].instance_id #=> String
resp.elastic_gpu_set[0].tags #=> Array
resp.elastic_gpu_set[0].tags[0].key #=> String
resp.elastic_gpu_set[0].tags[0].value #=> String
resp.max_results #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :elastic_gpu_ids (Array<String>) —

    The Elastic Graphics accelerator IDs.

  • :dry_run (Boolean) —

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

    The filters.

    • ‘availability-zone` - The Availability Zone in which the Elastic Graphics accelerator resides.

    • ‘elastic-gpu-health` - The status of the Elastic Graphics accelerator (`OK` | `IMPAIRED`).

    • ‘elastic-gpu-state` - The state of the Elastic Graphics accelerator (`ATTACHED`).

    • ‘elastic-gpu-type` - The type of Elastic Graphics accelerator; for example, `eg1.medium`.

    • ‘instance-id` - The ID of the instance to which the Elastic Graphics accelerator is associated.

  • :max_results (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.

  • :next_token (String) —

    The token to request the next page of results.

Returns:

See Also:



22332
22333
22334
22335
 
# File 'lib/aws-sdk-ec2/client.rb', line 22332

def describe_elastic_gpus(params = {}, options = {})
  req = build_request(:describe_elastic_gpus, params)
  req.send_request(options)
end

#describe_export_image_tasks(params = {}) ⇒ Types::DescribeExportImageTasksResult

Describes the specified export image tasks or all of your export image tasks.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_export_image_tasks({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  export_image_task_ids: ["ExportImageTaskId"],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.export_image_tasks #=> Array
resp.export_image_tasks[0].description #=> String
resp.export_image_tasks[0].export_image_task_id #=> String
resp.export_image_tasks[0].image_id #=> String
resp.export_image_tasks[0].progress #=> String
resp.export_image_tasks[0].s3_export_location.s3_bucket #=> String
resp.export_image_tasks[0].s3_export_location.s3_prefix #=> String
resp.export_image_tasks[0].status #=> String
resp.export_image_tasks[0].status_message #=> String
resp.export_image_tasks[0].tags #=> Array
resp.export_image_tasks[0].tags[0].key #=> String
resp.export_image_tasks[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    Filter tasks using the ‘task-state` filter and one of the following values: `active`, `completed`, `deleting`, or `deleted`.

  • :export_image_task_ids (Array<String>) —

    The IDs of the export image tasks.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    A token that indicates the next page of results.

Returns:

See Also:



22401
22402
22403
22404
 
# File 'lib/aws-sdk-ec2/client.rb', line 22401

def describe_export_image_tasks(params = {}, options = {})
  req = build_request(:describe_export_image_tasks, params)
  req.send_request(options)
end

#describe_export_tasks(params = {}) ⇒ Types::DescribeExportTasksResult

Describes the specified export instance tasks or all of your export instance tasks.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* export_task_cancelled
* export_task_completed

Examples:

Request syntax with placeholder values


resp = client.describe_export_tasks({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  export_task_ids: ["ExportTaskId"],
})

Response structure


resp.export_tasks #=> Array
resp.export_tasks[0].description #=> String
resp.export_tasks[0].export_task_id #=> String
resp.export_tasks[0].export_to_s3_task.container_format #=> String, one of "ova"
resp.export_tasks[0].export_to_s3_task.disk_image_format #=> String, one of "VMDK", "RAW", "VHD"
resp.export_tasks[0].export_to_s3_task.s3_bucket #=> String
resp.export_tasks[0].export_to_s3_task.s3_key #=> String
resp.export_tasks[0].instance_export_details.instance_id #=> String
resp.export_tasks[0].instance_export_details.target_environment #=> String, one of "citrix", "vmware", "microsoft"
resp.export_tasks[0].state #=> String, one of "active", "cancelling", "cancelled", "completed"
resp.export_tasks[0].status_message #=> String
resp.export_tasks[0].tags #=> Array
resp.export_tasks[0].tags[0].key #=> String
resp.export_tasks[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    the filters for the export tasks.

  • :export_task_ids (Array<String>) —

    The export task IDs.

Returns:

See Also:



22458
22459
22460
22461
 
# File 'lib/aws-sdk-ec2/client.rb', line 22458

def describe_export_tasks(params = {}, options = {})
  req = build_request(:describe_export_tasks, params)
  req.send_request(options)
end

#describe_fast_launch_images(params = {}) ⇒ Types::DescribeFastLaunchImagesResult

Describe details for Windows AMIs that are configured for Windows fast launch.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_fast_launch_images({
  image_ids: ["ImageId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  dry_run: false,
})

Response structure


resp.fast_launch_images #=> Array
resp.fast_launch_images[0].image_id #=> String
resp.fast_launch_images[0].resource_type #=> String, one of "snapshot"
resp.fast_launch_images[0].snapshot_configuration.target_resource_count #=> Integer
resp.fast_launch_images[0].launch_template.launch_template_id #=> String
resp.fast_launch_images[0].launch_template.launch_template_name #=> String
resp.fast_launch_images[0].launch_template.version #=> String
resp.fast_launch_images[0].max_parallel_launches #=> Integer
resp.fast_launch_images[0].owner_id #=> String
resp.fast_launch_images[0].state #=> String, one of "enabling", "enabling-failed", "enabled", "enabled-failed", "disabling", "disabling-failed"
resp.fast_launch_images[0].state_transition_reason #=> String
resp.fast_launch_images[0].state_transition_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_ids (Array<String>) —

    Specify one or more Windows AMI image IDs for the request.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :dry_run (Boolean) —

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

Returns:

See Also:



22539
22540
22541
22542
 
# File 'lib/aws-sdk-ec2/client.rb', line 22539

def describe_fast_launch_images(params = {}, options = {})
  req = build_request(:describe_fast_launch_images, params)
  req.send_request(options)
end

#describe_fast_snapshot_restores(params = {}) ⇒ Types::DescribeFastSnapshotRestoresResult

Describes the state of fast snapshot restores for your snapshots.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_fast_snapshot_restores({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  dry_run: false,
})

Response structure


resp.fast_snapshot_restores #=> Array
resp.fast_snapshot_restores[0].snapshot_id #=> String
resp.fast_snapshot_restores[0].availability_zone #=> String
resp.fast_snapshot_restores[0].state #=> String, one of "enabling", "optimizing", "enabled", "disabling", "disabled"
resp.fast_snapshot_restores[0].state_transition_reason #=> String
resp.fast_snapshot_restores[0].owner_id #=> String
resp.fast_snapshot_restores[0].owner_alias #=> String
resp.fast_snapshot_restores[0].enabling_time #=> Time
resp.fast_snapshot_restores[0].optimizing_time #=> Time
resp.fast_snapshot_restores[0].enabled_time #=> Time
resp.fast_snapshot_restores[0].disabling_time #=> Time
resp.fast_snapshot_restores[0].disabled_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

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

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :dry_run (Boolean) —

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

Returns:

See Also:



22620
22621
22622
22623
 
# File 'lib/aws-sdk-ec2/client.rb', line 22620

def describe_fast_snapshot_restores(params = {}, options = {})
  req = build_request(:describe_fast_snapshot_restores, params)
  req.send_request(options)
end

#describe_fleet_history(params = {}) ⇒ Types::DescribeFleetHistoryResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html

Examples:

Request syntax with placeholder values


resp = client.describe_fleet_history({
  dry_run: false,
  event_type: "instance-change", # accepts instance-change, fleet-change, service-error
  max_results: 1,
  next_token: "String",
  fleet_id: "FleetId", # required
  start_time: Time.now, # required
})

Response structure


resp.history_records #=> Array
resp.history_records[0].event_information.event_description #=> String
resp.history_records[0].event_information.event_sub_type #=> String
resp.history_records[0].event_information.instance_id #=> String
resp.history_records[0].event_type #=> String, one of "instance-change", "fleet-change", "service-error"
resp.history_records[0].timestamp #=> Time
resp.last_evaluated_time #=> Time
resp.next_token #=> String
resp.fleet_id #=> String
resp.start_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :event_type (String) —

    The type of events to describe. By default, all events are described.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :fleet_id (required, String) —

    The ID of the EC2 Fleet.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The start date and time for the events, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z).

Returns:

See Also:



22705
22706
22707
22708
 
# File 'lib/aws-sdk-ec2/client.rb', line 22705

def describe_fleet_history(params = {}, options = {})
  req = build_request(:describe_fleet_history, params)
  req.send_request(options)
end

#describe_fleet_instances(params = {}) ⇒ Types::DescribeFleetInstancesResult

Describes the running instances for the specified EC2 Fleet.

<note markdown=“1”> Currently, ‘DescribeFleetInstances` does not support fleets of type `instant`. Instead, use `DescribeFleets`, specifying the `instant` fleet ID in the request.

</note>

For more information, see [Describe your EC2 Fleet] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet

Examples:

Request syntax with placeholder values


resp = client.describe_fleet_instances({
  dry_run: false,
  max_results: 1,
  next_token: "String",
  fleet_id: "FleetId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.active_instances #=> Array
resp.active_instances[0].instance_id #=> String
resp.active_instances[0].instance_type #=> String
resp.active_instances[0].spot_instance_request_id #=> String
resp.active_instances[0].instance_health #=> String, one of "healthy", "unhealthy"
resp.next_token #=> String
resp.fleet_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :fleet_id (required, String) —

    The ID of the EC2 Fleet.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘instance-type` - The instance type.

    ^

Returns:

See Also:



22789
22790
22791
22792
 
# File 'lib/aws-sdk-ec2/client.rb', line 22789

def describe_fleet_instances(params = {}, options = {})
  req = build_request(:describe_fleet_instances, params)
  req.send_request(options)
end

#describe_fleets(params = {}) ⇒ Types::DescribeFleetsResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_fleets({
  dry_run: false,
  max_results: 1,
  next_token: "String",
  fleet_ids: ["FleetId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.fleets #=> Array
resp.fleets[0].activity_status #=> String, one of "error", "pending_fulfillment", "pending_termination", "fulfilled"
resp.fleets[0].create_time #=> Time
resp.fleets[0].fleet_id #=> String
resp.fleets[0].fleet_state #=> String, one of "submitted", "active", "deleted", "failed", "deleted_running", "deleted_terminating", "modifying"
resp.fleets[0].client_token #=> String
resp.fleets[0].excess_capacity_termination_policy #=> String, one of "no-termination", "termination"
resp.fleets[0].fulfilled_capacity #=> Float
resp.fleets[0].fulfilled_on_demand_capacity #=> Float
resp.fleets[0].launch_template_configs #=> Array
resp.fleets[0].launch_template_configs[0].launch_template_specification.launch_template_id #=> String
resp.fleets[0].launch_template_configs[0].launch_template_specification.launch_template_name #=> String
resp.fleets[0].launch_template_configs[0].launch_template_specification.version #=> String
resp.fleets[0].launch_template_configs[0].overrides #=> Array
resp.fleets[0].launch_template_configs[0].overrides[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.fleets[0].launch_template_configs[0].overrides[0].max_price #=> String
resp.fleets[0].launch_template_configs[0].overrides[0].subnet_id #=> String
resp.fleets[0].launch_template_configs[0].overrides[0].availability_zone #=> String
resp.fleets[0].launch_template_configs[0].overrides[0].weighted_capacity #=> Float
resp.fleets[0].launch_template_configs[0].overrides[0].priority #=> Float
resp.fleets[0].launch_template_configs[0].overrides[0].placement.group_name #=> String
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.v_cpu_count.min #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.v_cpu_count.max #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.memory_mi_b.min #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.memory_mi_b.max #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.cpu_manufacturers #=> Array
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.excluded_instance_types #=> Array
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.excluded_instance_types[0] #=> String
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.instance_generations #=> Array
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.require_hibernate_support #=> Boolean
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.network_interface_count.min #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.network_interface_count.max #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.local_storage_types #=> Array
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.total_local_storage_gb.min #=> Float
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.total_local_storage_gb.max #=> Float
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_types #=> Array
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_count.min #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_count.max #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_manufacturers #=> Array
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_names #=> Array
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.network_bandwidth_gbps.min #=> Float
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.network_bandwidth_gbps.max #=> Float
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.allowed_instance_types #=> Array
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.allowed_instance_types[0] #=> String
resp.fleets[0].launch_template_configs[0].overrides[0].instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.fleets[0].launch_template_configs[0].overrides[0].image_id #=> String
resp.fleets[0].target_capacity_specification.total_target_capacity #=> Integer
resp.fleets[0].target_capacity_specification.on_demand_target_capacity #=> Integer
resp.fleets[0].target_capacity_specification.spot_target_capacity #=> Integer
resp.fleets[0].target_capacity_specification.default_target_capacity_type #=> String, one of "spot", "on-demand", "capacity-block"
resp.fleets[0].target_capacity_specification.target_capacity_unit_type #=> String, one of "vcpu", "memory-mib", "units"
resp.fleets[0].terminate_instances_with_expiration #=> Boolean
resp.fleets[0].type #=> String, one of "request", "maintain", "instant"
resp.fleets[0].valid_from #=> Time
resp.fleets[0].valid_until #=> Time
resp.fleets[0].replace_unhealthy_instances #=> Boolean
resp.fleets[0].spot_options.allocation_strategy #=> String, one of "lowest-price", "diversified", "capacity-optimized", "capacity-optimized-prioritized", "price-capacity-optimized"
resp.fleets[0].spot_options.maintenance_strategies.capacity_rebalance.replacement_strategy #=> String, one of "launch", "launch-before-terminate"
resp.fleets[0].spot_options.maintenance_strategies.capacity_rebalance.termination_delay #=> Integer
resp.fleets[0].spot_options.instance_interruption_behavior #=> String, one of "hibernate", "stop", "terminate"
resp.fleets[0].spot_options.instance_pools_to_use_count #=> Integer
resp.fleets[0].spot_options.single_instance_type #=> Boolean
resp.fleets[0].spot_options.single_availability_zone #=> Boolean
resp.fleets[0].spot_options.min_target_capacity #=> Integer
resp.fleets[0].spot_options.max_total_price #=> String
resp.fleets[0].on_demand_options.allocation_strategy #=> String, one of "lowest-price", "prioritized"
resp.fleets[0].on_demand_options.capacity_reservation_options.usage_strategy #=> String, one of "use-capacity-reservations-first", "use-capacity-reservations-only", "none"
resp.fleets[0].on_demand_options.single_instance_type #=> Boolean
resp.fleets[0].on_demand_options.single_availability_zone #=> Boolean
resp.fleets[0].on_demand_options.min_target_capacity #=> Integer
resp.fleets[0].on_demand_options.max_total_price #=> String
resp.fleets[0].tags #=> Array
resp.fleets[0].tags[0].key #=> String
resp.fleets[0].tags[0].value #=> String
resp.fleets[0].errors #=> Array
resp.fleets[0].errors[0].launch_template_and_overrides.launch_template_specification.launch_template_id #=> String
resp.fleets[0].errors[0].launch_template_and_overrides.launch_template_specification.launch_template_name #=> String
resp.fleets[0].errors[0].launch_template_and_overrides.launch_template_specification.version #=> String
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.max_price #=> String
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.subnet_id #=> String
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.availability_zone #=> String
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.weighted_capacity #=> Float
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.priority #=> Float
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.placement.group_name #=> String
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.v_cpu_count.min #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.v_cpu_count.max #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.memory_mi_b.min #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.memory_mi_b.max #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.cpu_manufacturers #=> Array
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.excluded_instance_types #=> Array
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.excluded_instance_types[0] #=> String
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.instance_generations #=> Array
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.require_hibernate_support #=> Boolean
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.network_interface_count.min #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.network_interface_count.max #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.local_storage_types #=> Array
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.total_local_storage_gb.min #=> Float
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.total_local_storage_gb.max #=> Float
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_types #=> Array
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_count.min #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_count.max #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_manufacturers #=> Array
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_names #=> Array
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.network_bandwidth_gbps.min #=> Float
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.network_bandwidth_gbps.max #=> Float
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.allowed_instance_types #=> Array
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.allowed_instance_types[0] #=> String
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.fleets[0].errors[0].launch_template_and_overrides.overrides.image_id #=> String
resp.fleets[0].errors[0].lifecycle #=> String, one of "spot", "on-demand"
resp.fleets[0].errors[0].error_code #=> String
resp.fleets[0].errors[0].error_message #=> String
resp.fleets[0].instances #=> Array
resp.fleets[0].instances[0].launch_template_and_overrides.launch_template_specification.launch_template_id #=> String
resp.fleets[0].instances[0].launch_template_and_overrides.launch_template_specification.launch_template_name #=> String
resp.fleets[0].instances[0].launch_template_and_overrides.launch_template_specification.version #=> String
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.max_price #=> String
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.subnet_id #=> String
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.availability_zone #=> String
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.weighted_capacity #=> Float
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.priority #=> Float
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.placement.group_name #=> String
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.v_cpu_count.min #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.v_cpu_count.max #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.memory_mi_b.min #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.memory_mi_b.max #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.cpu_manufacturers #=> Array
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.excluded_instance_types #=> Array
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.excluded_instance_types[0] #=> String
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.instance_generations #=> Array
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.require_hibernate_support #=> Boolean
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.network_interface_count.min #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.network_interface_count.max #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.local_storage_types #=> Array
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.total_local_storage_gb.min #=> Float
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.total_local_storage_gb.max #=> Float
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_types #=> Array
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_count.min #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_count.max #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_manufacturers #=> Array
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_names #=> Array
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.network_bandwidth_gbps.min #=> Float
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.network_bandwidth_gbps.max #=> Float
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.allowed_instance_types #=> Array
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.allowed_instance_types[0] #=> String
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.fleets[0].instances[0].launch_template_and_overrides.overrides.image_id #=> String
resp.fleets[0].instances[0].lifecycle #=> String, one of "spot", "on-demand"
resp.fleets[0].instances[0].instance_ids #=> Array
resp.fleets[0].instances[0].instance_ids[0] #=> String
resp.fleets[0].instances[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.fleets[0].instances[0].platform #=> String, one of "Windows"
resp.fleets[0].context #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :fleet_ids (Array<String>) —

    The IDs of the EC2 Fleets.

    <note markdown=“1”> If a fleet is of type ‘instant`, you must specify the fleet ID, otherwise it does not appear in the response.

    </note>
  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘activity-status` - The progress of the EC2 Fleet ( `error` | `pending-fulfillment` | `pending-termination` | `fulfilled`).

    • ‘excess-capacity-termination-policy` - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (`true` | `false`).

    • ‘fleet-state` - The state of the EC2 Fleet (`submitted` | `active` | `deleted` | `failed` | `deleted-running` | `deleted-terminating` | `modifying`).

    • ‘replace-unhealthy-instances` - Indicates whether EC2 Fleet should replace unhealthy instances (`true` | `false`).

    • ‘type` - The type of request (`instant` | `request` | `maintain`).

Returns:

See Also:



23088
23089
23090
23091
 
# File 'lib/aws-sdk-ec2/client.rb', line 23088

def describe_fleets(params = {}, options = {})
  req = build_request(:describe_fleets, params)
  req.send_request(options)
end

#describe_flow_logs(params = {}) ⇒ Types::DescribeFlowLogsResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_flow_logs({
  dry_run: false,
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  flow_log_ids: ["VpcFlowLogId"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.flow_logs #=> Array
resp.flow_logs[0].creation_time #=> Time
resp.flow_logs[0].deliver_logs_error_message #=> String
resp.flow_logs[0].deliver_logs_permission_arn #=> String
resp.flow_logs[0]. #=> String
resp.flow_logs[0].deliver_logs_status #=> String
resp.flow_logs[0].flow_log_id #=> String
resp.flow_logs[0].flow_log_status #=> String
resp.flow_logs[0].log_group_name #=> String
resp.flow_logs[0].resource_id #=> String
resp.flow_logs[0].traffic_type #=> String, one of "ACCEPT", "REJECT", "ALL"
resp.flow_logs[0].log_destination_type #=> String, one of "cloud-watch-logs", "s3", "kinesis-data-firehose"
resp.flow_logs[0].log_destination #=> String
resp.flow_logs[0].log_format #=> String
resp.flow_logs[0].tags #=> Array
resp.flow_logs[0].tags[0].key #=> String
resp.flow_logs[0].tags[0].value #=> String
resp.flow_logs[0].max_aggregation_interval #=> Integer
resp.flow_logs[0].destination_options.file_format #=> String, one of "plain-text", "parquet"
resp.flow_logs[0].destination_options.hive_compatible_partitions #=> Boolean
resp.flow_logs[0].destination_options.per_hour_partition #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    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`:&lt;key&gt; - 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.

  • :flow_log_ids (Array<String>) —

    One or more flow log IDs.

    Constraint: Maximum of 1000 flow log IDs.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



23202
23203
23204
23205
 
# File 'lib/aws-sdk-ec2/client.rb', line 23202

def describe_flow_logs(params = {}, options = {})
  req = build_request(:describe_flow_logs, params)
  req.send_request(options)
end

#describe_fpga_image_attribute(params = {}) ⇒ Types::DescribeFpgaImageAttributeResult

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

Examples:

Request syntax with placeholder values


resp = client.describe_fpga_image_attribute({
  dry_run: false,
  fpga_image_id: "FpgaImageId", # required
  attribute: "description", # required, accepts description, name, loadPermission, productCodes
})

Response structure


resp.fpga_image_attribute.fpga_image_id #=> String
resp.fpga_image_attribute.name #=> String
resp.fpga_image_attribute.description #=> String
resp.fpga_image_attribute.load_permissions #=> Array
resp.fpga_image_attribute.load_permissions[0].user_id #=> String
resp.fpga_image_attribute.load_permissions[0].group #=> String, one of "all"
resp.fpga_image_attribute.product_codes #=> Array
resp.fpga_image_attribute.product_codes[0].product_code_id #=> String
resp.fpga_image_attribute.product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :fpga_image_id (required, String) —

    The ID of the AFI.

  • :attribute (required, String) —

    The AFI attribute.

Returns:

See Also:



23250
23251
23252
23253
 
# File 'lib/aws-sdk-ec2/client.rb', line 23250

def describe_fpga_image_attribute(params = {}, options = {})
  req = build_request(:describe_fpga_image_attribute, params)
  req.send_request(options)
end

#describe_fpga_images(params = {}) ⇒ Types::DescribeFpgaImagesResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_fpga_images({
  dry_run: false,
  fpga_image_ids: ["FpgaImageId"],
  owners: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.fpga_images #=> Array
resp.fpga_images[0].fpga_image_id #=> String
resp.fpga_images[0].fpga_image_global_id #=> String
resp.fpga_images[0].name #=> String
resp.fpga_images[0].description #=> String
resp.fpga_images[0].shell_version #=> String
resp.fpga_images[0].pci_id.device_id #=> String
resp.fpga_images[0].pci_id.vendor_id #=> String
resp.fpga_images[0].pci_id.subsystem_id #=> String
resp.fpga_images[0].pci_id.subsystem_vendor_id #=> String
resp.fpga_images[0].state.code #=> String, one of "pending", "failed", "available", "unavailable"
resp.fpga_images[0].state.message #=> String
resp.fpga_images[0].create_time #=> Time
resp.fpga_images[0].update_time #=> Time
resp.fpga_images[0].owner_id #=> String
resp.fpga_images[0].owner_alias #=> String
resp.fpga_images[0].product_codes #=> Array
resp.fpga_images[0].product_codes[0].product_code_id #=> String
resp.fpga_images[0].product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"
resp.fpga_images[0].tags #=> Array
resp.fpga_images[0].tags[0].key #=> String
resp.fpga_images[0].tags[0].value #=> String
resp.fpga_images[0].public #=> Boolean
resp.fpga_images[0].data_retention_support #=> Boolean
resp.fpga_images[0].instance_types #=> Array
resp.fpga_images[0].instance_types[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :fpga_image_ids (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<Types::Filter>) —

    The filters.

    • ‘create-time` - The creation time of the AFI.

    • ‘fpga-image-id` - The FPGA image identifier (AFI ID).

    • ‘fpga-image-global-id` - The global FPGA image 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`:&lt;key&gt; - 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.

  • :next_token (String) —

    The token to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

Returns:

See Also:



23370
23371
23372
23373
 
# File 'lib/aws-sdk-ec2/client.rb', line 23370

def describe_fpga_images(params = {}, options = {})
  req = build_request(:describe_fpga_images, params)
  req.send_request(options)
end

#describe_host_reservation_offerings(params = {}) ⇒ Types::DescribeHostReservationOfferingsResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_host_reservation_offerings({
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_duration: 1,
  max_results: 1,
  min_duration: 1,
  next_token: "String",
  offering_id: "OfferingId",
})

Response structure


resp.next_token #=> String
resp.offering_set #=> Array
resp.offering_set[0].currency_code #=> String, one of "USD"
resp.offering_set[0].duration #=> Integer
resp.offering_set[0].hourly_price #=> String
resp.offering_set[0].instance_family #=> String
resp.offering_set[0].offering_id #=> String
resp.offering_set[0].payment_option #=> String, one of "AllUpfront", "PartialUpfront", "NoUpfront"
resp.offering_set[0].upfront_price #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Array<Types::Filter>) —

    The filters.

    • ‘instance-family` - The instance family of the offering (for example, `m4`).

    • ‘payment-option` - The payment option (`NoUpfront` | `PartialUpfront` | `AllUpfront`).

  • :max_duration (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.

  • :max_results (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

    1. If ‘maxResults` is given a larger value than 500, you receive an

    error.

  • :min_duration (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.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

  • :offering_id (String) —

    The ID of the reservation offering.

Returns:

See Also:



23465
23466
23467
23468
 
# File 'lib/aws-sdk-ec2/client.rb', line 23465

def describe_host_reservation_offerings(params = {}, options = {})
  req = build_request(:describe_host_reservation_offerings, params)
  req.send_request(options)
end

#describe_host_reservations(params = {}) ⇒ Types::DescribeHostReservationsResult

Describes reservations that are associated with Dedicated Hosts in your account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_host_reservations({
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  host_reservation_id_set: ["HostReservationId"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.host_reservation_set #=> Array
resp.host_reservation_set[0].count #=> Integer
resp.host_reservation_set[0].currency_code #=> String, one of "USD"
resp.host_reservation_set[0].duration #=> Integer
resp.host_reservation_set[0].end #=> Time
resp.host_reservation_set[0].host_id_set #=> Array
resp.host_reservation_set[0].host_id_set[0] #=> String
resp.host_reservation_set[0].host_reservation_id #=> String
resp.host_reservation_set[0].hourly_price #=> String
resp.host_reservation_set[0].instance_family #=> String
resp.host_reservation_set[0].offering_id #=> String
resp.host_reservation_set[0].payment_option #=> String, one of "AllUpfront", "PartialUpfront", "NoUpfront"
resp.host_reservation_set[0].start #=> Time
resp.host_reservation_set[0].state #=> String, one of "payment-pending", "payment-failed", "active", "retired"
resp.host_reservation_set[0].upfront_price #=> String
resp.host_reservation_set[0].tags #=> Array
resp.host_reservation_set[0].tags[0].key #=> String
resp.host_reservation_set[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Array<Types::Filter>) —

    The filters.

    • ‘instance-family` - The instance family (for example, `m4`).

    • ‘payment-option` - The payment option (`NoUpfront` | `PartialUpfront` | `AllUpfront`).

    • ‘state` - The state of the reservation (`payment-pending` | `payment-failed` | `active` | `retired`).

    • ‘tag:<key>` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • :host_reservation_id_set (Array<String>) —

    The host reservation IDs.

  • :max_results (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

    1. If ‘maxResults` is given a larger value than 500, you receive an

    error.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

Returns:

See Also:



23554
23555
23556
23557
 
# File 'lib/aws-sdk-ec2/client.rb', line 23554

def describe_host_reservations(params = {}, options = {})
  req = build_request(:describe_host_reservations, params)
  req.send_request(options)
end

#describe_hosts(params = {}) ⇒ Types::DescribeHostsResult

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_hosts({
  host_ids: ["DedicatedHostId"],
  next_token: "String",
  max_results: 1,
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.hosts #=> Array
resp.hosts[0].auto_placement #=> String, one of "on", "off"
resp.hosts[0].availability_zone #=> String
resp.hosts[0].available_capacity.available_instance_capacity #=> Array
resp.hosts[0].available_capacity.available_instance_capacity[0].available_capacity #=> Integer
resp.hosts[0].available_capacity.available_instance_capacity[0].instance_type #=> String
resp.hosts[0].available_capacity.available_instance_capacity[0].total_capacity #=> Integer
resp.hosts[0].available_capacity.available_v_cpus #=> Integer
resp.hosts[0].client_token #=> String
resp.hosts[0].host_id #=> String
resp.hosts[0].host_properties.cores #=> Integer
resp.hosts[0].host_properties.instance_type #=> String
resp.hosts[0].host_properties.instance_family #=> String
resp.hosts[0].host_properties.sockets #=> Integer
resp.hosts[0].host_properties.total_v_cpus #=> Integer
resp.hosts[0].host_reservation_id #=> String
resp.hosts[0].instances #=> Array
resp.hosts[0].instances[0].instance_id #=> String
resp.hosts[0].instances[0].instance_type #=> String
resp.hosts[0].instances[0].owner_id #=> String
resp.hosts[0].state #=> String, one of "available", "under-assessment", "permanent-failure", "released", "released-permanent-failure", "pending"
resp.hosts[0].allocation_time #=> Time
resp.hosts[0].release_time #=> Time
resp.hosts[0].tags #=> Array
resp.hosts[0].tags[0].key #=> String
resp.hosts[0].tags[0].value #=> String
resp.hosts[0].host_recovery #=> String, one of "on", "off"
resp.hosts[0].allows_multiple_instance_types #=> String, one of "on", "off"
resp.hosts[0].owner_id #=> String
resp.hosts[0].availability_zone_id #=> String
resp.hosts[0].member_of_service_linked_resource_group #=> Boolean
resp.hosts[0].outpost_arn #=> String
resp.hosts[0].host_maintenance #=> String, one of "on", "off"
resp.hosts[0].asset_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :host_ids (Array<String>) —

    The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

  • :max_results (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

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

  • :filter (Array<Types::Filter>) —

    The filters.

    • ‘auto-placement` - Whether auto-placement is enabled or disabled (`on` | `off`).

    • ‘availability-zone` - The Availability Zone of the host.

    • ‘client-token` - The idempotency token that you provided when you allocated the host.

    • ‘host-reservation-id` - The ID of the reservation assigned to this host.

    • ‘instance-type` - The instance type size that the Dedicated Host is configured to support.

    • ‘state` - The allocation state of the Dedicated Host (`available` | `under-assessment` | `permanent-failure` | `released` | `released-permanent-failure`).

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

Returns:

See Also:



23671
23672
23673
23674
 
# File 'lib/aws-sdk-ec2/client.rb', line 23671

def describe_hosts(params = {}, options = {})
  req = build_request(:describe_hosts, params)
  req.send_request(options)
end

#describe_iam_instance_profile_associations(params = {}) ⇒ Types::DescribeIamInstanceProfileAssociationsResult

Describes your IAM instance profile associations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe an IAM instance profile association


# This example describes the specified IAM instance profile association.

resp = client.describe_iam_instance_profile_associations({
  association_ids: [
    "iip-assoc-0db249b1f25fa24b8", 
  ], 
})

resp.to_h outputs the following:
{
  iam_instance_profile_associations: [
    {
      association_id: "iip-assoc-0db249b1f25fa24b8", 
      iam_instance_profile: {
        arn: "arn:aws:iam::123456789012:instance-profile/admin-role", 
        id: "AIPAJVQN4F5WVLGCJDRGM", 
      }, 
      instance_id: "i-09eb09efa73ec1dee", 
      state: "associated", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_iam_instance_profile_associations({
  association_ids: ["IamInstanceProfileAssociationId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.iam_instance_profile_associations #=> Array
resp.iam_instance_profile_associations[0].association_id #=> String
resp.iam_instance_profile_associations[0].instance_id #=> String
resp.iam_instance_profile_associations[0].iam_instance_profile.arn #=> String
resp.iam_instance_profile_associations[0].iam_instance_profile.id #=> String
resp.iam_instance_profile_associations[0].state #=> String, one of "associating", "associated", "disassociating", "disassociated"
resp.iam_instance_profile_associations[0].timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :association_ids (Array<String>) —

    The IAM instance profile associations.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘instance-id` - The ID of the instance.

    • ‘state` - The state of the association (`associating` | `associated` | `disassociating`).

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



23764
23765
23766
23767
 
# File 'lib/aws-sdk-ec2/client.rb', line 23764

def describe_iam_instance_profile_associations(params = {}, options = {})
  req = build_request(:describe_iam_instance_profile_associations, params)
  req.send_request(options)
end

#describe_id_format(params = {}) ⇒ Types::DescribeIdFormatResult

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.

Examples:

Request syntax with placeholder values


resp = client.describe_id_format({
  resource: "String",
})

Response structure


resp.statuses #=> Array
resp.statuses[0].deadline #=> Time
resp.statuses[0].resource #=> String
resp.statuses[0].use_long_ids #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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`

Returns:

See Also:



23829
23830
23831
23832
 
# File 'lib/aws-sdk-ec2/client.rb', line 23829

def describe_id_format(params = {}, options = {})
  req = build_request(:describe_id_format, params)
  req.send_request(options)
end

#describe_identity_id_format(params = {}) ⇒ Types::DescribeIdentityIdFormatResult

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html

Examples:

Request syntax with placeholder values


resp = client.describe_identity_id_format({
  resource: "String",
  principal_arn: "String", # required
})

Response structure


resp.statuses #=> Array
resp.statuses[0].deadline #=> Time
resp.statuses[0].resource #=> String
resp.statuses[0].use_long_ids #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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`

  • :principal_arn (required, String) —

    The ARN of the principal, which can be an IAM role, IAM user, or the root user.

Returns:

See Also:



23899
23900
23901
23902
 
# File 'lib/aws-sdk-ec2/client.rb', line 23899

def describe_identity_id_format(params = {}, options = {})
  req = build_request(:describe_identity_id_format, params)
  req.send_request(options)
end

#describe_image_attribute(params = {}) ⇒ Types::ImageAttribute

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

<note markdown=“1”> 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.

</note>

Examples:

Example: To describe the launch permissions for an AMI


# This example describes the launch permissions for the specified AMI.

resp = client.describe_image_attribute({
  attribute: "launchPermission", 
  image_id: "ami-5731123e", 
})

resp.to_h outputs the following:
{
  image_id: "ami-5731123e", 
  launch_permissions: [
    {
      user_id: "123456789012", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_image_attribute({
  attribute: "description", # required, accepts description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport, bootMode, tpmSupport, uefiData, lastLaunchedTime, imdsSupport, deregistrationProtection
  image_id: "ImageId", # required
  dry_run: false,
})

Response structure


resp.description #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.kernel_id #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.ramdisk_id #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.sriov_net_support #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.boot_mode #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.tpm_support #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.uefi_data #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.last_launched_time #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.imds_support #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.deregistration_protection #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.image_id #=> String
resp.launch_permissions #=> Array
resp.launch_permissions[0].organization_arn #=> String
resp.launch_permissions[0].organizational_unit_arn #=> String
resp.launch_permissions[0].user_id #=> String
resp.launch_permissions[0].group #=> String, one of "all"
resp.product_codes #=> Array
resp.product_codes[0].product_code_id #=> String
resp.product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"
resp.block_device_mappings #=> Array
resp.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.block_device_mappings[0].ebs.iops #=> Integer
resp.block_device_mappings[0].ebs.snapshot_id #=> String
resp.block_device_mappings[0].ebs.volume_size #=> Integer
resp.block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.block_device_mappings[0].ebs.kms_key_id #=> String
resp.block_device_mappings[0].ebs.throughput #=> Integer
resp.block_device_mappings[0].ebs.outpost_arn #=> String
resp.block_device_mappings[0].ebs.encrypted #=> Boolean
resp.block_device_mappings[0].no_device #=> String
resp.block_device_mappings[0].device_name #=> String
resp.block_device_mappings[0].virtual_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute (required, 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.

  • :image_id (required, String) —

    The ID of the AMI.

  • :dry_run (Boolean) —

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

Returns:

See Also:



24014
24015
24016
24017
 
# File 'lib/aws-sdk-ec2/client.rb', line 24014

def describe_image_attribute(params = {}, options = {})
  req = build_request(:describe_image_attribute, params)
  req.send_request(options)
end

#describe_images(params = {}) ⇒ Types::DescribeImagesResult

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 markdown=“1”> 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.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* image_available
* image_exists

Examples:

Example: To describe an AMI


# This example describes the specified AMI.

resp = client.describe_images({
  image_ids: [
    "ami-5731123e", 
  ], 
})

resp.to_h outputs the following:
{
  images: [
    {
      architecture: "x86_64", 
      block_device_mappings: [
        {
          device_name: "/dev/sda1", 
          ebs: {
            delete_on_termination: true, 
            snapshot_id: "snap-1234567890abcdef0", 
            volume_size: 8, 
            volume_type: "standard", 
          }, 
        }, 
      ], 
      description: "An AMI for my server", 
      hypervisor: "xen", 
      image_id: "ami-5731123e", 
      image_location: "123456789012/My server", 
      image_type: "machine", 
      kernel_id: "aki-88aa75e1", 
      name: "My server", 
      owner_id: "123456789012", 
      public: false, 
      root_device_name: "/dev/sda1", 
      root_device_type: "ebs", 
      state: "available", 
      virtualization_type: "paravirtual", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_images({
  executable_users: ["String"],
  image_ids: ["ImageId"],
  owners: ["String"],
  include_deprecated: false,
  include_disabled: false,
  max_results: 1,
  next_token: "String",
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.images #=> Array
resp.images[0].platform_details #=> String
resp.images[0].usage_operation #=> String
resp.images[0].block_device_mappings #=> Array
resp.images[0].block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.images[0].block_device_mappings[0].ebs.iops #=> Integer
resp.images[0].block_device_mappings[0].ebs.snapshot_id #=> String
resp.images[0].block_device_mappings[0].ebs.volume_size #=> Integer
resp.images[0].block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.images[0].block_device_mappings[0].ebs.kms_key_id #=> String
resp.images[0].block_device_mappings[0].ebs.throughput #=> Integer
resp.images[0].block_device_mappings[0].ebs.outpost_arn #=> String
resp.images[0].block_device_mappings[0].ebs.encrypted #=> Boolean
resp.images[0].block_device_mappings[0].no_device #=> String
resp.images[0].block_device_mappings[0].device_name #=> String
resp.images[0].block_device_mappings[0].virtual_name #=> String
resp.images[0].description #=> String
resp.images[0].ena_support #=> Boolean
resp.images[0].hypervisor #=> String, one of "ovm", "xen"
resp.images[0].image_owner_alias #=> String
resp.images[0].name #=> String
resp.images[0].root_device_name #=> String
resp.images[0].root_device_type #=> String, one of "ebs", "instance-store"
resp.images[0].sriov_net_support #=> String
resp.images[0].state_reason.code #=> String
resp.images[0].state_reason.message #=> String
resp.images[0].tags #=> Array
resp.images[0].tags[0].key #=> String
resp.images[0].tags[0].value #=> String
resp.images[0].virtualization_type #=> String, one of "hvm", "paravirtual"
resp.images[0].boot_mode #=> String, one of "legacy-bios", "uefi", "uefi-preferred"
resp.images[0].tpm_support #=> String, one of "v2.0"
resp.images[0].deprecation_time #=> String
resp.images[0].imds_support #=> String, one of "v2.0"
resp.images[0].source_instance_id #=> String
resp.images[0].deregistration_protection #=> String
resp.images[0].last_launched_time #=> String
resp.images[0].image_id #=> String
resp.images[0].image_location #=> String
resp.images[0].state #=> String, one of "pending", "available", "invalid", "deregistered", "transient", "failed", "error", "disabled"
resp.images[0].owner_id #=> String
resp.images[0].creation_date #=> String
resp.images[0].public #=> Boolean
resp.images[0].product_codes #=> Array
resp.images[0].product_codes[0].product_code_id #=> String
resp.images[0].product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"
resp.images[0].architecture #=> String, one of "i386", "x86_64", "arm64", "x86_64_mac", "arm64_mac"
resp.images[0].image_type #=> String, one of "machine", "kernel", "ramdisk"
resp.images[0].kernel_id #=> String
resp.images[0].ramdisk_id #=> String
resp.images[0].platform #=> String, one of "Windows"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :executable_users (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.

  • :image_ids (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.

  • :include_deprecated (Boolean) —

    Specifies whether to include deprecated AMIs.

    Default: No deprecated AMIs are included in the response.

    <note markdown=“1”> If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

    </note>
  • :include_disabled (Boolean) —

    Specifies whether to include disabled AMIs.

    Default: No disabled AMIs are included in the response.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :dry_run (Boolean) —

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

    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`:&lt;key&gt; - 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`).

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html

Returns:

See Also:



24345
24346
24347
24348
 
# File 'lib/aws-sdk-ec2/client.rb', line 24345

def describe_images(params = {}, options = {})
  req = build_request(:describe_images, params)
  req.send_request(options)
end

#describe_import_image_tasks(params = {}) ⇒ Types::DescribeImportImageTasksResult

Displays details about an import virtual machine or import snapshot tasks that are already created.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_import_image_tasks({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  import_task_ids: ["ImportImageTaskId"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.import_image_tasks #=> Array
resp.import_image_tasks[0].architecture #=> String
resp.import_image_tasks[0].description #=> String
resp.import_image_tasks[0].encrypted #=> Boolean
resp.import_image_tasks[0].hypervisor #=> String
resp.import_image_tasks[0].image_id #=> String
resp.import_image_tasks[0].import_task_id #=> String
resp.import_image_tasks[0].kms_key_id #=> String
resp.import_image_tasks[0].license_type #=> String
resp.import_image_tasks[0].platform #=> String
resp.import_image_tasks[0].progress #=> String
resp.import_image_tasks[0].snapshot_details #=> Array
resp.import_image_tasks[0].snapshot_details[0].description #=> String
resp.import_image_tasks[0].snapshot_details[0].device_name #=> String
resp.import_image_tasks[0].snapshot_details[0].disk_image_size #=> Float
resp.import_image_tasks[0].snapshot_details[0].format #=> String
resp.import_image_tasks[0].snapshot_details[0].progress #=> String
resp.import_image_tasks[0].snapshot_details[0].snapshot_id #=> String
resp.import_image_tasks[0].snapshot_details[0].status #=> String
resp.import_image_tasks[0].snapshot_details[0].status_message #=> String
resp.import_image_tasks[0].snapshot_details[0].url #=> String
resp.import_image_tasks[0].snapshot_details[0].user_bucket.s3_bucket #=> String
resp.import_image_tasks[0].snapshot_details[0].user_bucket.s3_key #=> String
resp.import_image_tasks[0].status #=> String
resp.import_image_tasks[0].status_message #=> String
resp.import_image_tasks[0].tags #=> Array
resp.import_image_tasks[0].tags[0].key #=> String
resp.import_image_tasks[0].tags[0].value #=> String
resp.import_image_tasks[0].license_specifications #=> Array
resp.import_image_tasks[0].license_specifications[0].license_configuration_arn #=> String
resp.import_image_tasks[0].usage_operation #=> String
resp.import_image_tasks[0].boot_mode #=> String, one of "legacy-bios", "uefi", "uefi-preferred"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    Filter tasks using the ‘task-state` filter and one of the following values: `active`, `completed`, `deleting`, or `deleted`.

  • :import_task_ids (Array<String>) —

    The IDs of the import image tasks.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    A token that indicates the next page of results.

Returns:

See Also:



24434
24435
24436
24437
 
# File 'lib/aws-sdk-ec2/client.rb', line 24434

def describe_import_image_tasks(params = {}, options = {})
  req = build_request(:describe_import_image_tasks, params)
  req.send_request(options)
end

#describe_import_snapshot_tasks(params = {}) ⇒ Types::DescribeImportSnapshotTasksResult

Describes your import snapshot tasks.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* snapshot_imported

Examples:

Request syntax with placeholder values


resp = client.describe_import_snapshot_tasks({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  import_task_ids: ["ImportSnapshotTaskId"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.import_snapshot_tasks #=> Array
resp.import_snapshot_tasks[0].description #=> String
resp.import_snapshot_tasks[0].import_task_id #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.description #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.disk_image_size #=> Float
resp.import_snapshot_tasks[0].snapshot_task_detail.encrypted #=> Boolean
resp.import_snapshot_tasks[0].snapshot_task_detail.format #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.kms_key_id #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.progress #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.snapshot_id #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.status #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.status_message #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.url #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.user_bucket.s3_bucket #=> String
resp.import_snapshot_tasks[0].snapshot_task_detail.user_bucket.s3_key #=> String
resp.import_snapshot_tasks[0].tags #=> Array
resp.import_snapshot_tasks[0].tags[0].key #=> String
resp.import_snapshot_tasks[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The filters.

  • :import_task_ids (Array<String>) —

    A list of import snapshot task IDs.

  • :max_results (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.

  • :next_token (String) —

    A token that indicates the next page of results.

Returns:

See Also:



24514
24515
24516
24517
 
# File 'lib/aws-sdk-ec2/client.rb', line 24514

def describe_import_snapshot_tasks(params = {}, options = {})
  req = build_request(:describe_import_snapshot_tasks, params)
  req.send_request(options)
end

#describe_instance_attribute(params = {}) ⇒ Types::InstanceAttribute

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`

Examples:

Example: To describe the instance type


# This example describes the instance type of the specified instance.

resp = client.describe_instance_attribute({
  attribute: "instanceType", 
  instance_id: "i-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
  instance_id: "i-1234567890abcdef0", 
  instance_type: {
    value: "t1.micro", 
  }, 
}

Example: To describe the disableApiTermination attribute


# This example describes the ``disableApiTermination`` attribute of the specified instance.

resp = client.describe_instance_attribute({
  attribute: "disableApiTermination", 
  instance_id: "i-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
  disable_api_termination: {
    value: false, 
  }, 
  instance_id: "i-1234567890abcdef0", 
}

Example: To describe the block device mapping for an instance


# This example describes the ``blockDeviceMapping`` attribute of the specified instance.

resp = client.describe_instance_attribute({
  attribute: "blockDeviceMapping", 
  instance_id: "i-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
  block_device_mappings: [
    {
      device_name: "/dev/sda1", 
      ebs: {
        attach_time: Time.parse("2013-05-17T22:42:34.000Z"), 
        delete_on_termination: true, 
        status: "attached", 
        volume_id: "vol-049df61146c4d7901", 
      }, 
    }, 
    {
      device_name: "/dev/sdf", 
      ebs: {
        attach_time: Time.parse("2013-09-10T23:07:00.000Z"), 
        delete_on_termination: false, 
        status: "attached", 
        volume_id: "vol-049df61146c4d7901", 
      }, 
    }, 
  ], 
  instance_id: "i-1234567890abcdef0", 
}

Request syntax with placeholder values


resp = client.describe_instance_attribute({
  dry_run: false,
  instance_id: "InstanceId", # required
  attribute: "instanceType", # required, accepts instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport, enaSupport, enclaveOptions, disableApiStop
})

Response structure


resp.block_device_mappings #=> Array
resp.block_device_mappings[0].device_name #=> String
resp.block_device_mappings[0].ebs.attach_time #=> Time
resp.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.block_device_mappings[0].ebs.status #=> String, one of "attaching", "attached", "detaching", "detached"
resp.block_device_mappings[0].ebs.volume_id #=> String
resp.block_device_mappings[0].ebs.associated_resource #=> String
resp.block_device_mappings[0].ebs.volume_owner_id #=> String
resp.disable_api_termination.value #=> Boolean
resp.ena_support.value #=> Boolean
resp.enclave_options.enabled #=> Boolean
resp.ebs_optimized.value #=> Boolean
resp.instance_id #=> String
resp.instance_initiated_shutdown_behavior #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.instance_type #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.kernel_id #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.product_codes #=> Array
resp.product_codes[0].product_code_id #=> String
resp.product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"
resp.ramdisk_id #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.root_device_name #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.source_dest_check.value #=> Boolean
resp.sriov_net_support #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.user_data #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.disable_api_stop.value #=> Boolean
resp.groups #=> Array
resp.groups[0].group_id #=> String
resp.groups[0].group_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the instance.

  • :attribute (required, String) —

    The instance attribute.

    Note: The ‘enaSupport` attribute is not supported at this time.

Returns:

See Also:



24672
24673
24674
24675
 
# File 'lib/aws-sdk-ec2/client.rb', line 24672

def describe_instance_attribute(params = {}, options = {})
  req = build_request(:describe_instance_attribute, params)
  req.send_request(options)
end

#describe_instance_connect_endpoints(params = {}) ⇒ Types::DescribeInstanceConnectEndpointsResult

Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_connect_endpoints({
  dry_run: false,
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  instance_connect_endpoint_ids: ["String"],
})

Response structure


resp.instance_connect_endpoints #=> Array
resp.instance_connect_endpoints[0].owner_id #=> String
resp.instance_connect_endpoints[0].instance_connect_endpoint_id #=> String
resp.instance_connect_endpoints[0].instance_connect_endpoint_arn #=> String
resp.instance_connect_endpoints[0].state #=> String, one of "create-in-progress", "create-complete", "create-failed", "delete-in-progress", "delete-complete", "delete-failed"
resp.instance_connect_endpoints[0].state_message #=> String
resp.instance_connect_endpoints[0].dns_name #=> String
resp.instance_connect_endpoints[0].fips_dns_name #=> String
resp.instance_connect_endpoints[0].network_interface_ids #=> Array
resp.instance_connect_endpoints[0].network_interface_ids[0] #=> String
resp.instance_connect_endpoints[0].vpc_id #=> String
resp.instance_connect_endpoints[0].availability_zone #=> String
resp.instance_connect_endpoints[0].created_at #=> Time
resp.instance_connect_endpoints[0].subnet_id #=> String
resp.instance_connect_endpoints[0].preserve_client_ip #=> Boolean
resp.instance_connect_endpoints[0].security_group_ids #=> Array
resp.instance_connect_endpoints[0].security_group_ids[0] #=> String
resp.instance_connect_endpoints[0].tags #=> Array
resp.instance_connect_endpoints[0].tags[0].key #=> String
resp.instance_connect_endpoints[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :filters (Array<Types::Filter>) —

    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`:&lt;key&gt; - 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.

  • :instance_connect_endpoint_ids (Array<String>) —

    One or more EC2 Instance Connect Endpoint IDs.

Returns:

See Also:



24782
24783
24784
24785
 
# File 'lib/aws-sdk-ec2/client.rb', line 24782

def describe_instance_connect_endpoints(params = {}, options = {})
  req = build_request(:describe_instance_connect_endpoints, params)
  req.send_request(options)
end

#describe_instance_credit_specifications(params = {}) ⇒ Types::DescribeInstanceCreditSpecificationsResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_credit_specifications({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  instance_ids: ["InstanceId"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.instance_credit_specifications #=> Array
resp.instance_credit_specifications[0].instance_id #=> String
resp.instance_credit_specifications[0].cpu_credits #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘instance-id` - The ID of the instance.

    ^

  • :instance_ids (Array<String>) —

    The instance IDs.

    Default: Describes all your instances.

    Constraints: Maximum 1000 explicitly specified instance IDs.

  • :max_results (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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



24887
24888
24889
24890
 
# File 'lib/aws-sdk-ec2/client.rb', line 24887

def describe_instance_credit_specifications(params = {}, options = {})
  req = build_request(:describe_instance_credit_specifications, params)
  req.send_request(options)
end

#describe_instance_event_notification_attributes(params = {}) ⇒ Types::DescribeInstanceEventNotificationAttributesResult

Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_event_notification_attributes({
  dry_run: false,
})

Response structure


resp.instance_tag_attribute.instance_tag_keys #=> Array
resp.instance_tag_attribute.instance_tag_keys[0] #=> String
resp.instance_tag_attribute.include_all_tags_of_instance #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



24921
24922
24923
24924
 
# File 'lib/aws-sdk-ec2/client.rb', line 24921

def describe_instance_event_notification_attributes(params = {}, options = {})
  req = build_request(:describe_instance_event_notification_attributes, params)
  req.send_request(options)
end

#describe_instance_event_windows(params = {}) ⇒ Types::DescribeInstanceEventWindowsResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_event_windows({
  dry_run: false,
  instance_event_window_ids: ["InstanceEventWindowId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.instance_event_windows #=> Array
resp.instance_event_windows[0].instance_event_window_id #=> String
resp.instance_event_windows[0].time_ranges #=> Array
resp.instance_event_windows[0].time_ranges[0].start_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_windows[0].time_ranges[0].start_hour #=> Integer
resp.instance_event_windows[0].time_ranges[0].end_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_windows[0].time_ranges[0].end_hour #=> Integer
resp.instance_event_windows[0].name #=> String
resp.instance_event_windows[0].cron_expression #=> String
resp.instance_event_windows[0].association_target.instance_ids #=> Array
resp.instance_event_windows[0].association_target.instance_ids[0] #=> String
resp.instance_event_windows[0].association_target.tags #=> Array
resp.instance_event_windows[0].association_target.tags[0].key #=> String
resp.instance_event_windows[0].association_target.tags[0].value #=> String
resp.instance_event_windows[0].association_target.dedicated_host_ids #=> Array
resp.instance_event_windows[0].association_target.dedicated_host_ids[0] #=> String
resp.instance_event_windows[0].state #=> String, one of "creating", "deleting", "active", "deleted"
resp.instance_event_windows[0].tags #=> Array
resp.instance_event_windows[0].tags[0].key #=> String
resp.instance_event_windows[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_event_window_ids (Array<String>) —

    The IDs of the event windows.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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.

  • :next_token (String) —

    The token to request the next page of results.

Returns:

See Also:



25046
25047
25048
25049
 
# File 'lib/aws-sdk-ec2/client.rb', line 25046

def describe_instance_event_windows(params = {}, options = {})
  req = build_request(:describe_instance_event_windows, params)
  req.send_request(options)
end

#describe_instance_status(params = {}) ⇒ Types::DescribeInstanceStatusResult

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][2

    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][4

    in the *Amazon EC2 User Guide*.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html [4]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* instance_status_ok
* system_status_ok

Examples:

Example: To describe the status of an instance


# This example describes the current status of the specified instance.

resp = client.describe_instance_status({
  instance_ids: [
    "i-1234567890abcdef0", 
  ], 
})

resp.to_h outputs the following:
{
  instance_statuses: [
    {
      availability_zone: "us-east-1d", 
      instance_id: "i-1234567890abcdef0", 
      instance_state: {
        code: 16, 
        name: "running", 
      }, 
      instance_status: {
        details: [
          {
            name: "reachability", 
            status: "passed", 
          }, 
        ], 
        status: "ok", 
      }, 
      system_status: {
        details: [
          {
            name: "reachability", 
            status: "passed", 
          }, 
        ], 
        status: "ok", 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_instance_status({
  instance_ids: ["InstanceId"],
  max_results: 1,
  next_token: "String",
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  include_all_instances: false,
})

Response structure


resp.instance_statuses #=> Array
resp.instance_statuses[0].availability_zone #=> String
resp.instance_statuses[0].outpost_arn #=> String
resp.instance_statuses[0].events #=> Array
resp.instance_statuses[0].events[0].instance_event_id #=> String
resp.instance_statuses[0].events[0].code #=> String, one of "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop"
resp.instance_statuses[0].events[0].description #=> String
resp.instance_statuses[0].events[0].not_after #=> Time
resp.instance_statuses[0].events[0].not_before #=> Time
resp.instance_statuses[0].events[0].not_before_deadline #=> Time
resp.instance_statuses[0].instance_id #=> String
resp.instance_statuses[0].instance_state.code #=> Integer
resp.instance_statuses[0].instance_state.name #=> String, one of "pending", "running", "shutting-down", "terminated", "stopping", "stopped"
resp.instance_statuses[0].instance_status.details #=> Array
resp.instance_statuses[0].instance_status.details[0].impaired_since #=> Time
resp.instance_statuses[0].instance_status.details[0].name #=> String, one of "reachability"
resp.instance_statuses[0].instance_status.details[0].status #=> String, one of "passed", "failed", "insufficient-data", "initializing"
resp.instance_statuses[0].instance_status.status #=> String, one of "ok", "impaired", "insufficient-data", "not-applicable", "initializing"
resp.instance_statuses[0].system_status.details #=> Array
resp.instance_statuses[0].system_status.details[0].impaired_since #=> Time
resp.instance_statuses[0].system_status.details[0].name #=> String, one of "reachability"
resp.instance_statuses[0].system_status.details[0].status #=> String, one of "passed", "failed", "insufficient-data", "initializing"
resp.instance_statuses[0].system_status.status #=> String, one of "ok", "impaired", "insufficient-data", "not-applicable", "initializing"
resp.instance_statuses[0].attached_ebs_status.details #=> Array
resp.instance_statuses[0].attached_ebs_status.details[0].impaired_since #=> Time
resp.instance_statuses[0].attached_ebs_status.details[0].name #=> String, one of "reachability"
resp.instance_statuses[0].attached_ebs_status.details[0].status #=> String, one of "passed", "failed", "insufficient-data", "initializing"
resp.instance_statuses[0].attached_ebs_status.status #=> String, one of "ok", "impaired", "insufficient-data", "not-applicable", "initializing"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (Array<String>) —

    The instance IDs.

    Default: Describes all your instances.

    Constraints: Maximum 100 explicitly specified instance IDs.

  • :max_results (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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :dry_run (Boolean) —

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

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘availability-zone` - The Availability Zone of the instance.

    • ‘event.code` - The code for the scheduled event (`instance-reboot` | `system-reboot` | `system-maintenance` | `instance-retirement` | `instance-stop`).

    • ‘event.description` - A description of the event.

    • ‘event.instance-event-id` - The ID of the event whose date and time you are modifying.

    • ‘event.not-after` - The latest end time for the scheduled event (for example, `2014-09-15T17:15:20.000Z`).

    • ‘event.not-before` - The earliest start time for the scheduled event (for example, `2014-09-15T17:15:20.000Z`).

    • ‘event.not-before-deadline` - The deadline for starting the event (for example, `2014-09-15T17:15:20.000Z`).

    • ‘instance-state-code` - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

    • ‘instance-state-name` - The state of the instance (`pending` | `running` | `shutting-down` | `terminated` | `stopping` | `stopped`).

    • ‘instance-status.reachability` - Filters on instance status where the name is `reachability` (`passed` | `failed` | `initializing` | `insufficient-data`).

    • ‘instance-status.status` - The status of the instance (`ok` | `impaired` | `initializing` | `insufficient-data` | `not-applicable`).

    • ‘system-status.reachability` - Filters on system status where the name is `reachability` (`passed` | `failed` | `initializing` | `insufficient-data`).

    • ‘system-status.status` - The system status of the instance (`ok` | `impaired` | `initializing` | `insufficient-data` | `not-applicable`).

    • ‘attached-ebs-status.status` - The status of the attached EBS volume for the instance (`ok` | `impaired` | `initializing` | `insufficient-data` | `not-applicable`).

  • :include_all_instances (Boolean) —

    When ‘true`, includes the health status for all instances. When `false`, includes the health status for running instances only.

    Default: ‘false`

Returns:

See Also:



25282
25283
25284
25285
 
# File 'lib/aws-sdk-ec2/client.rb', line 25282

def describe_instance_status(params = {}, options = {})
  req = build_request(:describe_instance_status, params)
  req.send_request(options)
end

#describe_instance_topology(params = {}) ⇒ Types::DescribeInstanceTopologyResult

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` | `p5e.48xlarge`

    • ‘trn1.2xlarge` | `trn1.32xlarge` | `trn1n.32xlarge`

For more information, see [Amazon EC2 instance topology] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_topology({
  dry_run: false,
  next_token: "String",
  max_results: 1,
  instance_ids: ["InstanceId"],
  group_names: ["PlacementGroupName"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.instances #=> Array
resp.instances[0].instance_id #=> String
resp.instances[0].instance_type #=> String
resp.instances[0].group_name #=> String
resp.instances[0].network_nodes #=> Array
resp.instances[0].network_nodes[0] #=> String
resp.instances[0].availability_zone #=> String
resp.instances[0].zone_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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`

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :instance_ids (Array<String>) —

    The instance IDs.

    Default: Describes all your instances.

    Constraints: Maximum 100 explicitly specified instance IDs.

  • :group_names (Array<String>) —

    The name of the placement group that each instance is in.

    Constraints: Maximum 100 explicitly specified placement group names.

  • :filters (Array<Types::Filter>) —

    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.

Returns:

See Also:



25410
25411
25412
25413
 
# File 'lib/aws-sdk-ec2/client.rb', line 25410

def describe_instance_topology(params = {}, options = {})
  req = build_request(:describe_instance_topology, params)
  req.send_request(options)
end

#describe_instance_type_offerings(params = {}) ⇒ Types::DescribeInstanceTypeOfferingsResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_type_offerings({
  dry_run: false,
  location_type: "region", # accepts region, availability-zone, availability-zone-id, outpost
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.instance_type_offerings #=> Array
resp.instance_type_offerings[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.instance_type_offerings[0].location_type #=> String, one of "region", "availability-zone", "availability-zone-id", "outpost"
resp.instance_type_offerings[0].location #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :location_type (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.

  • :filters (Array<Types::Filter>) —

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

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Instance.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



25502
25503
25504
25505
 
# File 'lib/aws-sdk-ec2/client.rb', line 25502

def describe_instance_type_offerings(params = {}, options = {})
  req = build_request(:describe_instance_type_offerings, params)
  req.send_request(options)
end

#describe_instance_types(params = {}) ⇒ Types::DescribeInstanceTypesResult

Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_types({
  dry_run: false,
  instance_types: ["a1.medium"], # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.instance_types #=> Array
resp.instance_types[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.instance_types[0].current_generation #=> Boolean
resp.instance_types[0].free_tier_eligible #=> Boolean
resp.instance_types[0].supported_usage_classes #=> Array
resp.instance_types[0].supported_usage_classes[0] #=> String, one of "spot", "on-demand", "capacity-block"
resp.instance_types[0].supported_root_device_types #=> Array
resp.instance_types[0].supported_root_device_types[0] #=> String, one of "ebs", "instance-store"
resp.instance_types[0].supported_virtualization_types #=> Array
resp.instance_types[0].supported_virtualization_types[0] #=> String, one of "hvm", "paravirtual"
resp.instance_types[0].bare_metal #=> Boolean
resp.instance_types[0].hypervisor #=> String, one of "nitro", "xen"
resp.instance_types[0].processor_info.supported_architectures #=> Array
resp.instance_types[0].processor_info.supported_architectures[0] #=> String, one of "i386", "x86_64", "arm64", "x86_64_mac", "arm64_mac"
resp.instance_types[0].processor_info.sustained_clock_speed_in_ghz #=> Float
resp.instance_types[0].processor_info.supported_features #=> Array
resp.instance_types[0].processor_info.supported_features[0] #=> String, one of "amd-sev-snp"
resp.instance_types[0].processor_info.manufacturer #=> String
resp.instance_types[0].v_cpu_info.default_v_cpus #=> Integer
resp.instance_types[0].v_cpu_info.default_cores #=> Integer
resp.instance_types[0].v_cpu_info.default_threads_per_core #=> Integer
resp.instance_types[0].v_cpu_info.valid_cores #=> Array
resp.instance_types[0].v_cpu_info.valid_cores[0] #=> Integer
resp.instance_types[0].v_cpu_info.valid_threads_per_core #=> Array
resp.instance_types[0].v_cpu_info.valid_threads_per_core[0] #=> Integer
resp.instance_types[0].memory_info.size_in_mi_b #=> Integer
resp.instance_types[0].instance_storage_supported #=> Boolean
resp.instance_types[0].instance_storage_info.total_size_in_gb #=> Integer
resp.instance_types[0].instance_storage_info.disks #=> Array
resp.instance_types[0].instance_storage_info.disks[0].size_in_gb #=> Integer
resp.instance_types[0].instance_storage_info.disks[0].count #=> Integer
resp.instance_types[0].instance_storage_info.disks[0].type #=> String, one of "hdd", "ssd"
resp.instance_types[0].instance_storage_info.nvme_support #=> String, one of "unsupported", "supported", "required"
resp.instance_types[0].instance_storage_info.encryption_support #=> String, one of "unsupported", "required"
resp.instance_types[0].ebs_info.ebs_optimized_support #=> String, one of "unsupported", "supported", "default"
resp.instance_types[0].ebs_info.encryption_support #=> String, one of "unsupported", "supported"
resp.instance_types[0].ebs_info.ebs_optimized_info.baseline_bandwidth_in_mbps #=> Integer
resp.instance_types[0].ebs_info.ebs_optimized_info.baseline_throughput_in_m_bps #=> Float
resp.instance_types[0].ebs_info.ebs_optimized_info.baseline_iops #=> Integer
resp.instance_types[0].ebs_info.ebs_optimized_info.maximum_bandwidth_in_mbps #=> Integer
resp.instance_types[0].ebs_info.ebs_optimized_info.maximum_throughput_in_m_bps #=> Float
resp.instance_types[0].ebs_info.ebs_optimized_info.maximum_iops #=> Integer
resp.instance_types[0].ebs_info.nvme_support #=> String, one of "unsupported", "supported", "required"
resp.instance_types[0].network_info.network_performance #=> String
resp.instance_types[0].network_info.maximum_network_interfaces #=> Integer
resp.instance_types[0].network_info.maximum_network_cards #=> Integer
resp.instance_types[0].network_info.default_network_card_index #=> Integer
resp.instance_types[0].network_info.network_cards #=> Array
resp.instance_types[0].network_info.network_cards[0].network_card_index #=> Integer
resp.instance_types[0].network_info.network_cards[0].network_performance #=> String
resp.instance_types[0].network_info.network_cards[0].maximum_network_interfaces #=> Integer
resp.instance_types[0].network_info.network_cards[0].baseline_bandwidth_in_gbps #=> Float
resp.instance_types[0].network_info.network_cards[0].peak_bandwidth_in_gbps #=> Float
resp.instance_types[0].network_info.ipv_4_addresses_per_interface #=> Integer
resp.instance_types[0].network_info.ipv_6_addresses_per_interface #=> Integer
resp.instance_types[0].network_info.ipv_6_supported #=> Boolean
resp.instance_types[0].network_info.ena_support #=> String, one of "unsupported", "supported", "required"
resp.instance_types[0].network_info.efa_supported #=> Boolean
resp.instance_types[0].network_info.efa_info.maximum_efa_interfaces #=> Integer
resp.instance_types[0].network_info.encryption_in_transit_supported #=> Boolean
resp.instance_types[0].network_info.ena_srd_supported #=> Boolean
resp.instance_types[0].gpu_info.gpus #=> Array
resp.instance_types[0].gpu_info.gpus[0].name #=> String
resp.instance_types[0].gpu_info.gpus[0].manufacturer #=> String
resp.instance_types[0].gpu_info.gpus[0].count #=> Integer
resp.instance_types[0].gpu_info.gpus[0].memory_info.size_in_mi_b #=> Integer
resp.instance_types[0].gpu_info.total_gpu_memory_in_mi_b #=> Integer
resp.instance_types[0].fpga_info.fpgas #=> Array
resp.instance_types[0].fpga_info.fpgas[0].name #=> String
resp.instance_types[0].fpga_info.fpgas[0].manufacturer #=> String
resp.instance_types[0].fpga_info.fpgas[0].count #=> Integer
resp.instance_types[0].fpga_info.fpgas[0].memory_info.size_in_mi_b #=> Integer
resp.instance_types[0].fpga_info.total_fpga_memory_in_mi_b #=> Integer
resp.instance_types[0].placement_group_info.supported_strategies #=> Array
resp.instance_types[0].placement_group_info.supported_strategies[0] #=> String, one of "cluster", "partition", "spread"
resp.instance_types[0].inference_accelerator_info.accelerators #=> Array
resp.instance_types[0].inference_accelerator_info.accelerators[0].count #=> Integer
resp.instance_types[0].inference_accelerator_info.accelerators[0].name #=> String
resp.instance_types[0].inference_accelerator_info.accelerators[0].manufacturer #=> String
resp.instance_types[0].inference_accelerator_info.accelerators[0].memory_info.size_in_mi_b #=> Integer
resp.instance_types[0].inference_accelerator_info.total_inference_memory_in_mi_b #=> Integer
resp.instance_types[0].hibernation_supported #=> Boolean
resp.instance_types[0].burstable_performance_supported #=> Boolean
resp.instance_types[0].dedicated_hosts_supported #=> Boolean
resp.instance_types[0].auto_recovery_supported #=> Boolean
resp.instance_types[0].supported_boot_modes #=> Array
resp.instance_types[0].supported_boot_modes[0] #=> String, one of "legacy-bios", "uefi"
resp.instance_types[0].nitro_enclaves_support #=> String, one of "unsupported", "supported"
resp.instance_types[0].nitro_tpm_support #=> String, one of "unsupported", "supported"
resp.instance_types[0].nitro_tpm_info.supported_versions #=> Array
resp.instance_types[0].nitro_tpm_info.supported_versions[0] #=> String
resp.instance_types[0].media_accelerator_info.accelerators #=> Array
resp.instance_types[0].media_accelerator_info.accelerators[0].count #=> Integer
resp.instance_types[0].media_accelerator_info.accelerators[0].name #=> String
resp.instance_types[0].media_accelerator_info.accelerators[0].manufacturer #=> String
resp.instance_types[0].media_accelerator_info.accelerators[0].memory_info.size_in_mi_b #=> Integer
resp.instance_types[0].media_accelerator_info.total_media_memory_in_mi_b #=> Integer
resp.instance_types[0].neuron_info.neuron_devices #=> Array
resp.instance_types[0].neuron_info.neuron_devices[0].count #=> Integer
resp.instance_types[0].neuron_info.neuron_devices[0].name #=> String
resp.instance_types[0].neuron_info.neuron_devices[0].core_info.count #=> Integer
resp.instance_types[0].neuron_info.neuron_devices[0].core_info.version #=> Integer
resp.instance_types[0].neuron_info.neuron_devices[0].memory_info.size_in_mi_b #=> Integer
resp.instance_types[0].neuron_info.total_neuron_device_memory_in_mi_b #=> Integer
resp.instance_types[0].phc_support #=> String, one of "unsupported", "supported"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_types (Array<String>) —

    The instance types.

  • :filters (Array<Types::Filter>) —

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

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



25828
25829
25830
25831
 
# File 'lib/aws-sdk-ec2/client.rb', line 25828

def describe_instance_types(params = {}, options = {})
  req = build_request(:describe_instance_types, params)
  req.send_request(options)
end

#describe_instances(params = {}) ⇒ Types::DescribeInstancesResult

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 markdown=“1”> 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.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* instance_exists
* instance_running
* instance_stopped
* instance_terminated

Examples:

Example: To describe an Amazon EC2 instance


# This example describes the specified instance.

resp = client.describe_instances({
  instance_ids: [
    "i-1234567890abcdef0", 
  ], 
})

resp.to_h outputs the following:
{
}

Example: To describe the instances with a specific instance type


# This example describes the instances with the t2.micro instance type.

resp = client.describe_instances({
  filters: [
    {
      name: "instance-type", 
      values: [
        "t2.micro", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Example: To describe the instances with a specific tag


# This example describes the instances with the Purpose=test tag.

resp = client.describe_instances({
  filters: [
    {
      name: "tag:Purpose", 
      values: [
        "test", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Filtering by tags examples

# filtering by tag keys "key1" or "key2"
ec2.describe_instances(filters:[{ name: 'tag-key', values: ['key1', 'key2'] }])

# filtering by tag values "value1" or "value1"
ec2.describe_instances(filters:[{ name: 'tag-value', values: ['value1', 'value2'] }])

# filtering by key and value, key equals "key1" and value equals "value1" or "value2"
ec2.describe_instances(filters:[{ name: "tag:key1", values: ['value1', 'value2'] }])

Request syntax with placeholder values


resp = client.describe_instances({
  instance_ids: ["InstanceId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.reservations #=> Array
resp.reservations[0].reservation_id #=> String
resp.reservations[0].owner_id #=> String
resp.reservations[0].requester_id #=> String
resp.reservations[0].groups #=> Array
resp.reservations[0].groups[0].group_id #=> String
resp.reservations[0].groups[0].group_name #=> String
resp.reservations[0].instances #=> Array
resp.reservations[0].instances[0].architecture #=> String, one of "i386", "x86_64", "arm64", "x86_64_mac", "arm64_mac"
resp.reservations[0].instances[0].block_device_mappings #=> Array
resp.reservations[0].instances[0].block_device_mappings[0].device_name #=> String
resp.reservations[0].instances[0].block_device_mappings[0].ebs.attach_time #=> Time
resp.reservations[0].instances[0].block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.reservations[0].instances[0].block_device_mappings[0].ebs.status #=> String, one of "attaching", "attached", "detaching", "detached"
resp.reservations[0].instances[0].block_device_mappings[0].ebs.volume_id #=> String
resp.reservations[0].instances[0].block_device_mappings[0].ebs.associated_resource #=> String
resp.reservations[0].instances[0].block_device_mappings[0].ebs.volume_owner_id #=> String
resp.reservations[0].instances[0].client_token #=> String
resp.reservations[0].instances[0].ebs_optimized #=> Boolean
resp.reservations[0].instances[0].ena_support #=> Boolean
resp.reservations[0].instances[0].hypervisor #=> String, one of "ovm", "xen"
resp.reservations[0].instances[0].iam_instance_profile.arn #=> String
resp.reservations[0].instances[0].iam_instance_profile.id #=> String
resp.reservations[0].instances[0].instance_lifecycle #=> String, one of "spot", "scheduled", "capacity-block"
resp.reservations[0].instances[0].elastic_gpu_associations #=> Array
resp.reservations[0].instances[0].elastic_gpu_associations[0].elastic_gpu_id #=> String
resp.reservations[0].instances[0].elastic_gpu_associations[0].elastic_gpu_association_id #=> String
resp.reservations[0].instances[0].elastic_gpu_associations[0].elastic_gpu_association_state #=> String
resp.reservations[0].instances[0].elastic_gpu_associations[0].elastic_gpu_association_time #=> String
resp.reservations[0].instances[0].elastic_inference_accelerator_associations #=> Array
resp.reservations[0].instances[0].elastic_inference_accelerator_associations[0].elastic_inference_accelerator_arn #=> String
resp.reservations[0].instances[0].elastic_inference_accelerator_associations[0].elastic_inference_accelerator_association_id #=> String
resp.reservations[0].instances[0].elastic_inference_accelerator_associations[0].elastic_inference_accelerator_association_state #=> String
resp.reservations[0].instances[0].elastic_inference_accelerator_associations[0].elastic_inference_accelerator_association_time #=> Time
resp.reservations[0].instances[0].network_interfaces #=> Array
resp.reservations[0].instances[0].network_interfaces[0].association.carrier_ip #=> String
resp.reservations[0].instances[0].network_interfaces[0].association.customer_owned_ip #=> String
resp.reservations[0].instances[0].network_interfaces[0].association.ip_owner_id #=> String
resp.reservations[0].instances[0].network_interfaces[0].association.public_dns_name #=> String
resp.reservations[0].instances[0].network_interfaces[0].association.public_ip #=> String
resp.reservations[0].instances[0].network_interfaces[0].attachment.attach_time #=> Time
resp.reservations[0].instances[0].network_interfaces[0].attachment.attachment_id #=> String
resp.reservations[0].instances[0].network_interfaces[0].attachment.delete_on_termination #=> Boolean
resp.reservations[0].instances[0].network_interfaces[0].attachment.device_index #=> Integer
resp.reservations[0].instances[0].network_interfaces[0].attachment.status #=> String, one of "attaching", "attached", "detaching", "detached"
resp.reservations[0].instances[0].network_interfaces[0].attachment.network_card_index #=> Integer
resp.reservations[0].instances[0].network_interfaces[0].attachment.ena_srd_specification.ena_srd_enabled #=> Boolean
resp.reservations[0].instances[0].network_interfaces[0].attachment.ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.reservations[0].instances[0].network_interfaces[0].description #=> String
resp.reservations[0].instances[0].network_interfaces[0].groups #=> Array
resp.reservations[0].instances[0].network_interfaces[0].groups[0].group_id #=> String
resp.reservations[0].instances[0].network_interfaces[0].groups[0].group_name #=> String
resp.reservations[0].instances[0].network_interfaces[0].ipv_6_addresses #=> Array
resp.reservations[0].instances[0].network_interfaces[0].ipv_6_addresses[0].ipv_6_address #=> String
resp.reservations[0].instances[0].network_interfaces[0].ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.reservations[0].instances[0].network_interfaces[0].mac_address #=> String
resp.reservations[0].instances[0].network_interfaces[0].network_interface_id #=> String
resp.reservations[0].instances[0].network_interfaces[0].owner_id #=> String
resp.reservations[0].instances[0].network_interfaces[0].private_dns_name #=> String
resp.reservations[0].instances[0].network_interfaces[0].private_ip_address #=> String
resp.reservations[0].instances[0].network_interfaces[0].private_ip_addresses #=> Array
resp.reservations[0].instances[0].network_interfaces[0].private_ip_addresses[0].association.carrier_ip #=> String
resp.reservations[0].instances[0].network_interfaces[0].private_ip_addresses[0].association.customer_owned_ip #=> String
resp.reservations[0].instances[0].network_interfaces[0].private_ip_addresses[0].association.ip_owner_id #=> String
resp.reservations[0].instances[0].network_interfaces[0].private_ip_addresses[0].association.public_dns_name #=> String
resp.reservations[0].instances[0].network_interfaces[0].private_ip_addresses[0].association.public_ip #=> String
resp.reservations[0].instances[0].network_interfaces[0].private_ip_addresses[0].primary #=> Boolean
resp.reservations[0].instances[0].network_interfaces[0].private_ip_addresses[0].private_dns_name #=> String
resp.reservations[0].instances[0].network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String
resp.reservations[0].instances[0].network_interfaces[0].source_dest_check #=> Boolean
resp.reservations[0].instances[0].network_interfaces[0].status #=> String, one of "available", "associated", "attaching", "in-use", "detaching"
resp.reservations[0].instances[0].network_interfaces[0].subnet_id #=> String
resp.reservations[0].instances[0].network_interfaces[0].vpc_id #=> String
resp.reservations[0].instances[0].network_interfaces[0].interface_type #=> String
resp.reservations[0].instances[0].network_interfaces[0].ipv_4_prefixes #=> Array
resp.reservations[0].instances[0].network_interfaces[0].ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.reservations[0].instances[0].network_interfaces[0].ipv_6_prefixes #=> Array
resp.reservations[0].instances[0].network_interfaces[0].ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.reservations[0].instances[0].network_interfaces[0].connection_tracking_configuration.tcp_established_timeout #=> Integer
resp.reservations[0].instances[0].network_interfaces[0].connection_tracking_configuration.udp_stream_timeout #=> Integer
resp.reservations[0].instances[0].network_interfaces[0].connection_tracking_configuration.udp_timeout #=> Integer
resp.reservations[0].instances[0].outpost_arn #=> String
resp.reservations[0].instances[0].root_device_name #=> String
resp.reservations[0].instances[0].root_device_type #=> String, one of "ebs", "instance-store"
resp.reservations[0].instances[0].security_groups #=> Array
resp.reservations[0].instances[0].security_groups[0].group_id #=> String
resp.reservations[0].instances[0].security_groups[0].group_name #=> String
resp.reservations[0].instances[0].source_dest_check #=> Boolean
resp.reservations[0].instances[0].spot_instance_request_id #=> String
resp.reservations[0].instances[0].sriov_net_support #=> String
resp.reservations[0].instances[0].state_reason.code #=> String
resp.reservations[0].instances[0].state_reason.message #=> String
resp.reservations[0].instances[0].tags #=> Array
resp.reservations[0].instances[0].tags[0].key #=> String
resp.reservations[0].instances[0].tags[0].value #=> String
resp.reservations[0].instances[0].virtualization_type #=> String, one of "hvm", "paravirtual"
resp.reservations[0].instances[0].cpu_options.core_count #=> Integer
resp.reservations[0].instances[0].cpu_options.threads_per_core #=> Integer
resp.reservations[0].instances[0].cpu_options.amd_sev_snp #=> String, one of "enabled", "disabled"
resp.reservations[0].instances[0].capacity_reservation_id #=> String
resp.reservations[0].instances[0].capacity_reservation_specification.capacity_reservation_preference #=> String, one of "open", "none"
resp.reservations[0].instances[0].capacity_reservation_specification.capacity_reservation_target.capacity_reservation_id #=> String
resp.reservations[0].instances[0].capacity_reservation_specification.capacity_reservation_target.capacity_reservation_resource_group_arn #=> String
resp.reservations[0].instances[0].hibernation_options.configured #=> Boolean
resp.reservations[0].instances[0].licenses #=> Array
resp.reservations[0].instances[0].licenses[0].license_configuration_arn #=> String
resp.reservations[0].instances[0].metadata_options.state #=> String, one of "pending", "applied"
resp.reservations[0].instances[0].metadata_options.http_tokens #=> String, one of "optional", "required"
resp.reservations[0].instances[0].metadata_options.http_put_response_hop_limit #=> Integer
resp.reservations[0].instances[0].metadata_options.http_endpoint #=> String, one of "disabled", "enabled"
resp.reservations[0].instances[0].metadata_options.http_protocol_ipv_6 #=> String, one of "disabled", "enabled"
resp.reservations[0].instances[0].metadata_options.instance_metadata_tags #=> String, one of "disabled", "enabled"
resp.reservations[0].instances[0].enclave_options.enabled #=> Boolean
resp.reservations[0].instances[0].boot_mode #=> String, one of "legacy-bios", "uefi", "uefi-preferred"
resp.reservations[0].instances[0].platform_details #=> String
resp.reservations[0].instances[0].usage_operation #=> String
resp.reservations[0].instances[0].usage_operation_update_time #=> Time
resp.reservations[0].instances[0].private_dns_name_options.hostname_type #=> String, one of "ip-name", "resource-name"
resp.reservations[0].instances[0].private_dns_name_options.enable_resource_name_dns_a_record #=> Boolean
resp.reservations[0].instances[0].private_dns_name_options.enable_resource_name_dns_aaaa_record #=> Boolean
resp.reservations[0].instances[0].ipv_6_address #=> String
resp.reservations[0].instances[0].tpm_support #=> String
resp.reservations[0].instances[0].maintenance_options.auto_recovery #=> String, one of "disabled", "default"
resp.reservations[0].instances[0].current_instance_boot_mode #=> String, one of "legacy-bios", "uefi"
resp.reservations[0].instances[0].instance_id #=> String
resp.reservations[0].instances[0].image_id #=> String
resp.reservations[0].instances[0].state.code #=> Integer
resp.reservations[0].instances[0].state.name #=> String, one of "pending", "running", "shutting-down", "terminated", "stopping", "stopped"
resp.reservations[0].instances[0].private_dns_name #=> String
resp.reservations[0].instances[0].public_dns_name #=> String
resp.reservations[0].instances[0].state_transition_reason #=> String
resp.reservations[0].instances[0].key_name #=> String
resp.reservations[0].instances[0].ami_launch_index #=> Integer
resp.reservations[0].instances[0].product_codes #=> Array
resp.reservations[0].instances[0].product_codes[0].product_code_id #=> String
resp.reservations[0].instances[0].product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"
resp.reservations[0].instances[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.reservations[0].instances[0].launch_time #=> Time
resp.reservations[0].instances[0].placement.affinity #=> String
resp.reservations[0].instances[0].placement.group_name #=> String
resp.reservations[0].instances[0].placement.partition_number #=> Integer
resp.reservations[0].instances[0].placement.host_id #=> String
resp.reservations[0].instances[0].placement.tenancy #=> String, one of "default", "dedicated", "host"
resp.reservations[0].instances[0].placement.spread_domain #=> String
resp.reservations[0].instances[0].placement.host_resource_group_arn #=> String
resp.reservations[0].instances[0].placement.group_id #=> String
resp.reservations[0].instances[0].placement.availability_zone #=> String
resp.reservations[0].instances[0].kernel_id #=> String
resp.reservations[0].instances[0].ramdisk_id #=> String
resp.reservations[0].instances[0].platform #=> String, one of "Windows"
resp.reservations[0].instances[0].monitoring.state #=> String, one of "disabled", "disabling", "enabled", "pending"
resp.reservations[0].instances[0].subnet_id #=> String
resp.reservations[0].instances[0].vpc_id #=> String
resp.reservations[0].instances[0].private_ip_address #=> String
resp.reservations[0].instances[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (Array<String>) —

    The instance IDs.

    Default: Describes all your instances.

  • :dry_run (Boolean) —

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

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘affinity` - The affinity setting for an instance running on a Dedicated Host (`default` | `host`).

    • ‘architecture` - The instance architecture (`i386` | `x86_64` | `arm64`).

    • ‘availability-zone` - The Availability Zone of the instance.

    • ‘block-device-mapping.attach-time` - The attach time for an EBS volume mapped to the instance, for example, `2022-09-15T17:15:20.000Z`.

    • ‘block-device-mapping.delete-on-termination` - A Boolean that indicates whether the EBS volume is deleted on instance termination.

    • ‘block-device-mapping.device-name` - The device name specified in the block device mapping (for example, `/dev/sdh` or `xvdh`).

    • ‘block-device-mapping.status` - The status for the EBS volume (`attaching` | `attached` | `detaching` | `detached`).

    • ‘block-device-mapping.volume-id` - The volume ID of the EBS volume.

    • ‘boot-mode` - The boot mode that was specified by the AMI (`legacy-bios` | `uefi` | `uefi-preferred`).

    • ‘capacity-reservation-id` - The ID of the Capacity Reservation into which the instance was launched.

    • ‘capacity-reservation-specification.capacity-reservation-preference`

      • The instance’s Capacity Reservation preference (‘open` |

      ‘none`).

    • ‘capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id`

      • The ID of the targeted Capacity Reservation.

    • ‘capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn`

      • The ARN of the targeted Capacity Reservation group.

    • ‘client-token` - The idempotency token you provided when you launched the instance.

    • ‘current-instance-boot-mode` - The boot mode that is used to launch the instance at launch or start (`legacy-bios` | `uefi`).

    • ‘dns-name` - The public DNS name of the instance.

    • ‘ebs-optimized` - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.

    • ‘ena-support` - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.

    • ‘enclave-options.enabled` - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

    • ‘hibernation-options.configured` - A Boolean that indicates whether the instance is enabled for hibernation. A value of `true` means that the instance is enabled for hibernation.

    • ‘host-id` - The ID of the Dedicated Host on which the instance is running, if applicable.

    • ‘hypervisor` - The hypervisor type of the instance (`ovm` | `xen`). The value `xen` is used for both Xen and Nitro hypervisors.

    • ‘iam-instance-profile.arn` - The instance profile associated with the instance. Specified as an ARN.

    • ‘iam-instance-profile.id` - The instance profile associated with the instance. Specified as an ID.

    • ‘image-id` - The ID of the image used to launch the instance.

    • ‘instance-id` - The ID of the instance.

    • ‘instance-lifecycle` - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (`spot` | `scheduled` | `capacity-block`).

    • ‘instance-state-code` - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

    • ‘instance-state-name` - The state of the instance (`pending` | `running` | `shutting-down` | `terminated` | `stopping` | `stopped`).

    • ‘instance-type` - The type of instance (for example, `t2.micro`).

    • ‘instance.group-id` - The ID of the security group for the instance.

    • ‘instance.group-name` - The name of the security group for the instance.

    • ‘ip-address` - The public IPv4 address of the instance.

    • ‘ipv6-address` - The IPv6 address of the instance.

    • ‘kernel-id` - The kernel ID.

    • ‘key-name` - The name of the key pair used when the instance was launched.

    • ‘launch-index` - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

    • ‘launch-time` - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, `2021-09-29T11:04:43.305Z`. You can use a wildcard (`*`), for example, `2021-09-29T*`, which matches an entire day.

    • ‘maintenance-options.auto-recovery` - The current automatic recovery behavior of the instance (`disabled` | `default`).

    • ‘metadata-options.http-endpoint` - The status of access to the HTTP metadata endpoint on your instance (`enabled` | `disabled`)

    • ‘metadata-options.http-protocol-ipv4` - Indicates whether the IPv4 endpoint is enabled (`disabled` | `enabled`).

    • ‘metadata-options.http-protocol-ipv6` - Indicates whether the IPv6 endpoint is enabled (`disabled` | `enabled`).

    • ‘metadata-options.http-put-response-hop-limit` - The HTTP metadata request put response hop limit (integer, possible values `1` to `64`)

    • ‘metadata-options.http-tokens` - The metadata request authorization state (`optional` | `required`)

    • ‘metadata-options.instance-metadata-tags` - The status of access to instance tags from the instance metadata (`enabled` | `disabled`)

    • ‘metadata-options.state` - The state of the metadata option changes (`pending` | `applied`).

    • ‘monitoring-state` - Indicates whether detailed monitoring is enabled (`disabled` | `enabled`).

    • ‘network-interface.addresses.association.allocation-id` - The allocation ID.

    • ‘network-interface.addresses.association.association-id` - The association ID.

    • ‘network-interface.addresses.association.carrier-ip` - The carrier IP address.

    • ‘network-interface.addresses.association.customer-owned-ip` - The customer-owned IP address.

    • ‘network-interface.addresses.association.ip-owner-id` - The owner ID of the private IPv4 address associated with the network interface.

    • ‘network-interface.addresses.association.public-dns-name` - The public DNS name.

    • ‘network-interface.addresses.association.public-ip` - The ID of the association of an Elastic IP address (IPv4) with a network interface.

    • ‘network-interface.addresses.primary` - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

    • ‘network-interface.addresses.private-dns-name` - The private DNS name.

    • ‘network-interface.addresses.private-ip-address` - The private IPv4 address associated with the network interface.

    • ‘network-interface.association.allocation-id` - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

    • ‘network-interface.association.association-id` - The association ID returned when the network interface was associated with an IPv4 address.

    • ‘network-interface.association.carrier-ip` - The customer-owned IP address.

    • ‘network-interface.association.customer-owned-ip` - The customer-owned IP address.

    • ‘network-interface.association.ip-owner-id` - The owner of the Elastic IP address (IPv4) associated with the network interface.

    • ‘network-interface.association.public-dns-name` - The public DNS name.

    • ‘network-interface.association.public-ip` - The address of the Elastic IP address (IPv4) bound to the network interface.

    • ‘network-interface.attachment.attach-time` - The time that the network interface was attached to an instance.

    • ‘network-interface.attachment.attachment-id` - The ID of the interface attachment.

    • ‘network-interface.attachment.delete-on-termination` - Specifies whether the attachment is deleted when an instance is terminated.

    • ‘network-interface.attachment.device-index` - The device index to which the network interface is attached.

    • ‘network-interface.attachment.instance-id` - The ID of the instance to which the network interface is attached.

    • ‘network-interface.attachment.instance-owner-id` - The owner ID of the instance to which the network interface is attached.

    • ‘network-interface.attachment.network-card-index` - The index of the network card.

    • ‘network-interface.attachment.status` - The status of the attachment (`attaching` | `attached` | `detaching` | `detached`).

    • ‘network-interface.availability-zone` - The Availability Zone for the network interface.

    • ‘network-interface.deny-all-igw-traffic` - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.

    • ‘network-interface.description` - The description of the network interface.

    • ‘network-interface.group-id` - The ID of a security group associated with the network interface.

    • ‘network-interface.group-name` - The name of a security group associated with the network interface.

    • ‘network-interface.ipv4-prefixes.ipv4-prefix` - The IPv4 prefixes that are assigned to the network interface.

    • ‘network-interface.ipv6-address` - The IPv6 address associated with the network interface.

    • ‘network-interface.ipv6-addresses.ipv6-address` - The IPv6 address associated with the network interface.

    • ‘network-interface.ipv6-addresses.is-primary-ipv6` - A Boolean that indicates whether this is the primary IPv6 address.

    • ‘network-interface.ipv6-native` - A Boolean that indicates whether this is an IPv6 only network interface.

    • ‘network-interface.ipv6-prefixes.ipv6-prefix` - The IPv6 prefix assigned to the network interface.

    • ‘network-interface.mac-address` - The MAC address of the network interface.

    • ‘network-interface.network-interface-id` - The ID of the network interface.

    • ‘network-interface.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.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



26575
26576
26577
26578
 
# File 'lib/aws-sdk-ec2/client.rb', line 26575

def describe_instances(params = {}, options = {})
  req = build_request(:describe_instances, params)
  req.send_request(options)
end

#describe_internet_gateways(params = {}) ⇒ Types::DescribeInternetGatewaysResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* internet_gateway_exists

Examples:

Example: To describe the Internet gateway for a VPC


# This example describes the Internet gateway for the specified VPC.

resp = client.describe_internet_gateways({
  filters: [
    {
      name: "attachment.vpc-id", 
      values: [
        "vpc-a01106c2", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  internet_gateways: [
    {
      attachments: [
        {
          state: "attached", 
          vpc_id: "vpc-a01106c2", 
        }, 
      ], 
      internet_gateway_id: "igw-c0a643a9", 
      tags: [
      ], 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_internet_gateways({
  next_token: "String",
  max_results: 1,
  dry_run: false,
  internet_gateway_ids: ["InternetGatewayId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.internet_gateways #=> Array
resp.internet_gateways[0].attachments #=> Array
resp.internet_gateways[0].attachments[0].state #=> String, one of "attaching", "attached", "detaching", "detached"
resp.internet_gateways[0].attachments[0].vpc_id #=> String
resp.internet_gateways[0].internet_gateway_id #=> String
resp.internet_gateways[0].owner_id #=> String
resp.internet_gateways[0].tags #=> Array
resp.internet_gateways[0].tags[0].key #=> String
resp.internet_gateways[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

  • :internet_gateway_ids (Array<String>) —

    The IDs of the internet gateways.

    Default: Describes all your internet gateways.

  • :filters (Array<Types::Filter>) —

    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`:&lt;key&gt; - 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.

Returns:

See Also:



26710
26711
26712
26713
 
# File 'lib/aws-sdk-ec2/client.rb', line 26710

def describe_internet_gateways(params = {}, options = {})
  req = build_request(:describe_internet_gateways, params)
  req.send_request(options)
end

#describe_ipam_byoasn(params = {}) ⇒ Types::DescribeIpamByoasnResult

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

[1]: docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html

Examples:

Request syntax with placeholder values


resp = client.describe_ipam_byoasn({
  dry_run: false,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.byoasns #=> Array
resp.byoasns[0].asn #=> String
resp.byoasns[0].ipam_id #=> String
resp.byoasns[0].status_message #=> String
resp.byoasns[0].state #=> String, one of "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



26764
26765
26766
26767
 
# File 'lib/aws-sdk-ec2/client.rb', line 26764

def describe_ipam_byoasn(params = {}, options = {})
  req = build_request(:describe_ipam_byoasn, params)
  req.send_request(options)
end

#describe_ipam_external_resource_verification_tokens(params = {}) ⇒ Types::DescribeIpamExternalResourceVerificationTokensResult

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

Examples:

Request syntax with placeholder values


resp = client.describe_ipam_external_resource_verification_tokens({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  ipam_external_resource_verification_token_ids: ["String"],
})

Response structure


resp.next_token #=> String
resp.ipam_external_resource_verification_tokens #=> Array
resp.ipam_external_resource_verification_tokens[0].ipam_external_resource_verification_token_id #=> String
resp.ipam_external_resource_verification_tokens[0].ipam_external_resource_verification_token_arn #=> String
resp.ipam_external_resource_verification_tokens[0].ipam_id #=> String
resp.ipam_external_resource_verification_tokens[0].ipam_arn #=> String
resp.ipam_external_resource_verification_tokens[0].ipam_region #=> String
resp.ipam_external_resource_verification_tokens[0].token_value #=> String
resp.ipam_external_resource_verification_tokens[0].token_name #=> String
resp.ipam_external_resource_verification_tokens[0].not_after #=> Time
resp.ipam_external_resource_verification_tokens[0].status #=> String, one of "valid", "expired"
resp.ipam_external_resource_verification_tokens[0].tags #=> Array
resp.ipam_external_resource_verification_tokens[0].tags[0].key #=> String
resp.ipam_external_resource_verification_tokens[0].tags[0].value #=> String
resp.ipam_external_resource_verification_tokens[0].state #=> String, one of "create-in-progress", "create-complete", "create-failed", "delete-in-progress", "delete-complete", "delete-failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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<Types::Filter>) —

    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`

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (Integer) —

    The maximum number of tokens to return in one page of results.

  • :ipam_external_resource_verification_token_ids (Array<String>) —

    Verification token IDs.

Returns:

See Also:



26860
26861
26862
26863
 
# File 'lib/aws-sdk-ec2/client.rb', line 26860

def describe_ipam_external_resource_verification_tokens(params = {}, options = {})
  req = build_request(:describe_ipam_external_resource_verification_tokens, params)
  req.send_request(options)
end

#describe_ipam_pools(params = {}) ⇒ Types::DescribeIpamPoolsResult

Get information about your IPAM pools.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_ipam_pools({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  ipam_pool_ids: ["String"],
})

Response structure


resp.next_token #=> String
resp.ipam_pools #=> Array
resp.ipam_pools[0].owner_id #=> String
resp.ipam_pools[0].ipam_pool_id #=> String
resp.ipam_pools[0].source_ipam_pool_id #=> String
resp.ipam_pools[0].ipam_pool_arn #=> String
resp.ipam_pools[0].ipam_scope_arn #=> String
resp.ipam_pools[0].ipam_scope_type #=> String, one of "public", "private"
resp.ipam_pools[0].ipam_arn #=> String
resp.ipam_pools[0].ipam_region #=> String
resp.ipam_pools[0].locale #=> String
resp.ipam_pools[0].pool_depth #=> Integer
resp.ipam_pools[0].state #=> String, one of "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"
resp.ipam_pools[0].state_message #=> String
resp.ipam_pools[0].description #=> String
resp.ipam_pools[0].auto_import #=> Boolean
resp.ipam_pools[0].publicly_advertisable #=> Boolean
resp.ipam_pools[0].address_family #=> String, one of "ipv4", "ipv6"
resp.ipam_pools[0].allocation_min_netmask_length #=> Integer
resp.ipam_pools[0].allocation_max_netmask_length #=> Integer
resp.ipam_pools[0].allocation_default_netmask_length #=> Integer
resp.ipam_pools[0].allocation_resource_tags #=> Array
resp.ipam_pools[0].allocation_resource_tags[0].key #=> String
resp.ipam_pools[0].allocation_resource_tags[0].value #=> String
resp.ipam_pools[0].tags #=> Array
resp.ipam_pools[0].tags[0].key #=> String
resp.ipam_pools[0].tags[0].value #=> String
resp.ipam_pools[0].aws_service #=> String, one of "ec2"
resp.ipam_pools[0].public_ip_source #=> String, one of "amazon", "byoip"
resp.ipam_pools[0].source_resource.resource_id #=> String
resp.ipam_pools[0].source_resource.resource_type #=> String, one of "vpc"
resp.ipam_pools[0].source_resource.resource_region #=> String
resp.ipam_pools[0].source_resource.resource_owner #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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<Types::Filter>) —

    One or more filters for the request. For more information about filtering, see [Filtering CLI output].

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html

  • :max_results (Integer) —

    The maximum number of results to return in the request.

  • :next_token (String) —

    The token for the next page of results.

  • :ipam_pool_ids (Array<String>) —

    The IDs of the IPAM pools you would like information on.

Returns:

See Also:



26952
26953
26954
26955
 
# File 'lib/aws-sdk-ec2/client.rb', line 26952

def describe_ipam_pools(params = {}, options = {})
  req = build_request(:describe_ipam_pools, params)
  req.send_request(options)
end

#describe_ipam_resource_discoveries(params = {}) ⇒ Types::DescribeIpamResourceDiscoveriesResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_ipam_resource_discoveries({
  dry_run: false,
  ipam_resource_discovery_ids: ["String"],
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.ipam_resource_discoveries #=> Array
resp.ipam_resource_discoveries[0].owner_id #=> String
resp.ipam_resource_discoveries[0].ipam_resource_discovery_id #=> String
resp.ipam_resource_discoveries[0].ipam_resource_discovery_arn #=> String
resp.ipam_resource_discoveries[0].ipam_resource_discovery_region #=> String
resp.ipam_resource_discoveries[0].description #=> String
resp.ipam_resource_discoveries[0].operating_regions #=> Array
resp.ipam_resource_discoveries[0].operating_regions[0].region_name #=> String
resp.ipam_resource_discoveries[0].is_default #=> Boolean
resp.ipam_resource_discoveries[0].state #=> String, one of "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"
resp.ipam_resource_discoveries[0].tags #=> Array
resp.ipam_resource_discoveries[0].tags[0].key #=> String
resp.ipam_resource_discoveries[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_resource_discovery_ids (Array<String>) —

    The IPAM resource discovery IDs.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of resource discoveries to return in one page of results.

  • :filters (Array<Types::Filter>) —

    The resource discovery filters.

Returns:

See Also:



27024
27025
27026
27027
 
# File 'lib/aws-sdk-ec2/client.rb', line 27024

def describe_ipam_resource_discoveries(params = {}, options = {})
  req = build_request(:describe_ipam_resource_discoveries, params)
  req.send_request(options)
end

#describe_ipam_resource_discovery_associations(params = {}) ⇒ Types::DescribeIpamResourceDiscoveryAssociationsResult

Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_ipam_resource_discovery_associations({
  dry_run: false,
  ipam_resource_discovery_association_ids: ["String"],
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.ipam_resource_discovery_associations #=> Array
resp.ipam_resource_discovery_associations[0].owner_id #=> String
resp.ipam_resource_discovery_associations[0].ipam_resource_discovery_association_id #=> String
resp.ipam_resource_discovery_associations[0].ipam_resource_discovery_association_arn #=> String
resp.ipam_resource_discovery_associations[0].ipam_resource_discovery_id #=> String
resp.ipam_resource_discovery_associations[0].ipam_id #=> String
resp.ipam_resource_discovery_associations[0].ipam_arn #=> String
resp.ipam_resource_discovery_associations[0].ipam_region #=> String
resp.ipam_resource_discovery_associations[0].is_default #=> Boolean
resp.ipam_resource_discovery_associations[0].resource_discovery_status #=> String, one of "active", "not-found"
resp.ipam_resource_discovery_associations[0].state #=> String, one of "associate-in-progress", "associate-complete", "associate-failed", "disassociate-in-progress", "disassociate-complete", "disassociate-failed", "isolate-in-progress", "isolate-complete", "restore-in-progress"
resp.ipam_resource_discovery_associations[0].tags #=> Array
resp.ipam_resource_discovery_associations[0].tags[0].key #=> String
resp.ipam_resource_discovery_associations[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_resource_discovery_association_ids (Array<String>) —

    The resource discovery association IDs.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of resource discovery associations to return in one page of results.

  • :filters (Array<Types::Filter>) —

    The resource discovery association filters.

Returns:

See Also:



27097
27098
27099
27100
 
# File 'lib/aws-sdk-ec2/client.rb', line 27097

def describe_ipam_resource_discovery_associations(params = {}, options = {})
  req = build_request(:describe_ipam_resource_discovery_associations, params)
  req.send_request(options)
end

#describe_ipam_scopes(params = {}) ⇒ Types::DescribeIpamScopesResult

Get information about your IPAM scopes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_ipam_scopes({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  ipam_scope_ids: ["String"],
})

Response structure


resp.next_token #=> String
resp.ipam_scopes #=> Array
resp.ipam_scopes[0].owner_id #=> String
resp.ipam_scopes[0].ipam_scope_id #=> String
resp.ipam_scopes[0].ipam_scope_arn #=> String
resp.ipam_scopes[0].ipam_arn #=> String
resp.ipam_scopes[0].ipam_region #=> String
resp.ipam_scopes[0].ipam_scope_type #=> String, one of "public", "private"
resp.ipam_scopes[0].is_default #=> Boolean
resp.ipam_scopes[0].description #=> String
resp.ipam_scopes[0].pool_count #=> Integer
resp.ipam_scopes[0].state #=> String, one of "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"
resp.ipam_scopes[0].tags #=> Array
resp.ipam_scopes[0].tags[0].key #=> String
resp.ipam_scopes[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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<Types::Filter>) —

    One or more filters for the request. For more information about filtering, see [Filtering CLI output].

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html

  • :max_results (Integer) —

    The maximum number of results to return in the request.

  • :next_token (String) —

    The token for the next page of results.

  • :ipam_scope_ids (Array<String>) —

    The IDs of the scopes you want information on.

Returns:

See Also:



27171
27172
27173
27174
 
# File 'lib/aws-sdk-ec2/client.rb', line 27171

def describe_ipam_scopes(params = {}, options = {})
  req = build_request(:describe_ipam_scopes, params)
  req.send_request(options)
end

#describe_ipams(params = {}) ⇒ Types::DescribeIpamsResult

Get information about your IPAM pools.

For more information, see [What is IPAM?] in the *Amazon VPC IPAM User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_ipams({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  ipam_ids: ["String"],
})

Response structure


resp.next_token #=> String
resp.ipams #=> Array
resp.ipams[0].owner_id #=> String
resp.ipams[0].ipam_id #=> String
resp.ipams[0].ipam_arn #=> String
resp.ipams[0].ipam_region #=> String
resp.ipams[0].public_default_scope_id #=> String
resp.ipams[0].private_default_scope_id #=> String
resp.ipams[0].scope_count #=> Integer
resp.ipams[0].description #=> String
resp.ipams[0].operating_regions #=> Array
resp.ipams[0].operating_regions[0].region_name #=> String
resp.ipams[0].state #=> String, one of "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"
resp.ipams[0].tags #=> Array
resp.ipams[0].tags[0].key #=> String
resp.ipams[0].tags[0].value #=> String
resp.ipams[0].default_resource_discovery_id #=> String
resp.ipams[0].default_resource_discovery_association_id #=> String
resp.ipams[0].resource_discovery_association_count #=> Integer
resp.ipams[0].state_message #=> String
resp.ipams[0].tier #=> String, one of "free", "advanced"
resp.ipams[0].enable_private_gua #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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<Types::Filter>) —

    One or more filters for the request. For more information about filtering, see [Filtering CLI output].

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html

  • :max_results (Integer) —

    The maximum number of results to return in the request.

  • :next_token (String) —

    The token for the next page of results.

  • :ipam_ids (Array<String>) —

    The IDs of the IPAMs you want information on.

Returns:

See Also:



27259
27260
27261
27262
 
# File 'lib/aws-sdk-ec2/client.rb', line 27259

def describe_ipams(params = {}, options = {})
  req = build_request(:describe_ipams, params)
  req.send_request(options)
end

#describe_ipv_6_pools(params = {}) ⇒ Types::DescribeIpv6PoolsResult

Describes your IPv6 address pools.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_ipv_6_pools({
  pool_ids: ["Ipv6PoolEc2Id"],
  next_token: "NextToken",
  max_results: 1,
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.ipv_6_pools #=> Array
resp.ipv_6_pools[0].pool_id #=> String
resp.ipv_6_pools[0].description #=> String
resp.ipv_6_pools[0].pool_cidr_blocks #=> Array
resp.ipv_6_pools[0].pool_cidr_blocks[0].cidr #=> String
resp.ipv_6_pools[0].tags #=> Array
resp.ipv_6_pools[0].tags[0].key #=> String
resp.ipv_6_pools[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_ids (Array<String>) —

    The IDs of the IPv6 address pools.

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (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.

  • :dry_run (Boolean) —

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

    One or more filters.

    • ‘tag`:&lt;key&gt; - 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.

Returns:

See Also:



27334
27335
27336
27337
 
# File 'lib/aws-sdk-ec2/client.rb', line 27334

def describe_ipv_6_pools(params = {}, options = {})
  req = build_request(:describe_ipv_6_pools, params)
  req.send_request(options)
end

#describe_key_pairs(params = {}) ⇒ Types::DescribeKeyPairsResult

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html

The following waiters are defined for this operation (see #wait_until for detailed usage):

* key_pair_exists

Examples:

Example: To display a key pair


# This example displays the fingerprint for the specified key.

resp = client.describe_key_pairs({
  key_names: [
    "my-key-pair", 
  ], 
})

resp.to_h outputs the following:
{
  key_pairs: [
    {
      key_fingerprint: "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f", 
      key_name: "my-key-pair", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_key_pairs({
  key_names: ["KeyPairName"],
  key_pair_ids: ["KeyPairId"],
  include_public_key: false,
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.key_pairs #=> Array
resp.key_pairs[0].key_pair_id #=> String
resp.key_pairs[0].key_type #=> String, one of "rsa", "ed25519"
resp.key_pairs[0].tags #=> Array
resp.key_pairs[0].tags[0].key #=> String
resp.key_pairs[0].tags[0].value #=> String
resp.key_pairs[0].public_key #=> String
resp.key_pairs[0].create_time #=> Time
resp.key_pairs[0].key_name #=> String
resp.key_pairs[0].key_fingerprint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_names (Array<String>) —

    The key pair names.

    Default: Describes all of your key pairs.

  • :key_pair_ids (Array<String>) —

    The IDs of the key pairs.

  • :include_public_key (Boolean) —

    If ‘true`, the public key material is included in the response.

    Default: ‘false`

  • :dry_run (Boolean) —

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

    The filters.

    • ‘key-pair-id` - The ID of the key pair.

    • ‘fingerprint` - The fingerprint of the key pair.

    • ‘key-name` - The name of the key pair.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • ‘tag`:&lt;key&gt; - 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.

Returns:

See Also:



27448
27449
27450
27451
 
# File 'lib/aws-sdk-ec2/client.rb', line 27448

def describe_key_pairs(params = {}, options = {})
  req = build_request(:describe_key_pairs, params)
  req.send_request(options)
end

#describe_launch_template_versions(params = {}) ⇒ Types::DescribeLaunchTemplateVersionsResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe the versions for a launch template


# This example describes the versions for the specified launch template.

resp = client.describe_launch_template_versions({
  launch_template_id: "068f72b72934aff71", 
})

resp.to_h outputs the following:
{
  launch_template_versions: [
    {
      create_time: Time.parse("2017-11-20T13:12:32.000Z"), 
      created_by: "arn:aws:iam::123456789102:root", 
      default_version: false, 
      launch_template_data: {
        image_id: "ami-6057e21a", 
        instance_type: "t2.medium", 
        key_name: "kp-us-east", 
        network_interfaces: [
          {
            device_index: 0, 
            groups: [
              "sg-7c227019", 
            ], 
            subnet_id: "subnet-1a2b3c4d", 
          }, 
        ], 
      }, 
      launch_template_id: "lt-068f72b72934aff71", 
      launch_template_name: "Webservers", 
      version_number: 2, 
    }, 
    {
      create_time: Time.parse("2017-11-20T12:52:33.000Z"), 
      created_by: "arn:aws:iam::123456789102:root", 
      default_version: true, 
      launch_template_data: {
        image_id: "ami-aabbcc11", 
        instance_type: "t2.medium", 
        key_name: "kp-us-east", 
        network_interfaces: [
          {
            associate_public_ip_address: true, 
            delete_on_termination: false, 
            device_index: 0, 
            groups: [
              "sg-7c227019", 
            ], 
            subnet_id: "subnet-7b16de0c", 
          }, 
        ], 
        user_data: "", 
      }, 
      launch_template_id: "lt-068f72b72934aff71", 
      launch_template_name: "Webservers", 
      version_number: 1, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_launch_template_versions({
  dry_run: false,
  launch_template_id: "LaunchTemplateId",
  launch_template_name: "LaunchTemplateName",
  versions: ["String"],
  min_version: "String",
  max_version: "String",
  next_token: "String",
  max_results: 1,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  resolve_alias: false,
})

Response structure


resp.launch_template_versions #=> Array
resp.launch_template_versions[0].launch_template_id #=> String
resp.launch_template_versions[0].launch_template_name #=> String
resp.launch_template_versions[0].version_number #=> Integer
resp.launch_template_versions[0].version_description #=> String
resp.launch_template_versions[0].create_time #=> Time
resp.launch_template_versions[0].created_by #=> String
resp.launch_template_versions[0].default_version #=> Boolean
resp.launch_template_versions[0].launch_template_data.kernel_id #=> String
resp.launch_template_versions[0].launch_template_data.ebs_optimized #=> Boolean
resp.launch_template_versions[0].launch_template_data.iam_instance_profile.arn #=> String
resp.launch_template_versions[0].launch_template_data.iam_instance_profile.name #=> String
resp.launch_template_versions[0].launch_template_data.block_device_mappings #=> Array
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].device_name #=> String
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].virtual_name #=> String
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].ebs.encrypted #=> Boolean
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].ebs.iops #=> Integer
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].ebs.kms_key_id #=> String
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].ebs.snapshot_id #=> String
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].ebs.volume_size #=> Integer
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].ebs.throughput #=> Integer
resp.launch_template_versions[0].launch_template_data.block_device_mappings[0].no_device #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces #=> Array
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].associate_carrier_ip_address #=> Boolean
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].associate_public_ip_address #=> Boolean
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].delete_on_termination #=> Boolean
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].description #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].device_index #=> Integer
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].groups #=> Array
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].groups[0] #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].interface_type #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_6_address_count #=> Integer
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_6_addresses #=> Array
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_6_addresses[0].ipv_6_address #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].network_interface_id #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].private_ip_address #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].private_ip_addresses #=> Array
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].private_ip_addresses[0].primary #=> Boolean
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].secondary_private_ip_address_count #=> Integer
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].subnet_id #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].network_card_index #=> Integer
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_4_prefixes #=> Array
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_4_prefix_count #=> Integer
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_6_prefixes #=> Array
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ipv_6_prefix_count #=> Integer
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].primary_ipv_6 #=> Boolean
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ena_srd_specification.ena_srd_enabled #=> Boolean
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].connection_tracking_specification.tcp_established_timeout #=> Integer
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].connection_tracking_specification.udp_timeout #=> Integer
resp.launch_template_versions[0].launch_template_data.network_interfaces[0].connection_tracking_specification.udp_stream_timeout #=> Integer
resp.launch_template_versions[0].launch_template_data.image_id #=> String
resp.launch_template_versions[0].launch_template_data.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.launch_template_versions[0].launch_template_data.key_name #=> String
resp.launch_template_versions[0].launch_template_data.monitoring.enabled #=> Boolean
resp.launch_template_versions[0].launch_template_data.placement.availability_zone #=> String
resp.launch_template_versions[0].launch_template_data.placement.affinity #=> String
resp.launch_template_versions[0].launch_template_data.placement.group_name #=> String
resp.launch_template_versions[0].launch_template_data.placement.host_id #=> String
resp.launch_template_versions[0].launch_template_data.placement.tenancy #=> String, one of "default", "dedicated", "host"
resp.launch_template_versions[0].launch_template_data.placement.spread_domain #=> String
resp.launch_template_versions[0].launch_template_data.placement.host_resource_group_arn #=> String
resp.launch_template_versions[0].launch_template_data.placement.partition_number #=> Integer
resp.launch_template_versions[0].launch_template_data.placement.group_id #=> String
resp.launch_template_versions[0].launch_template_data.ram_disk_id #=> String
resp.launch_template_versions[0].launch_template_data.disable_api_termination #=> Boolean
resp.launch_template_versions[0].launch_template_data.instance_initiated_shutdown_behavior #=> String, one of "stop", "terminate"
resp.launch_template_versions[0].launch_template_data.user_data #=> String
resp.launch_template_versions[0].launch_template_data.tag_specifications #=> Array
resp.launch_template_versions[0].launch_template_data.tag_specifications[0].resource_type #=> String, one of "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"
resp.launch_template_versions[0].launch_template_data.tag_specifications[0].tags #=> Array
resp.launch_template_versions[0].launch_template_data.tag_specifications[0].tags[0].key #=> String
resp.launch_template_versions[0].launch_template_data.tag_specifications[0].tags[0].value #=> String
resp.launch_template_versions[0].launch_template_data.elastic_gpu_specifications #=> Array
resp.launch_template_versions[0].launch_template_data.elastic_gpu_specifications[0].type #=> String
resp.launch_template_versions[0].launch_template_data.elastic_inference_accelerators #=> Array
resp.launch_template_versions[0].launch_template_data.elastic_inference_accelerators[0].type #=> String
resp.launch_template_versions[0].launch_template_data.elastic_inference_accelerators[0].count #=> Integer
resp.launch_template_versions[0].launch_template_data.security_group_ids #=> Array
resp.launch_template_versions[0].launch_template_data.security_group_ids[0] #=> String
resp.launch_template_versions[0].launch_template_data.security_groups #=> Array
resp.launch_template_versions[0].launch_template_data.security_groups[0] #=> String
resp.launch_template_versions[0].launch_template_data.instance_market_options.market_type #=> String, one of "spot", "capacity-block"
resp.launch_template_versions[0].launch_template_data.instance_market_options.spot_options.max_price #=> String
resp.launch_template_versions[0].launch_template_data.instance_market_options.spot_options.spot_instance_type #=> String, one of "one-time", "persistent"
resp.launch_template_versions[0].launch_template_data.instance_market_options.spot_options.block_duration_minutes #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_market_options.spot_options.valid_until #=> Time
resp.launch_template_versions[0].launch_template_data.instance_market_options.spot_options.instance_interruption_behavior #=> String, one of "hibernate", "stop", "terminate"
resp.launch_template_versions[0].launch_template_data.credit_specification.cpu_credits #=> String
resp.launch_template_versions[0].launch_template_data.cpu_options.core_count #=> Integer
resp.launch_template_versions[0].launch_template_data.cpu_options.threads_per_core #=> Integer
resp.launch_template_versions[0].launch_template_data.cpu_options.amd_sev_snp #=> String, one of "enabled", "disabled"
resp.launch_template_versions[0].launch_template_data.capacity_reservation_specification.capacity_reservation_preference #=> String, one of "open", "none"
resp.launch_template_versions[0].launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_id #=> String
resp.launch_template_versions[0].launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_resource_group_arn #=> String
resp.launch_template_versions[0].launch_template_data.license_specifications #=> Array
resp.launch_template_versions[0].launch_template_data.license_specifications[0].license_configuration_arn #=> String
resp.launch_template_versions[0].launch_template_data.hibernation_options.configured #=> Boolean
resp.launch_template_versions[0].launch_template_data.metadata_options.state #=> String, one of "pending", "applied"
resp.launch_template_versions[0].launch_template_data.metadata_options.http_tokens #=> String, one of "optional", "required"
resp.launch_template_versions[0].launch_template_data.metadata_options.http_put_response_hop_limit #=> Integer
resp.launch_template_versions[0].launch_template_data.metadata_options.http_endpoint #=> String, one of "disabled", "enabled"
resp.launch_template_versions[0].launch_template_data.metadata_options.http_protocol_ipv_6 #=> String, one of "disabled", "enabled"
resp.launch_template_versions[0].launch_template_data.metadata_options.instance_metadata_tags #=> String, one of "disabled", "enabled"
resp.launch_template_versions[0].launch_template_data.enclave_options.enabled #=> Boolean
resp.launch_template_versions[0].launch_template_data.instance_requirements.v_cpu_count.min #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.v_cpu_count.max #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.memory_mi_b.min #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.memory_mi_b.max #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.cpu_manufacturers #=> Array
resp.launch_template_versions[0].launch_template_data.instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.launch_template_versions[0].launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.launch_template_versions[0].launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.launch_template_versions[0].launch_template_data.instance_requirements.excluded_instance_types #=> Array
resp.launch_template_versions[0].launch_template_data.instance_requirements.excluded_instance_types[0] #=> String
resp.launch_template_versions[0].launch_template_data.instance_requirements.instance_generations #=> Array
resp.launch_template_versions[0].launch_template_data.instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.launch_template_versions[0].launch_template_data.instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.launch_template_versions[0].launch_template_data.instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.launch_template_versions[0].launch_template_data.instance_requirements.require_hibernate_support #=> Boolean
resp.launch_template_versions[0].launch_template_data.instance_requirements.network_interface_count.min #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.network_interface_count.max #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.launch_template_versions[0].launch_template_data.instance_requirements.local_storage_types #=> Array
resp.launch_template_versions[0].launch_template_data.instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.launch_template_versions[0].launch_template_data.instance_requirements.total_local_storage_gb.min #=> Float
resp.launch_template_versions[0].launch_template_data.instance_requirements.total_local_storage_gb.max #=> Float
resp.launch_template_versions[0].launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_types #=> Array
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_count.min #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_count.max #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_manufacturers #=> Array
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_names #=> Array
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.launch_template_versions[0].launch_template_data.instance_requirements.network_bandwidth_gbps.min #=> Float
resp.launch_template_versions[0].launch_template_data.instance_requirements.network_bandwidth_gbps.max #=> Float
resp.launch_template_versions[0].launch_template_data.instance_requirements.allowed_instance_types #=> Array
resp.launch_template_versions[0].launch_template_data.instance_requirements.allowed_instance_types[0] #=> String
resp.launch_template_versions[0].launch_template_data.instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.launch_template_versions[0].launch_template_data.private_dns_name_options.hostname_type #=> String, one of "ip-name", "resource-name"
resp.launch_template_versions[0].launch_template_data.private_dns_name_options.enable_resource_name_dns_a_record #=> Boolean
resp.launch_template_versions[0].launch_template_data.private_dns_name_options.enable_resource_name_dns_aaaa_record #=> Boolean
resp.launch_template_versions[0].launch_template_data.maintenance_options.auto_recovery #=> String, one of "default", "disabled"
resp.launch_template_versions[0].launch_template_data.disable_api_stop #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :launch_template_id (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.

  • :launch_template_name (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.

  • :min_version (String) —

    The version number after which to describe launch template versions.

  • :max_version (String) —

    The version number up to which to describe launch template versions.

  • :next_token (String) —

    The token to request the next page of results.

  • :max_results (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<Types::Filter>) —

    One or more filters.

    • ‘create-time` - The time the launch template version was created.

    • ‘ebs-optimized` - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.

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

  • :resolve_alias (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`

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id

Returns:

See Also:



27819
27820
27821
27822
 
# File 'lib/aws-sdk-ec2/client.rb', line 27819

def describe_launch_template_versions(params = {}, options = {})
  req = build_request(:describe_launch_template_versions, params)
  req.send_request(options)
end

#describe_launch_templates(params = {}) ⇒ Types::DescribeLaunchTemplatesResult

Describes one or more launch templates.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe a launch template


# This example describes the specified launch template.

resp = client.describe_launch_templates({
  launch_template_ids: [
    "lt-01238c059e3466abc", 
  ], 
})

resp.to_h outputs the following:
{
  launch_templates: [
    {
      create_time: Time.parse("2018-01-16T04:32:57.000Z"), 
      created_by: "arn:aws:iam::123456789012:root", 
      default_version_number: 1, 
      latest_version_number: 1, 
      launch_template_id: "lt-01238c059e3466abc", 
      launch_template_name: "my-template", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_launch_templates({
  dry_run: false,
  launch_template_ids: ["LaunchTemplateId"],
  launch_template_names: ["LaunchTemplateName"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.launch_templates #=> Array
resp.launch_templates[0].launch_template_id #=> String
resp.launch_templates[0].launch_template_name #=> String
resp.launch_templates[0].create_time #=> Time
resp.launch_templates[0].created_by #=> String
resp.launch_templates[0].default_version_number #=> Integer
resp.launch_templates[0].latest_version_number #=> Integer
resp.launch_templates[0].tags #=> Array
resp.launch_templates[0].tags[0].key #=> String
resp.launch_templates[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :launch_template_ids (Array<String>) —

    One or more launch template IDs.

  • :launch_template_names (Array<String>) —

    One or more launch template names.

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘create-time` - The time the launch template was created.

    • ‘launch-template-name` - The name of the launch template.

    • ‘tag`:&lt;key&gt; - 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.

  • :next_token (String) —

    The token to request the next page of results.

  • :max_results (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.

Returns:

See Also:



27929
27930
27931
27932
 
# File 'lib/aws-sdk-ec2/client.rb', line 27929

def describe_launch_templates(params = {}, options = {})
  req = build_request(:describe_launch_templates, params)
  req.send_request(options)
end

#describe_local_gateway_route_table_virtual_interface_group_associations(params = {}) ⇒ Types::DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult

Describes the associations between virtual interface groups and local gateway route tables.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_local_gateway_route_table_virtual_interface_group_associations({
  local_gateway_route_table_virtual_interface_group_association_ids: ["LocalGatewayRouteTableVirtualInterfaceGroupAssociationId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.local_gateway_route_table_virtual_interface_group_associations #=> Array
resp.local_gateway_route_table_virtual_interface_group_associations[0].local_gateway_route_table_virtual_interface_group_association_id #=> String
resp.local_gateway_route_table_virtual_interface_group_associations[0].local_gateway_virtual_interface_group_id #=> String
resp.local_gateway_route_table_virtual_interface_group_associations[0].local_gateway_id #=> String
resp.local_gateway_route_table_virtual_interface_group_associations[0].local_gateway_route_table_id #=> String
resp.local_gateway_route_table_virtual_interface_group_associations[0].local_gateway_route_table_arn #=> String
resp.local_gateway_route_table_virtual_interface_group_associations[0].owner_id #=> String
resp.local_gateway_route_table_virtual_interface_group_associations[0].state #=> String
resp.local_gateway_route_table_virtual_interface_group_associations[0].tags #=> Array
resp.local_gateway_route_table_virtual_interface_group_associations[0].tags[0].key #=> String
resp.local_gateway_route_table_virtual_interface_group_associations[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_virtual_interface_group_association_ids (Array<String>) —

    The IDs of the associations.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



28017
28018
28019
28020
 
# File 'lib/aws-sdk-ec2/client.rb', line 28017

def describe_local_gateway_route_table_virtual_interface_group_associations(params = {}, options = {})
  req = build_request(:describe_local_gateway_route_table_virtual_interface_group_associations, params)
  req.send_request(options)
end

#describe_local_gateway_route_table_vpc_associations(params = {}) ⇒ Types::DescribeLocalGatewayRouteTableVpcAssociationsResult

Describes the specified associations between VPCs and local gateway route tables.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_local_gateway_route_table_vpc_associations({
  local_gateway_route_table_vpc_association_ids: ["LocalGatewayRouteTableVpcAssociationId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.local_gateway_route_table_vpc_associations #=> Array
resp.local_gateway_route_table_vpc_associations[0].local_gateway_route_table_vpc_association_id #=> String
resp.local_gateway_route_table_vpc_associations[0].local_gateway_route_table_id #=> String
resp.local_gateway_route_table_vpc_associations[0].local_gateway_route_table_arn #=> String
resp.local_gateway_route_table_vpc_associations[0].local_gateway_id #=> String
resp.local_gateway_route_table_vpc_associations[0].vpc_id #=> String
resp.local_gateway_route_table_vpc_associations[0].owner_id #=> String
resp.local_gateway_route_table_vpc_associations[0].state #=> String
resp.local_gateway_route_table_vpc_associations[0].tags #=> Array
resp.local_gateway_route_table_vpc_associations[0].tags[0].key #=> String
resp.local_gateway_route_table_vpc_associations[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_vpc_association_ids (Array<String>) —

    The IDs of the associations.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



28104
28105
28106
28107
 
# File 'lib/aws-sdk-ec2/client.rb', line 28104

def describe_local_gateway_route_table_vpc_associations(params = {}, options = {})
  req = build_request(:describe_local_gateway_route_table_vpc_associations, params)
  req.send_request(options)
end

#describe_local_gateway_route_tables(params = {}) ⇒ Types::DescribeLocalGatewayRouteTablesResult

Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_local_gateway_route_tables({
  local_gateway_route_table_ids: ["LocalGatewayRoutetableId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.local_gateway_route_tables #=> Array
resp.local_gateway_route_tables[0].local_gateway_route_table_id #=> String
resp.local_gateway_route_tables[0].local_gateway_route_table_arn #=> String
resp.local_gateway_route_tables[0].local_gateway_id #=> String
resp.local_gateway_route_tables[0].outpost_arn #=> String
resp.local_gateway_route_tables[0].owner_id #=> String
resp.local_gateway_route_tables[0].state #=> String
resp.local_gateway_route_tables[0].tags #=> Array
resp.local_gateway_route_tables[0].tags[0].key #=> String
resp.local_gateway_route_tables[0].tags[0].value #=> String
resp.local_gateway_route_tables[0].mode #=> String, one of "direct-vpc-routing", "coip"
resp.local_gateway_route_tables[0].state_reason.code #=> String
resp.local_gateway_route_tables[0].state_reason.message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_ids (Array<String>) —

    The IDs of the local gateway route tables.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



28191
28192
28193
28194
 
# File 'lib/aws-sdk-ec2/client.rb', line 28191

def describe_local_gateway_route_tables(params = {}, options = {})
  req = build_request(:describe_local_gateway_route_tables, params)
  req.send_request(options)
end

#describe_local_gateway_virtual_interface_groups(params = {}) ⇒ Types::DescribeLocalGatewayVirtualInterfaceGroupsResult

Describes the specified local gateway virtual interface groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_local_gateway_virtual_interface_groups({
  local_gateway_virtual_interface_group_ids: ["LocalGatewayVirtualInterfaceGroupId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.local_gateway_virtual_interface_groups #=> Array
resp.local_gateway_virtual_interface_groups[0].local_gateway_virtual_interface_group_id #=> String
resp.local_gateway_virtual_interface_groups[0].local_gateway_virtual_interface_ids #=> Array
resp.local_gateway_virtual_interface_groups[0].local_gateway_virtual_interface_ids[0] #=> String
resp.local_gateway_virtual_interface_groups[0].local_gateway_id #=> String
resp.local_gateway_virtual_interface_groups[0].owner_id #=> String
resp.local_gateway_virtual_interface_groups[0].tags #=> Array
resp.local_gateway_virtual_interface_groups[0].tags[0].key #=> String
resp.local_gateway_virtual_interface_groups[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_virtual_interface_group_ids (Array<String>) —

    The IDs of the virtual interface groups.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



28268
28269
28270
28271
 
# File 'lib/aws-sdk-ec2/client.rb', line 28268

def describe_local_gateway_virtual_interface_groups(params = {}, options = {})
  req = build_request(:describe_local_gateway_virtual_interface_groups, params)
  req.send_request(options)
end

#describe_local_gateway_virtual_interfaces(params = {}) ⇒ Types::DescribeLocalGatewayVirtualInterfacesResult

Describes the specified local gateway virtual interfaces.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_local_gateway_virtual_interfaces({
  local_gateway_virtual_interface_ids: ["LocalGatewayVirtualInterfaceId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.local_gateway_virtual_interfaces #=> Array
resp.local_gateway_virtual_interfaces[0].local_gateway_virtual_interface_id #=> String
resp.local_gateway_virtual_interfaces[0].local_gateway_id #=> String
resp.local_gateway_virtual_interfaces[0].vlan #=> Integer
resp.local_gateway_virtual_interfaces[0].local_address #=> String
resp.local_gateway_virtual_interfaces[0].peer_address #=> String
resp.local_gateway_virtual_interfaces[0].local_bgp_asn #=> Integer
resp.local_gateway_virtual_interfaces[0].peer_bgp_asn #=> Integer
resp.local_gateway_virtual_interfaces[0].owner_id #=> String
resp.local_gateway_virtual_interfaces[0].tags #=> Array
resp.local_gateway_virtual_interfaces[0].tags[0].key #=> String
resp.local_gateway_virtual_interfaces[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_virtual_interface_ids (Array<String>) —

    The IDs of the virtual interfaces.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



28356
28357
28358
28359
 
# File 'lib/aws-sdk-ec2/client.rb', line 28356

def describe_local_gateway_virtual_interfaces(params = {}, options = {})
  req = build_request(:describe_local_gateway_virtual_interfaces, params)
  req.send_request(options)
end

#describe_local_gateways(params = {}) ⇒ Types::DescribeLocalGatewaysResult

Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_local_gateways({
  local_gateway_ids: ["LocalGatewayId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.local_gateways #=> Array
resp.local_gateways[0].local_gateway_id #=> String
resp.local_gateways[0].outpost_arn #=> String
resp.local_gateways[0].owner_id #=> String
resp.local_gateways[0].state #=> String
resp.local_gateways[0].tags #=> Array
resp.local_gateways[0].tags[0].key #=> String
resp.local_gateways[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_ids (Array<String>) —

    The IDs of the local gateways.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



28431
28432
28433
28434
 
# File 'lib/aws-sdk-ec2/client.rb', line 28431

def describe_local_gateways(params = {}, options = {})
  req = build_request(:describe_local_gateways, params)
  req.send_request(options)
end

#describe_locked_snapshots(params = {}) ⇒ Types::DescribeLockedSnapshotsResult

Describes the lock status for a snapshot.

Examples:

Request syntax with placeholder values


resp = client.describe_locked_snapshots({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  snapshot_ids: ["SnapshotId"],
  dry_run: false,
})

Response structure


resp.snapshots #=> Array
resp.snapshots[0].owner_id #=> String
resp.snapshots[0].snapshot_id #=> String
resp.snapshots[0].lock_state #=> String, one of "compliance", "governance", "compliance-cooloff", "expired"
resp.snapshots[0].lock_duration #=> Integer
resp.snapshots[0].cool_off_period #=> Integer
resp.snapshots[0].cool_off_period_expires_on #=> Time
resp.snapshots[0].lock_created_on #=> Time
resp.snapshots[0].lock_duration_start_time #=> Time
resp.snapshots[0].lock_expires_on #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘lock-state` - The state of the snapshot lock (`compliance-cooloff` | `governance` | `compliance` | `expired`).

    ^

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :snapshot_ids (Array<String>) —

    The IDs of the snapshots for which to view the lock status.

  • :dry_run (Boolean) —

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

Returns:

See Also:



28506
28507
28508
28509
 
# File 'lib/aws-sdk-ec2/client.rb', line 28506

def describe_locked_snapshots(params = {}, options = {})
  req = build_request(:describe_locked_snapshots, params)
  req.send_request(options)
end

#describe_mac_hosts(params = {}) ⇒ Types::DescribeMacHostsResult

Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_mac_hosts({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  host_ids: ["DedicatedHostId"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.mac_hosts #=> Array
resp.mac_hosts[0].host_id #=> String
resp.mac_hosts[0].mac_os_latest_supported_versions #=> Array
resp.mac_hosts[0].mac_os_latest_supported_versions[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    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.

  • :host_ids (Array<String>) —

    The IDs of the EC2 Mac Dedicated Hosts.

  • :max_results (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

    1. If ‘maxResults` is given a larger value than 500, you receive an

    error.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

Returns:

See Also:



28569
28570
28571
28572
 
# File 'lib/aws-sdk-ec2/client.rb', line 28569

def describe_mac_hosts(params = {}, options = {})
  req = build_request(:describe_mac_hosts, params)
  req.send_request(options)
end

#describe_managed_prefix_lists(params = {}) ⇒ Types::DescribeManagedPrefixListsResult

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

To view the entries for your prefix list, use GetManagedPrefixListEntries.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_managed_prefix_lists({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  prefix_list_ids: ["String"],
})

Response structure


resp.next_token #=> String
resp.prefix_lists #=> Array
resp.prefix_lists[0].prefix_list_id #=> String
resp.prefix_lists[0].address_family #=> String
resp.prefix_lists[0].state #=> String, one of "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"
resp.prefix_lists[0].state_message #=> String
resp.prefix_lists[0].prefix_list_arn #=> String
resp.prefix_lists[0].prefix_list_name #=> String
resp.prefix_lists[0].max_entries #=> Integer
resp.prefix_lists[0].version #=> Integer
resp.prefix_lists[0].tags #=> Array
resp.prefix_lists[0].tags[0].key #=> String
resp.prefix_lists[0].tags[0].value #=> String
resp.prefix_lists[0].owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    One or more filters.

    • ‘owner-id` - The ID of the prefix list owner.

    • ‘prefix-list-id` - The ID of the prefix list.

    • ‘prefix-list-name` - The name of the prefix list.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :prefix_list_ids (Array<String>) —

    One or more prefix list IDs.

Returns:

See Also:



28649
28650
28651
28652
 
# File 'lib/aws-sdk-ec2/client.rb', line 28649

def describe_managed_prefix_lists(params = {}, options = {})
  req = build_request(:describe_managed_prefix_lists, params)
  req.send_request(options)
end

#describe_moving_addresses(params = {}) ⇒ Types::DescribeMovingAddressesResult

<note markdown=“1”> This action is deprecated.

</note>

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe your moving addresses


# This example describes all of your moving Elastic IP addresses.

resp = client.describe_moving_addresses({
})

resp.to_h outputs the following:
{
  moving_address_statuses: [
    {
      move_status: "movingToVpc", 
      public_ip: "198.51.100.0", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_moving_addresses({
  dry_run: false,
  public_ips: ["String"],
  next_token: "String",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
})

Response structure


resp.moving_address_statuses #=> Array
resp.moving_address_statuses[0].move_status #=> String, one of "movingToVpc", "restoringToClassic"
resp.moving_address_statuses[0].public_ip #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :public_ips (Array<String>) —

    One or more Elastic IP addresses.

  • :next_token (String) —

    The token for the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘moving-status` - The status of the Elastic IP address (`MovingToVpc` | `RestoringToClassic`).

    ^

  • :max_results (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.

Returns:

See Also:



28742
28743
28744
28745
 
# File 'lib/aws-sdk-ec2/client.rb', line 28742

def describe_moving_addresses(params = {}, options = {})
  req = build_request(:describe_moving_addresses, params)
  req.send_request(options)
end

#describe_nat_gateways(params = {}) ⇒ Types::DescribeNatGatewaysResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* nat_gateway_available
* nat_gateway_deleted

Examples:

Example: To describe a NAT gateway


# This example describes the NAT gateway for the specified VPC.

resp = client.describe_nat_gateways({
  filter: [
    {
      name: "vpc-id", 
      values: [
        "vpc-1a2b3c4d", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  nat_gateways: [
    {
      create_time: Time.parse("2015-12-01T12:26:55.983Z"), 
      nat_gateway_addresses: [
        {
          allocation_id: "eipalloc-89c620ec", 
          network_interface_id: "eni-9dec76cd", 
          private_ip: "10.0.0.149", 
          public_ip: "198.11.222.333", 
        }, 
      ], 
      nat_gateway_id: "nat-05dba92075d71c408", 
      state: "available", 
      subnet_id: "subnet-847e4dc2", 
      vpc_id: "vpc-1a2b3c4d", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_nat_gateways({
  dry_run: false,
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  nat_gateway_ids: ["NatGatewayId"],
  next_token: "String",
})

Response structure


resp.nat_gateways #=> Array
resp.nat_gateways[0].create_time #=> Time
resp.nat_gateways[0].delete_time #=> Time
resp.nat_gateways[0].failure_code #=> String
resp.nat_gateways[0].failure_message #=> String
resp.nat_gateways[0].nat_gateway_addresses #=> Array
resp.nat_gateways[0].nat_gateway_addresses[0].allocation_id #=> String
resp.nat_gateways[0].nat_gateway_addresses[0].network_interface_id #=> String
resp.nat_gateways[0].nat_gateway_addresses[0].private_ip #=> String
resp.nat_gateways[0].nat_gateway_addresses[0].public_ip #=> String
resp.nat_gateways[0].nat_gateway_addresses[0].association_id #=> String
resp.nat_gateways[0].nat_gateway_addresses[0].is_primary #=> Boolean
resp.nat_gateways[0].nat_gateway_addresses[0].failure_message #=> String
resp.nat_gateways[0].nat_gateway_addresses[0].status #=> String, one of "assigning", "unassigning", "associating", "disassociating", "succeeded", "failed"
resp.nat_gateways[0].nat_gateway_id #=> String
resp.nat_gateways[0].provisioned_bandwidth.provision_time #=> Time
resp.nat_gateways[0].provisioned_bandwidth.provisioned #=> String
resp.nat_gateways[0].provisioned_bandwidth.request_time #=> Time
resp.nat_gateways[0].provisioned_bandwidth.requested #=> String
resp.nat_gateways[0].provisioned_bandwidth.status #=> String
resp.nat_gateways[0].state #=> String, one of "pending", "failed", "available", "deleting", "deleted"
resp.nat_gateways[0].subnet_id #=> String
resp.nat_gateways[0].vpc_id #=> String
resp.nat_gateways[0].tags #=> Array
resp.nat_gateways[0].tags[0].key #=> String
resp.nat_gateways[0].tags[0].value #=> String
resp.nat_gateways[0].connectivity_type #=> String, one of "private", "public"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    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`:&lt;key&gt; - 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.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :nat_gateway_ids (Array<String>) —

    The IDs of the NAT gateways.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



28896
28897
28898
28899
 
# File 'lib/aws-sdk-ec2/client.rb', line 28896

def describe_nat_gateways(params = {}, options = {})
  req = build_request(:describe_nat_gateways, params)
  req.send_request(options)
end

#describe_network_acls(params = {}) ⇒ Types::DescribeNetworkAclsResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe a network ACL


# This example describes the specified network ACL.

resp = client.describe_network_acls({
  network_acl_ids: [
    "acl-5fb85d36", 
  ], 
})

resp.to_h outputs the following:
{
  network_acls: [
    {
      associations: [
        {
          network_acl_association_id: "aclassoc-66ea5f0b", 
          network_acl_id: "acl-9aeb5ef7", 
          subnet_id: "subnet-65ea5f08", 
        }, 
      ], 
      entries: [
        {
          cidr_block: "0.0.0.0/0", 
          egress: true, 
          protocol: "-1", 
          rule_action: "deny", 
          rule_number: 32767, 
        }, 
        {
          cidr_block: "0.0.0.0/0", 
          egress: false, 
          protocol: "-1", 
          rule_action: "deny", 
          rule_number: 32767, 
        }, 
      ], 
      is_default: false, 
      network_acl_id: "acl-5fb85d36", 
      tags: [
      ], 
      vpc_id: "vpc-a01106c2", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_network_acls({
  next_token: "String",
  max_results: 1,
  dry_run: false,
  network_acl_ids: ["NetworkAclId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.network_acls #=> Array
resp.network_acls[0].associations #=> Array
resp.network_acls[0].associations[0].network_acl_association_id #=> String
resp.network_acls[0].associations[0].network_acl_id #=> String
resp.network_acls[0].associations[0].subnet_id #=> String
resp.network_acls[0].entries #=> Array
resp.network_acls[0].entries[0].cidr_block #=> String
resp.network_acls[0].entries[0].egress #=> Boolean
resp.network_acls[0].entries[0].icmp_type_code.code #=> Integer
resp.network_acls[0].entries[0].icmp_type_code.type #=> Integer
resp.network_acls[0].entries[0].ipv_6_cidr_block #=> String
resp.network_acls[0].entries[0].port_range.from #=> Integer
resp.network_acls[0].entries[0].port_range.to #=> Integer
resp.network_acls[0].entries[0].protocol #=> String
resp.network_acls[0].entries[0].rule_action #=> String, one of "allow", "deny"
resp.network_acls[0].entries[0].rule_number #=> Integer
resp.network_acls[0].is_default #=> Boolean
resp.network_acls[0].network_acl_id #=> String
resp.network_acls[0].tags #=> Array
resp.network_acls[0].tags[0].key #=> String
resp.network_acls[0].tags[0].value #=> String
resp.network_acls[0].vpc_id #=> String
resp.network_acls[0].owner_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

  • :network_acl_ids (Array<String>) —

    The IDs of the network ACLs.

  • :filters (Array<Types::Filter>) —

    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`:&lt;key&gt; - 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.

Returns:

See Also:



29093
29094
29095
29096
 
# File 'lib/aws-sdk-ec2/client.rb', line 29093

def describe_network_acls(params = {}, options = {})
  req = build_request(:describe_network_acls, params)
  req.send_request(options)
end

#describe_network_insights_access_scope_analyses(params = {}) ⇒ Types::DescribeNetworkInsightsAccessScopeAnalysesResult

Describes the specified Network Access Scope analyses.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_network_insights_access_scope_analyses({
  network_insights_access_scope_analysis_ids: ["NetworkInsightsAccessScopeAnalysisId"],
  network_insights_access_scope_id: "NetworkInsightsAccessScopeId",
  analysis_start_time_begin: Time.now,
  analysis_start_time_end: Time.now,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  dry_run: false,
  next_token: "NextToken",
})

Response structure


resp.network_insights_access_scope_analyses #=> Array
resp.network_insights_access_scope_analyses[0].network_insights_access_scope_analysis_id #=> String
resp.network_insights_access_scope_analyses[0].network_insights_access_scope_analysis_arn #=> String
resp.network_insights_access_scope_analyses[0].network_insights_access_scope_id #=> String
resp.network_insights_access_scope_analyses[0].status #=> String, one of "running", "succeeded", "failed"
resp.network_insights_access_scope_analyses[0].status_message #=> String
resp.network_insights_access_scope_analyses[0].warning_message #=> String
resp.network_insights_access_scope_analyses[0].start_date #=> Time
resp.network_insights_access_scope_analyses[0].end_date #=> Time
resp.network_insights_access_scope_analyses[0].findings_found #=> String, one of "true", "false", "unknown"
resp.network_insights_access_scope_analyses[0].analyzed_eni_count #=> Integer
resp.network_insights_access_scope_analyses[0].tags #=> Array
resp.network_insights_access_scope_analyses[0].tags[0].key #=> String
resp.network_insights_access_scope_analyses[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_insights_access_scope_analysis_ids (Array<String>) —

    The IDs of the Network Access Scope analyses.

  • :network_insights_access_scope_id (String) —

    The ID of the Network Access Scope.

  • :analysis_start_time_begin (Time, DateTime, Date, Integer, String) —

    Filters the results based on the start time. The analysis must have started on or after this time.

  • :analysis_start_time_end (Time, DateTime, Date, Integer, String) —

    Filters the results based on the start time. The analysis must have started on or before this time.

  • :filters (Array<Types::Filter>) —

    There are no supported filters.

  • :max_results (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.

  • :dry_run (Boolean) —

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

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



29178
29179
29180
29181
 
# File 'lib/aws-sdk-ec2/client.rb', line 29178

def describe_network_insights_access_scope_analyses(params = {}, options = {})
  req = build_request(:describe_network_insights_access_scope_analyses, params)
  req.send_request(options)
end

#describe_network_insights_access_scopes(params = {}) ⇒ Types::DescribeNetworkInsightsAccessScopesResult

Describes the specified Network Access Scopes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_network_insights_access_scopes({
  network_insights_access_scope_ids: ["NetworkInsightsAccessScopeId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  dry_run: false,
  next_token: "NextToken",
})

Response structure


resp.network_insights_access_scopes #=> Array
resp.network_insights_access_scopes[0].network_insights_access_scope_id #=> String
resp.network_insights_access_scopes[0].network_insights_access_scope_arn #=> String
resp.network_insights_access_scopes[0].created_date #=> Time
resp.network_insights_access_scopes[0].updated_date #=> Time
resp.network_insights_access_scopes[0].tags #=> Array
resp.network_insights_access_scopes[0].tags[0].key #=> String
resp.network_insights_access_scopes[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_insights_access_scope_ids (Array<String>) —

    The IDs of the Network Access Scopes.

  • :filters (Array<Types::Filter>) —

    There are no supported filters.

  • :max_results (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.

  • :dry_run (Boolean) —

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

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



29243
29244
29245
29246
 
# File 'lib/aws-sdk-ec2/client.rb', line 29243

def describe_network_insights_access_scopes(params = {}, options = {})
  req = build_request(:describe_network_insights_access_scopes, params)
  req.send_request(options)
end

#describe_network_insights_analyses(params = {}) ⇒ Types::DescribeNetworkInsightsAnalysesResult

Describes one or more of your network insights analyses.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_network_insights_analyses({
  network_insights_analysis_ids: ["NetworkInsightsAnalysisId"],
  network_insights_path_id: "NetworkInsightsPathId",
  analysis_start_time: Time.now,
  analysis_end_time: Time.now,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  dry_run: false,
  next_token: "NextToken",
})

Response structure


resp.network_insights_analyses #=> Array
resp.network_insights_analyses[0].network_insights_analysis_id #=> String
resp.network_insights_analyses[0].network_insights_analysis_arn #=> String
resp.network_insights_analyses[0].network_insights_path_id #=> String
resp.network_insights_analyses[0].additional_accounts #=> Array
resp.network_insights_analyses[0].additional_accounts[0] #=> String
resp.network_insights_analyses[0].filter_in_arns #=> Array
resp.network_insights_analyses[0].filter_in_arns[0] #=> String
resp.network_insights_analyses[0].start_date #=> Time
resp.network_insights_analyses[0].status #=> String, one of "running", "succeeded", "failed"
resp.network_insights_analyses[0].status_message #=> String
resp.network_insights_analyses[0].warning_message #=> String
resp.network_insights_analyses[0].network_path_found #=> Boolean
resp.network_insights_analyses[0].forward_path_components #=> Array
resp.network_insights_analyses[0].forward_path_components[0].sequence_number #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].acl_rule.cidr #=> String
resp.network_insights_analyses[0].forward_path_components[0].acl_rule.egress #=> Boolean
resp.network_insights_analyses[0].forward_path_components[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].acl_rule.protocol #=> String
resp.network_insights_analyses[0].forward_path_components[0].acl_rule.rule_action #=> String
resp.network_insights_analyses[0].forward_path_components[0].acl_rule.rule_number #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].attached_to.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].attached_to.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].attached_to.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].component.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].component.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].component.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].destination_vpc.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].destination_vpc.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].destination_vpc.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.destination_addresses #=> Array
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.destination_addresses[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.destination_port_ranges #=> Array
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.destination_port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.destination_port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.protocol #=> String
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.source_addresses #=> Array
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.source_addresses[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.source_port_ranges #=> Array
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.source_port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].outbound_header.source_port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.destination_addresses #=> Array
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.destination_addresses[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.destination_port_ranges #=> Array
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.destination_port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.destination_port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.protocol #=> String
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.source_addresses #=> Array
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.source_addresses[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.source_port_ranges #=> Array
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.source_port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].inbound_header.source_port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.instance_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.network_interface_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.origin #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.state #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.core_network_arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].security_group_rule.cidr #=> String
resp.network_insights_analyses[0].forward_path_components[0].security_group_rule.direction #=> String
resp.network_insights_analyses[0].forward_path_components[0].security_group_rule.security_group_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].security_group_rule.protocol #=> String
resp.network_insights_analyses[0].forward_path_components[0].source_vpc.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].source_vpc.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].source_vpc.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].subnet.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].subnet.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].subnet.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].vpc.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].vpc.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].vpc.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details #=> Array
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].additional_detail_type #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].component.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].component.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].component.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].vpc_endpoint_service.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].vpc_endpoint_service.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].vpc_endpoint_service.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_options #=> Array
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_options[0].keyword #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_options[0].settings #=> Array
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_options[0].settings[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_group_type_pairs #=> Array
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_type #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_group_rule_options_pairs #=> Array
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_group_arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options #=> Array
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].keyword #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings #=> Array
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].service_name #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].load_balancers #=> Array
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].load_balancers[0].id #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].load_balancers[0].arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].additional_details[0].load_balancers[0].name #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl_rule.cidr #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl_rule.egress #=> Boolean
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl_rule.protocol #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl_rule.rule_action #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].acl_rule.rule_number #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].address #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].addresses #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].addresses[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].attached_to.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].attached_to.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].attached_to.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].availability_zones #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].availability_zones[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].cidrs #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].cidrs[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].component.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].component.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].component.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].customer_gateway.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].customer_gateway.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].customer_gateway.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].destination.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].destination.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].destination.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].destination_vpc.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].destination_vpc.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].destination_vpc.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].direction #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].explanation_code #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].ingress_route_table.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].ingress_route_table.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].ingress_route_table.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].internet_gateway.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].internet_gateway.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].internet_gateway.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].classic_load_balancer_listener.load_balancer_port #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].classic_load_balancer_listener.instance_port #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_listener_port #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target.address #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target.availability_zone #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target.instance.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target.instance.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target.instance.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target.port #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target_group.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target_group.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target_group.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target_groups #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target_groups[0].id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target_groups[0].arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target_groups[0].name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].load_balancer_target_port #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].missing_component #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].nat_gateway.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].nat_gateway.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].nat_gateway.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].network_interface.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].network_interface.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].network_interface.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].packet_field #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpc_peering_connection.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpc_peering_connection.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpc_peering_connection.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].port #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].port_ranges #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].prefix_list.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].prefix_list.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].prefix_list.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].protocols #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].protocols[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.instance_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.network_interface_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.origin #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.state #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.core_network_arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].route_table.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group_rule.cidr #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group_rule.direction #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group_rule.security_group_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_group_rule.protocol #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_groups #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_groups[0].id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_groups[0].arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].security_groups[0].name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].source_vpc.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].source_vpc.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].source_vpc.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].state #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].subnet.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].subnet.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].subnet.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].subnet_route_table.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].subnet_route_table.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].subnet_route_table.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpc.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpc.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpc.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpc_endpoint.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpc_endpoint.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpc_endpoint.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpn_connection.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpn_connection.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpn_connection.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpn_gateway.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpn_gateway.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].vpn_gateway.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_attachment.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_attachment.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].transit_gateway_attachment.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0]. #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].component_region #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analyses[0].forward_path_components[0].explanations[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analyses[0].forward_path_components[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analyses[0].forward_path_components[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analyses[0].forward_path_components[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analyses[0].forward_path_components[0].service_name #=> String
resp.network_insights_analyses[0].return_path_components #=> Array
resp.network_insights_analyses[0].return_path_components[0].sequence_number #=> Integer
resp.network_insights_analyses[0].return_path_components[0].acl_rule.cidr #=> String
resp.network_insights_analyses[0].return_path_components[0].acl_rule.egress #=> Boolean
resp.network_insights_analyses[0].return_path_components[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].acl_rule.protocol #=> String
resp.network_insights_analyses[0].return_path_components[0].acl_rule.rule_action #=> String
resp.network_insights_analyses[0].return_path_components[0].acl_rule.rule_number #=> Integer
resp.network_insights_analyses[0].return_path_components[0].attached_to.id #=> String
resp.network_insights_analyses[0].return_path_components[0].attached_to.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].attached_to.name #=> String
resp.network_insights_analyses[0].return_path_components[0].component.id #=> String
resp.network_insights_analyses[0].return_path_components[0].component.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].component.name #=> String
resp.network_insights_analyses[0].return_path_components[0].destination_vpc.id #=> String
resp.network_insights_analyses[0].return_path_components[0].destination_vpc.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].destination_vpc.name #=> String
resp.network_insights_analyses[0].return_path_components[0].outbound_header.destination_addresses #=> Array
resp.network_insights_analyses[0].return_path_components[0].outbound_header.destination_addresses[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].outbound_header.destination_port_ranges #=> Array
resp.network_insights_analyses[0].return_path_components[0].outbound_header.destination_port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].outbound_header.destination_port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].outbound_header.protocol #=> String
resp.network_insights_analyses[0].return_path_components[0].outbound_header.source_addresses #=> Array
resp.network_insights_analyses[0].return_path_components[0].outbound_header.source_addresses[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].outbound_header.source_port_ranges #=> Array
resp.network_insights_analyses[0].return_path_components[0].outbound_header.source_port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].outbound_header.source_port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].inbound_header.destination_addresses #=> Array
resp.network_insights_analyses[0].return_path_components[0].inbound_header.destination_addresses[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].inbound_header.destination_port_ranges #=> Array
resp.network_insights_analyses[0].return_path_components[0].inbound_header.destination_port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].inbound_header.destination_port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].inbound_header.protocol #=> String
resp.network_insights_analyses[0].return_path_components[0].inbound_header.source_addresses #=> Array
resp.network_insights_analyses[0].return_path_components[0].inbound_header.source_addresses[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].inbound_header.source_port_ranges #=> Array
resp.network_insights_analyses[0].return_path_components[0].inbound_header.source_port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].inbound_header.source_port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.instance_id #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.network_interface_id #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.origin #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.state #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.core_network_arn #=> String
resp.network_insights_analyses[0].return_path_components[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].security_group_rule.cidr #=> String
resp.network_insights_analyses[0].return_path_components[0].security_group_rule.direction #=> String
resp.network_insights_analyses[0].return_path_components[0].security_group_rule.security_group_id #=> String
resp.network_insights_analyses[0].return_path_components[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analyses[0].return_path_components[0].security_group_rule.protocol #=> String
resp.network_insights_analyses[0].return_path_components[0].source_vpc.id #=> String
resp.network_insights_analyses[0].return_path_components[0].source_vpc.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].source_vpc.name #=> String
resp.network_insights_analyses[0].return_path_components[0].subnet.id #=> String
resp.network_insights_analyses[0].return_path_components[0].subnet.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].subnet.name #=> String
resp.network_insights_analyses[0].return_path_components[0].vpc.id #=> String
resp.network_insights_analyses[0].return_path_components[0].vpc.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].vpc.name #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details #=> Array
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].additional_detail_type #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].component.id #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].component.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].component.name #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].vpc_endpoint_service.id #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].vpc_endpoint_service.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].vpc_endpoint_service.name #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_options #=> Array
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_options[0].keyword #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_options[0].settings #=> Array
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_options[0].settings[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_group_type_pairs #=> Array
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_arn #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_type #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_group_rule_options_pairs #=> Array
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_group_arn #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options #=> Array
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].keyword #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings #=> Array
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].service_name #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].load_balancers #=> Array
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].load_balancers[0].id #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].load_balancers[0].arn #=> String
resp.network_insights_analyses[0].return_path_components[0].additional_details[0].load_balancers[0].name #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway.id #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway.name #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analyses[0].return_path_components[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl_rule.cidr #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl_rule.egress #=> Boolean
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl_rule.protocol #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl_rule.rule_action #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].acl_rule.rule_number #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].address #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].addresses #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].addresses[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].attached_to.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].attached_to.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].attached_to.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].availability_zones #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].availability_zones[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].cidrs #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].cidrs[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].component.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].component.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].component.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].customer_gateway.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].customer_gateway.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].customer_gateway.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].destination.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].destination.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].destination.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].destination_vpc.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].destination_vpc.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].destination_vpc.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].direction #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].explanation_code #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].ingress_route_table.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].ingress_route_table.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].ingress_route_table.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].internet_gateway.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].internet_gateway.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].internet_gateway.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].classic_load_balancer_listener.load_balancer_port #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].classic_load_balancer_listener.instance_port #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_listener_port #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target.address #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target.availability_zone #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target.instance.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target.instance.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target.instance.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target.port #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target_group.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target_group.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target_group.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target_groups #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target_groups[0].id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target_groups[0].arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target_groups[0].name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].load_balancer_target_port #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].missing_component #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].nat_gateway.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].nat_gateway.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].nat_gateway.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].network_interface.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].network_interface.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].network_interface.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].packet_field #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpc_peering_connection.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpc_peering_connection.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpc_peering_connection.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].port #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].port_ranges #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].prefix_list.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].prefix_list.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].prefix_list.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].protocols #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].protocols[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.instance_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.network_interface_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.origin #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.state #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.core_network_arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].route_table.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group_rule.cidr #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group_rule.direction #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group_rule.security_group_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_group_rule.protocol #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_groups #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_groups[0].id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_groups[0].arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].security_groups[0].name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].source_vpc.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].source_vpc.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].source_vpc.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].state #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].subnet.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].subnet.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].subnet.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].subnet_route_table.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].subnet_route_table.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].subnet_route_table.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpc.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpc.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpc.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpc_endpoint.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpc_endpoint.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpc_endpoint.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpn_connection.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpn_connection.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpn_connection.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpn_gateway.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpn_gateway.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].vpn_gateway.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_attachment.id #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_attachment.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].transit_gateway_attachment.name #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0]. #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].component_region #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analyses[0].return_path_components[0].explanations[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analyses[0].return_path_components[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analyses[0].return_path_components[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analyses[0].return_path_components[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analyses[0].return_path_components[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analyses[0].return_path_components[0].service_name #=> String
resp.network_insights_analyses[0].explanations #=> Array
resp.network_insights_analyses[0].explanations[0].acl.id #=> String
resp.network_insights_analyses[0].explanations[0].acl.arn #=> String
resp.network_insights_analyses[0].explanations[0].acl.name #=> String
resp.network_insights_analyses[0].explanations[0].acl_rule.cidr #=> String
resp.network_insights_analyses[0].explanations[0].acl_rule.egress #=> Boolean
resp.network_insights_analyses[0].explanations[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].explanations[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].explanations[0].acl_rule.protocol #=> String
resp.network_insights_analyses[0].explanations[0].acl_rule.rule_action #=> String
resp.network_insights_analyses[0].explanations[0].acl_rule.rule_number #=> Integer
resp.network_insights_analyses[0].explanations[0].address #=> String
resp.network_insights_analyses[0].explanations[0].addresses #=> Array
resp.network_insights_analyses[0].explanations[0].addresses[0] #=> String
resp.network_insights_analyses[0].explanations[0].attached_to.id #=> String
resp.network_insights_analyses[0].explanations[0].attached_to.arn #=> String
resp.network_insights_analyses[0].explanations[0].attached_to.name #=> String
resp.network_insights_analyses[0].explanations[0].availability_zones #=> Array
resp.network_insights_analyses[0].explanations[0].availability_zones[0] #=> String
resp.network_insights_analyses[0].explanations[0].cidrs #=> Array
resp.network_insights_analyses[0].explanations[0].cidrs[0] #=> String
resp.network_insights_analyses[0].explanations[0].component.id #=> String
resp.network_insights_analyses[0].explanations[0].component.arn #=> String
resp.network_insights_analyses[0].explanations[0].component.name #=> String
resp.network_insights_analyses[0].explanations[0].customer_gateway.id #=> String
resp.network_insights_analyses[0].explanations[0].customer_gateway.arn #=> String
resp.network_insights_analyses[0].explanations[0].customer_gateway.name #=> String
resp.network_insights_analyses[0].explanations[0].destination.id #=> String
resp.network_insights_analyses[0].explanations[0].destination.arn #=> String
resp.network_insights_analyses[0].explanations[0].destination.name #=> String
resp.network_insights_analyses[0].explanations[0].destination_vpc.id #=> String
resp.network_insights_analyses[0].explanations[0].destination_vpc.arn #=> String
resp.network_insights_analyses[0].explanations[0].destination_vpc.name #=> String
resp.network_insights_analyses[0].explanations[0].direction #=> String
resp.network_insights_analyses[0].explanations[0].explanation_code #=> String
resp.network_insights_analyses[0].explanations[0].ingress_route_table.id #=> String
resp.network_insights_analyses[0].explanations[0].ingress_route_table.arn #=> String
resp.network_insights_analyses[0].explanations[0].ingress_route_table.name #=> String
resp.network_insights_analyses[0].explanations[0].internet_gateway.id #=> String
resp.network_insights_analyses[0].explanations[0].internet_gateway.arn #=> String
resp.network_insights_analyses[0].explanations[0].internet_gateway.name #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_arn #=> String
resp.network_insights_analyses[0].explanations[0].classic_load_balancer_listener.load_balancer_port #=> Integer
resp.network_insights_analyses[0].explanations[0].classic_load_balancer_listener.instance_port #=> Integer
resp.network_insights_analyses[0].explanations[0].load_balancer_listener_port #=> Integer
resp.network_insights_analyses[0].explanations[0].load_balancer_target.address #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target.availability_zone #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target.instance.id #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target.instance.arn #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target.instance.name #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target.port #=> Integer
resp.network_insights_analyses[0].explanations[0].load_balancer_target_group.id #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target_group.arn #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target_group.name #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target_groups #=> Array
resp.network_insights_analyses[0].explanations[0].load_balancer_target_groups[0].id #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target_groups[0].arn #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target_groups[0].name #=> String
resp.network_insights_analyses[0].explanations[0].load_balancer_target_port #=> Integer
resp.network_insights_analyses[0].explanations[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analyses[0].explanations[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analyses[0].explanations[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analyses[0].explanations[0].missing_component #=> String
resp.network_insights_analyses[0].explanations[0].nat_gateway.id #=> String
resp.network_insights_analyses[0].explanations[0].nat_gateway.arn #=> String
resp.network_insights_analyses[0].explanations[0].nat_gateway.name #=> String
resp.network_insights_analyses[0].explanations[0].network_interface.id #=> String
resp.network_insights_analyses[0].explanations[0].network_interface.arn #=> String
resp.network_insights_analyses[0].explanations[0].network_interface.name #=> String
resp.network_insights_analyses[0].explanations[0].packet_field #=> String
resp.network_insights_analyses[0].explanations[0].vpc_peering_connection.id #=> String
resp.network_insights_analyses[0].explanations[0].vpc_peering_connection.arn #=> String
resp.network_insights_analyses[0].explanations[0].vpc_peering_connection.name #=> String
resp.network_insights_analyses[0].explanations[0].port #=> Integer
resp.network_insights_analyses[0].explanations[0].port_ranges #=> Array
resp.network_insights_analyses[0].explanations[0].port_ranges[0].from #=> Integer
resp.network_insights_analyses[0].explanations[0].port_ranges[0].to #=> Integer
resp.network_insights_analyses[0].explanations[0].prefix_list.id #=> String
resp.network_insights_analyses[0].explanations[0].prefix_list.arn #=> String
resp.network_insights_analyses[0].explanations[0].prefix_list.name #=> String
resp.network_insights_analyses[0].explanations[0].protocols #=> Array
resp.network_insights_analyses[0].explanations[0].protocols[0] #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.gateway_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.instance_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.network_interface_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.origin #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.state #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.core_network_arn #=> String
resp.network_insights_analyses[0].explanations[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analyses[0].explanations[0].route_table.id #=> String
resp.network_insights_analyses[0].explanations[0].route_table.arn #=> String
resp.network_insights_analyses[0].explanations[0].route_table.name #=> String
resp.network_insights_analyses[0].explanations[0].security_group.id #=> String
resp.network_insights_analyses[0].explanations[0].security_group.arn #=> String
resp.network_insights_analyses[0].explanations[0].security_group.name #=> String
resp.network_insights_analyses[0].explanations[0].security_group_rule.cidr #=> String
resp.network_insights_analyses[0].explanations[0].security_group_rule.direction #=> String
resp.network_insights_analyses[0].explanations[0].security_group_rule.security_group_id #=> String
resp.network_insights_analyses[0].explanations[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analyses[0].explanations[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analyses[0].explanations[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analyses[0].explanations[0].security_group_rule.protocol #=> String
resp.network_insights_analyses[0].explanations[0].security_groups #=> Array
resp.network_insights_analyses[0].explanations[0].security_groups[0].id #=> String
resp.network_insights_analyses[0].explanations[0].security_groups[0].arn #=> String
resp.network_insights_analyses[0].explanations[0].security_groups[0].name #=> String
resp.network_insights_analyses[0].explanations[0].source_vpc.id #=> String
resp.network_insights_analyses[0].explanations[0].source_vpc.arn #=> String
resp.network_insights_analyses[0].explanations[0].source_vpc.name #=> String
resp.network_insights_analyses[0].explanations[0].state #=> String
resp.network_insights_analyses[0].explanations[0].subnet.id #=> String
resp.network_insights_analyses[0].explanations[0].subnet.arn #=> String
resp.network_insights_analyses[0].explanations[0].subnet.name #=> String
resp.network_insights_analyses[0].explanations[0].subnet_route_table.id #=> String
resp.network_insights_analyses[0].explanations[0].subnet_route_table.arn #=> String
resp.network_insights_analyses[0].explanations[0].subnet_route_table.name #=> String
resp.network_insights_analyses[0].explanations[0].vpc.id #=> String
resp.network_insights_analyses[0].explanations[0].vpc.arn #=> String
resp.network_insights_analyses[0].explanations[0].vpc.name #=> String
resp.network_insights_analyses[0].explanations[0].vpc_endpoint.id #=> String
resp.network_insights_analyses[0].explanations[0].vpc_endpoint.arn #=> String
resp.network_insights_analyses[0].explanations[0].vpc_endpoint.name #=> String
resp.network_insights_analyses[0].explanations[0].vpn_connection.id #=> String
resp.network_insights_analyses[0].explanations[0].vpn_connection.arn #=> String
resp.network_insights_analyses[0].explanations[0].vpn_connection.name #=> String
resp.network_insights_analyses[0].explanations[0].vpn_gateway.id #=> String
resp.network_insights_analyses[0].explanations[0].vpn_gateway.arn #=> String
resp.network_insights_analyses[0].explanations[0].vpn_gateway.name #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway.id #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway.arn #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway.name #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table.id #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table.arn #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table.name #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_attachment.id #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_attachment.arn #=> String
resp.network_insights_analyses[0].explanations[0].transit_gateway_attachment.name #=> String
resp.network_insights_analyses[0].explanations[0]. #=> String
resp.network_insights_analyses[0].explanations[0].component_region #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analyses[0].explanations[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analyses[0].alternate_path_hints #=> Array
resp.network_insights_analyses[0].alternate_path_hints[0].component_id #=> String
resp.network_insights_analyses[0].alternate_path_hints[0].component_arn #=> String
resp.network_insights_analyses[0].suggested_accounts #=> Array
resp.network_insights_analyses[0].suggested_accounts[0] #=> String
resp.network_insights_analyses[0].tags #=> Array
resp.network_insights_analyses[0].tags[0].key #=> String
resp.network_insights_analyses[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_insights_analysis_ids (Array<String>) —

    The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

  • :network_insights_path_id (String) —

    The ID of the path. You must specify either a path ID or analysis IDs.

  • :analysis_start_time (Time, DateTime, Date, Integer, String) —

    The time when the network insights analyses started.

  • :analysis_end_time (Time, DateTime, Date, Integer, String) —

    The time when the network insights analyses ended.

  • :filters (Array<Types::Filter>) —

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

  • :max_results (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.

  • :dry_run (Boolean) —

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

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



30164
30165
30166
30167
 
# File 'lib/aws-sdk-ec2/client.rb', line 30164

def describe_network_insights_analyses(params = {}, options = {})
  req = build_request(:describe_network_insights_analyses, params)
  req.send_request(options)
end

#describe_network_insights_paths(params = {}) ⇒ Types::DescribeNetworkInsightsPathsResult

Describes one or more of your paths.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_network_insights_paths({
  network_insights_path_ids: ["NetworkInsightsPathId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  dry_run: false,
  next_token: "NextToken",
})

Response structure


resp.network_insights_paths #=> Array
resp.network_insights_paths[0].network_insights_path_id #=> String
resp.network_insights_paths[0].network_insights_path_arn #=> String
resp.network_insights_paths[0].created_date #=> Time
resp.network_insights_paths[0].source #=> String
resp.network_insights_paths[0].destination #=> String
resp.network_insights_paths[0].source_arn #=> String
resp.network_insights_paths[0].destination_arn #=> String
resp.network_insights_paths[0].source_ip #=> String
resp.network_insights_paths[0].destination_ip #=> String
resp.network_insights_paths[0].protocol #=> String, one of "tcp", "udp"
resp.network_insights_paths[0].destination_port #=> Integer
resp.network_insights_paths[0].tags #=> Array
resp.network_insights_paths[0].tags[0].key #=> String
resp.network_insights_paths[0].tags[0].value #=> String
resp.network_insights_paths[0].filter_at_source.source_address #=> String
resp.network_insights_paths[0].filter_at_source.source_port_range.from_port #=> Integer
resp.network_insights_paths[0].filter_at_source.source_port_range.to_port #=> Integer
resp.network_insights_paths[0].filter_at_source.destination_address #=> String
resp.network_insights_paths[0].filter_at_source.destination_port_range.from_port #=> Integer
resp.network_insights_paths[0].filter_at_source.destination_port_range.to_port #=> Integer
resp.network_insights_paths[0].filter_at_destination.source_address #=> String
resp.network_insights_paths[0].filter_at_destination.source_port_range.from_port #=> Integer
resp.network_insights_paths[0].filter_at_destination.source_port_range.to_port #=> Integer
resp.network_insights_paths[0].filter_at_destination.destination_address #=> String
resp.network_insights_paths[0].filter_at_destination.destination_port_range.from_port #=> Integer
resp.network_insights_paths[0].filter_at_destination.destination_port_range.to_port #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_insights_path_ids (Array<String>) —

    The IDs of the paths.

  • :filters (Array<Types::Filter>) —

    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.

  • :max_results (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.

  • :dry_run (Boolean) —

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

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



30278
30279
30280
30281
 
# File 'lib/aws-sdk-ec2/client.rb', line 30278

def describe_network_insights_paths(params = {}, options = {})
  req = build_request(:describe_network_insights_paths, params)
  req.send_request(options)
end

#describe_network_interface_attribute(params = {}) ⇒ Types::DescribeNetworkInterfaceAttributeResult

Describes a network interface attribute. You can specify only one attribute at a time.

Examples:

Example: To describe the attachment attribute of a network interface


# This example describes the attachment attribute of the specified network interface.

resp = client.describe_network_interface_attribute({
  attribute: "attachment", 
  network_interface_id: "eni-686ea200", 
})

resp.to_h outputs the following:
{
  attachment: {
    attach_time: Time.parse("2015-05-21T20:02:20.000Z"), 
    attachment_id: "eni-attach-43348162", 
    delete_on_termination: true, 
    device_index: 0, 
    instance_id: "i-1234567890abcdef0", 
    instance_owner_id: "123456789012", 
    status: "attached", 
  }, 
  network_interface_id: "eni-686ea200", 
}

Example: To describe the description attribute of a network interface


# This example describes the description attribute of the specified network interface.

resp = client.describe_network_interface_attribute({
  attribute: "description", 
  network_interface_id: "eni-686ea200", 
})

resp.to_h outputs the following:
{
  description: {
    value: "My description", 
  }, 
  network_interface_id: "eni-686ea200", 
}

Example: To describe the groupSet attribute of a network interface


# This example describes the groupSet attribute of the specified network interface.

resp = client.describe_network_interface_attribute({
  attribute: "groupSet", 
  network_interface_id: "eni-686ea200", 
})

resp.to_h outputs the following:
{
  groups: [
    {
      group_id: "sg-903004f8", 
      group_name: "my-security-group", 
    }, 
  ], 
  network_interface_id: "eni-686ea200", 
}

Example: To describe the sourceDestCheck attribute of a network interface


# This example describes the sourceDestCheck attribute of the specified network interface.

resp = client.describe_network_interface_attribute({
  attribute: "sourceDestCheck", 
  network_interface_id: "eni-686ea200", 
})

resp.to_h outputs the following:
{
  network_interface_id: "eni-686ea200", 
  source_dest_check: {
    value: true, 
  }, 
}

Request syntax with placeholder values


resp = client.describe_network_interface_attribute({
  dry_run: false,
  network_interface_id: "NetworkInterfaceId", # required
  attribute: "description", # accepts description, groupSet, sourceDestCheck, attachment, associatePublicIpAddress
})

Response structure


resp.attachment.attach_time #=> Time
resp.attachment.attachment_id #=> String
resp.attachment.delete_on_termination #=> Boolean
resp.attachment.device_index #=> Integer
resp.attachment.network_card_index #=> Integer
resp.attachment.instance_id #=> String
resp.attachment.instance_owner_id #=> String
resp.attachment.status #=> String, one of "attaching", "attached", "detaching", "detached"
resp.attachment.ena_srd_specification.ena_srd_enabled #=> Boolean
resp.attachment.ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.description #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.groups #=> Array
resp.groups[0].group_id #=> String
resp.groups[0].group_name #=> String
resp.network_interface_id #=> String
resp.source_dest_check.value #=> Boolean
resp.associate_public_ip_address #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_interface_id (required, String) —

    The ID of the network interface.

  • :attribute (String) —

    The attribute of the network interface. This parameter is required.

Returns:

See Also:



30417
30418
30419
30420
 
# File 'lib/aws-sdk-ec2/client.rb', line 30417

def describe_network_interface_attribute(params = {}, options = {})
  req = build_request(:describe_network_interface_attribute, params)
  req.send_request(options)
end

#describe_network_interface_permissions(params = {}) ⇒ Types::DescribeNetworkInterfacePermissionsResult

Describes the permissions for your network interfaces.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_network_interface_permissions({
  network_interface_permission_ids: ["NetworkInterfacePermissionId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.network_interface_permissions #=> Array
resp.network_interface_permissions[0].network_interface_permission_id #=> String
resp.network_interface_permissions[0].network_interface_id #=> String
resp.network_interface_permissions[0]. #=> String
resp.network_interface_permissions[0].aws_service #=> String
resp.network_interface_permissions[0].permission #=> String, one of "INSTANCE-ATTACH", "EIP-ASSOCIATE"
resp.network_interface_permissions[0].permission_state.state #=> String, one of "pending", "granted", "revoking", "revoked"
resp.network_interface_permissions[0].permission_state.status_message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_interface_permission_ids (Array<String>) —

    The network interface permission IDs.

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘network-interface-permission.network-interface-permission-id` - The ID of the permission.

    • ‘network-interface-permission.network-interface-id` - The ID of the network interface.

    • ‘network-interface-permission.aws-account-id` - The 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`).

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



30496
30497
30498
30499
 
# File 'lib/aws-sdk-ec2/client.rb', line 30496

def describe_network_interface_permissions(params = {}, options = {})
  req = build_request(:describe_network_interface_permissions, params)
  req.send_request(options)
end

#describe_network_interfaces(params = {}) ⇒ Types::DescribeNetworkInterfacesResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* network_interface_available

Examples:

Example: To describe a network interface


resp = client.describe_network_interfaces({
  network_interface_ids: [
    "eni-e5aa89a3", 
  ], 
})

resp.to_h outputs the following:
{
  network_interfaces: [
    {
      association: {
        association_id: "eipassoc-0fbb766a", 
        ip_owner_id: "123456789012", 
        public_dns_name: "ec2-203-0-113-12.compute-1.amazonaws.com", 
        public_ip: "203.0.113.12", 
      }, 
      attachment: {
        attach_time: Time.parse("2013-11-30T23:36:42.000Z"), 
        attachment_id: "eni-attach-66c4350a", 
        delete_on_termination: false, 
        device_index: 1, 
        instance_id: "i-1234567890abcdef0", 
        instance_owner_id: "123456789012", 
        status: "attached", 
      }, 
      availability_zone: "us-east-1d", 
      description: "my network interface", 
      groups: [
        {
          group_id: "sg-8637d3e3", 
          group_name: "default", 
        }, 
      ], 
      mac_address: "02:2f:8f:b0:cf:75", 
      network_interface_id: "eni-e5aa89a3", 
      owner_id: "123456789012", 
      private_dns_name: "ip-10-0-1-17.ec2.internal", 
      private_ip_address: "10.0.1.17", 
      private_ip_addresses: [
        {
          association: {
            association_id: "eipassoc-0fbb766a", 
            ip_owner_id: "123456789012", 
            public_dns_name: "ec2-203-0-113-12.compute-1.amazonaws.com", 
            public_ip: "203.0.113.12", 
          }, 
          primary: true, 
          private_dns_name: "ip-10-0-1-17.ec2.internal", 
          private_ip_address: "10.0.1.17", 
        }, 
      ], 
      requester_managed: false, 
      source_dest_check: true, 
      status: "in-use", 
      subnet_id: "subnet-b61f49f0", 
      tag_set: [
      ], 
      vpc_id: "vpc-a01106c2", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_network_interfaces({
  next_token: "String",
  max_results: 1,
  dry_run: false,
  network_interface_ids: ["NetworkInterfaceId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.network_interfaces #=> Array
resp.network_interfaces[0].association.allocation_id #=> String
resp.network_interfaces[0].association.association_id #=> String
resp.network_interfaces[0].association.ip_owner_id #=> String
resp.network_interfaces[0].association.public_dns_name #=> String
resp.network_interfaces[0].association.public_ip #=> String
resp.network_interfaces[0].association.customer_owned_ip #=> String
resp.network_interfaces[0].association.carrier_ip #=> String
resp.network_interfaces[0].attachment.attach_time #=> Time
resp.network_interfaces[0].attachment.attachment_id #=> String
resp.network_interfaces[0].attachment.delete_on_termination #=> Boolean
resp.network_interfaces[0].attachment.device_index #=> Integer
resp.network_interfaces[0].attachment.network_card_index #=> Integer
resp.network_interfaces[0].attachment.instance_id #=> String
resp.network_interfaces[0].attachment.instance_owner_id #=> String
resp.network_interfaces[0].attachment.status #=> String, one of "attaching", "attached", "detaching", "detached"
resp.network_interfaces[0].attachment.ena_srd_specification.ena_srd_enabled #=> Boolean
resp.network_interfaces[0].attachment.ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.network_interfaces[0].availability_zone #=> String
resp.network_interfaces[0].connection_tracking_configuration.tcp_established_timeout #=> Integer
resp.network_interfaces[0].connection_tracking_configuration.udp_stream_timeout #=> Integer
resp.network_interfaces[0].connection_tracking_configuration.udp_timeout #=> Integer
resp.network_interfaces[0].description #=> String
resp.network_interfaces[0].groups #=> Array
resp.network_interfaces[0].groups[0].group_id #=> String
resp.network_interfaces[0].groups[0].group_name #=> String
resp.network_interfaces[0].interface_type #=> String, one of "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"
resp.network_interfaces[0].ipv_6_addresses #=> Array
resp.network_interfaces[0].ipv_6_addresses[0].ipv_6_address #=> String
resp.network_interfaces[0].ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.network_interfaces[0].mac_address #=> String
resp.network_interfaces[0].network_interface_id #=> String
resp.network_interfaces[0].outpost_arn #=> String
resp.network_interfaces[0].owner_id #=> String
resp.network_interfaces[0].private_dns_name #=> String
resp.network_interfaces[0].private_ip_address #=> String
resp.network_interfaces[0].private_ip_addresses #=> Array
resp.network_interfaces[0].private_ip_addresses[0].association.allocation_id #=> String
resp.network_interfaces[0].private_ip_addresses[0].association.association_id #=> String
resp.network_interfaces[0].private_ip_addresses[0].association.ip_owner_id #=> String
resp.network_interfaces[0].private_ip_addresses[0].association.public_dns_name #=> String
resp.network_interfaces[0].private_ip_addresses[0].association.public_ip #=> String
resp.network_interfaces[0].private_ip_addresses[0].association.customer_owned_ip #=> String
resp.network_interfaces[0].private_ip_addresses[0].association.carrier_ip #=> String
resp.network_interfaces[0].private_ip_addresses[0].primary #=> Boolean
resp.network_interfaces[0].private_ip_addresses[0].private_dns_name #=> String
resp.network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String
resp.network_interfaces[0].ipv_4_prefixes #=> Array
resp.network_interfaces[0].ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.network_interfaces[0].ipv_6_prefixes #=> Array
resp.network_interfaces[0].ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.network_interfaces[0].requester_id #=> String
resp.network_interfaces[0].requester_managed #=> Boolean
resp.network_interfaces[0].source_dest_check #=> Boolean
resp.network_interfaces[0].status #=> String, one of "available", "associated", "attaching", "in-use", "detaching"
resp.network_interfaces[0].subnet_id #=> String
resp.network_interfaces[0].tag_set #=> Array
resp.network_interfaces[0].tag_set[0].key #=> String
resp.network_interfaces[0].tag_set[0].value #=> String
resp.network_interfaces[0].vpc_id #=> String
resp.network_interfaces[0].deny_all_igw_traffic #=> Boolean
resp.network_interfaces[0].ipv_6_native #=> Boolean
resp.network_interfaces[0].ipv_6_address #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

  • :network_interface_ids (Array<String>) —

    The network interface IDs.

    Default: Describes all your network interfaces.

  • :filters (Array<Types::Filter>) —

    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`:&lt;key&gt; - 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.

Returns:

See Also:



30816
30817
30818
30819
 
# File 'lib/aws-sdk-ec2/client.rb', line 30816

def describe_network_interfaces(params = {}, options = {})
  req = build_request(:describe_network_interfaces, params)
  req.send_request(options)
end

#describe_placement_groups(params = {}) ⇒ Types::DescribePlacementGroupsResult

Describes the specified placement groups or all of your placement groups.

<note markdown=“1”> 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.

</note>

For more information, see [Placement groups] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html

Examples:

Request syntax with placeholder values


resp = client.describe_placement_groups({
  group_ids: ["PlacementGroupId"],
  dry_run: false,
  group_names: ["PlacementGroupName"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.placement_groups #=> Array
resp.placement_groups[0].group_name #=> String
resp.placement_groups[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.placement_groups[0].strategy #=> String, one of "cluster", "spread", "partition"
resp.placement_groups[0].partition_count #=> Integer
resp.placement_groups[0].group_id #=> String
resp.placement_groups[0].tags #=> Array
resp.placement_groups[0].tags[0].key #=> String
resp.placement_groups[0].tags[0].value #=> String
resp.placement_groups[0].group_arn #=> String
resp.placement_groups[0].spread_level #=> String, one of "host", "rack"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_ids (Array<String>) —

    The IDs of the placement groups.

  • :dry_run (Boolean) —

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

  • :group_names (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.

  • :filters (Array<Types::Filter>) —

    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.

Returns:

See Also:



30921
30922
30923
30924
 
# File 'lib/aws-sdk-ec2/client.rb', line 30921

def describe_placement_groups(params = {}, options = {})
  req = build_request(:describe_placement_groups, params)
  req.send_request(options)
end

#describe_prefix_lists(params = {}) ⇒ Types::DescribePrefixListsResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_prefix_lists({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  prefix_list_ids: ["PrefixListResourceId"],
})

Response structure


resp.next_token #=> String
resp.prefix_lists #=> Array
resp.prefix_lists[0].cidrs #=> Array
resp.prefix_lists[0].cidrs[0] #=> String
resp.prefix_lists[0].prefix_list_id #=> String
resp.prefix_lists[0].prefix_list_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    One or more filters.

    • ‘prefix-list-id`: The ID of a prefix list.

    • ‘prefix-list-name`: The name of a prefix list.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :prefix_list_ids (Array<String>) —

    One or more prefix list IDs.

Returns:

See Also:



30991
30992
30993
30994
 
# File 'lib/aws-sdk-ec2/client.rb', line 30991

def describe_prefix_lists(params = {}, options = {})
  req = build_request(:describe_prefix_lists, params)
  req.send_request(options)
end

#describe_principal_id_format(params = {}) ⇒ Types::DescribePrincipalIdFormatResult

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_principal_id_format({
  dry_run: false,
  resources: ["String"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.principals #=> Array
resp.principals[0].arn #=> String
resp.principals[0].statuses #=> Array
resp.principals[0].statuses[0].deadline #=> Time
resp.principals[0].statuses[0].resource #=> String
resp.principals[0].statuses[0].use_long_ids #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :max_results (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.

  • :next_token (String) —

    The token to request the next page of results.

Returns:

See Also:



31073
31074
31075
31076
 
# File 'lib/aws-sdk-ec2/client.rb', line 31073

def describe_principal_id_format(params = {}, options = {})
  req = build_request(:describe_principal_id_format, params)
  req.send_request(options)
end

#describe_public_ipv_4_pools(params = {}) ⇒ Types::DescribePublicIpv4PoolsResult

Describes the specified IPv4 address pools.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_public_ipv_4_pools({
  pool_ids: ["Ipv4PoolEc2Id"],
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.public_ipv_4_pools #=> Array
resp.public_ipv_4_pools[0].pool_id #=> String
resp.public_ipv_4_pools[0].description #=> String
resp.public_ipv_4_pools[0].pool_address_ranges #=> Array
resp.public_ipv_4_pools[0].pool_address_ranges[0].first_address #=> String
resp.public_ipv_4_pools[0].pool_address_ranges[0].last_address #=> String
resp.public_ipv_4_pools[0].pool_address_ranges[0].address_count #=> Integer
resp.public_ipv_4_pools[0].pool_address_ranges[0].available_address_count #=> Integer
resp.public_ipv_4_pools[0].total_address_count #=> Integer
resp.public_ipv_4_pools[0].total_available_address_count #=> Integer
resp.public_ipv_4_pools[0].network_border_group #=> String
resp.public_ipv_4_pools[0].tags #=> Array
resp.public_ipv_4_pools[0].tags[0].key #=> String
resp.public_ipv_4_pools[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_ids (Array<String>) —

    The IDs of the address pools.

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (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<Types::Filter>) —

    One or more filters.

    • ‘tag`:&lt;key&gt; - 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.

Returns:

See Also:



31147
31148
31149
31150
 
# File 'lib/aws-sdk-ec2/client.rb', line 31147

def describe_public_ipv_4_pools(params = {}, options = {})
  req = build_request(:describe_public_ipv_4_pools, params)
  req.send_request(options)
end

#describe_regions(params = {}) ⇒ Types::DescribeRegionsResult

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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-endpoints.html [2]: docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html

Examples:

Example: To describe your regions


# This example describes all the regions that are available to you.

resp = client.describe_regions({
})

resp.to_h outputs the following:
{
  regions: [
    {
      endpoint: "ec2.ap-south-1.amazonaws.com", 
      region_name: "ap-south-1", 
    }, 
    {
      endpoint: "ec2.eu-west-1.amazonaws.com", 
      region_name: "eu-west-1", 
    }, 
    {
      endpoint: "ec2.ap-southeast-1.amazonaws.com", 
      region_name: "ap-southeast-1", 
    }, 
    {
      endpoint: "ec2.ap-southeast-2.amazonaws.com", 
      region_name: "ap-southeast-2", 
    }, 
    {
      endpoint: "ec2.eu-central-1.amazonaws.com", 
      region_name: "eu-central-1", 
    }, 
    {
      endpoint: "ec2.ap-northeast-2.amazonaws.com", 
      region_name: "ap-northeast-2", 
    }, 
    {
      endpoint: "ec2.ap-northeast-1.amazonaws.com", 
      region_name: "ap-northeast-1", 
    }, 
    {
      endpoint: "ec2.us-east-1.amazonaws.com", 
      region_name: "us-east-1", 
    }, 
    {
      endpoint: "ec2.sa-east-1.amazonaws.com", 
      region_name: "sa-east-1", 
    }, 
    {
      endpoint: "ec2.us-west-1.amazonaws.com", 
      region_name: "us-west-1", 
    }, 
    {
      endpoint: "ec2.us-west-2.amazonaws.com", 
      region_name: "us-west-2", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_regions({
  region_names: ["String"],
  all_regions: false,
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.regions #=> Array
resp.regions[0].opt_in_status #=> String
resp.regions[0].region_name #=> String
resp.regions[0].endpoint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :region_names (Array<String>) —

    The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

  • :all_regions (Boolean) —

    Indicates whether to display all Regions, including Regions that are disabled for your account.

  • :dry_run (Boolean) —

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

    The filters.

    • ‘endpoint` - The endpoint of the Region (for example, `ec2.us-east-1.amazonaws.com`).

    • ‘opt-in-status` - The opt-in status of the Region (`opt-in-not-required` | `opted-in` | `not-opted-in`).

    • ‘region-name` - The name of the Region (for example, `us-east-1`).

Returns:

See Also:



31286
31287
31288
31289
 
# File 'lib/aws-sdk-ec2/client.rb', line 31286

def describe_regions(params = {}, options = {})
  req = build_request(:describe_regions, params)
  req.send_request(options)
end

#describe_replace_root_volume_tasks(params = {}) ⇒ Types::DescribeReplaceRootVolumeTasksResult

Describes a root volume replacement task. For more information, see

Replace a root volume][1

in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_replace_root_volume_tasks({
  replace_root_volume_task_ids: ["ReplaceRootVolumeTaskId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  dry_run: false,
})

Response structure


resp.replace_root_volume_tasks #=> Array
resp.replace_root_volume_tasks[0].replace_root_volume_task_id #=> String
resp.replace_root_volume_tasks[0].instance_id #=> String
resp.replace_root_volume_tasks[0].task_state #=> String, one of "pending", "in-progress", "failing", "succeeded", "failed", "failed-detached"
resp.replace_root_volume_tasks[0].start_time #=> String
resp.replace_root_volume_tasks[0].complete_time #=> String
resp.replace_root_volume_tasks[0].tags #=> Array
resp.replace_root_volume_tasks[0].tags[0].key #=> String
resp.replace_root_volume_tasks[0].tags[0].value #=> String
resp.replace_root_volume_tasks[0].image_id #=> String
resp.replace_root_volume_tasks[0].snapshot_id #=> String
resp.replace_root_volume_tasks[0].delete_replaced_root_volume #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :replace_root_volume_task_ids (Array<String>) —

    The ID of the root volume replacement task to view.

  • :filters (Array<Types::Filter>) —

    Filter to use:

    • ‘instance-id` - The ID of the instance for which the root volume replacement task was created.

    ^

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :dry_run (Boolean) —

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

Returns:

See Also:



31370
31371
31372
31373
 
# File 'lib/aws-sdk-ec2/client.rb', line 31370

def describe_replace_root_volume_tasks(params = {}, options = {})
  req = build_request(:describe_replace_root_volume_tasks, params)
  req.send_request(options)
end

#describe_reserved_instances(params = {}) ⇒ Types::DescribeReservedInstancesResult

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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_instances({
  offering_class: "standard", # accepts standard, convertible
  reserved_instances_ids: ["ReservationId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  offering_type: "Heavy Utilization", # accepts Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
})

Response structure


resp.reserved_instances #=> Array
resp.reserved_instances[0].currency_code #=> String, one of "USD"
resp.reserved_instances[0].instance_tenancy #=> String, one of "default", "dedicated", "host"
resp.reserved_instances[0].offering_class #=> String, one of "standard", "convertible"
resp.reserved_instances[0].offering_type #=> String, one of "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront"
resp.reserved_instances[0].recurring_charges #=> Array
resp.reserved_instances[0].recurring_charges[0].amount #=> Float
resp.reserved_instances[0].recurring_charges[0].frequency #=> String, one of "Hourly"
resp.reserved_instances[0].scope #=> String, one of "Availability Zone", "Region"
resp.reserved_instances[0].tags #=> Array
resp.reserved_instances[0].tags[0].key #=> String
resp.reserved_instances[0].tags[0].value #=> String
resp.reserved_instances[0].reserved_instances_id #=> String
resp.reserved_instances[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.reserved_instances[0].availability_zone #=> String
resp.reserved_instances[0].start #=> Time
resp.reserved_instances[0].end #=> Time
resp.reserved_instances[0].duration #=> Integer
resp.reserved_instances[0].usage_price #=> Float
resp.reserved_instances[0].fixed_price #=> Float
resp.reserved_instances[0].instance_count #=> Integer
resp.reserved_instances[0].product_description #=> String, one of "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)"
resp.reserved_instances[0].state #=> String, one of "payment-pending", "active", "payment-failed", "retired", "queued", "queued-deleted"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :offering_class (String) —

    Describes whether the Reserved Instance is Standard or Convertible.

  • :reserved_instances_ids (Array<String>) —

    One or more Reserved Instance IDs.

    Default: Describes all your Reserved Instances, or only those otherwise specified.

  • :dry_run (Boolean) —

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

    One or more filters.

    • ‘availability-zone` - The Availability Zone where the Reserved Instance can be used.

    • ‘duration` - The duration of the Reserved Instance (one year or three years), in seconds (`31536000` | `94608000`).

    • ‘end` - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

    • ‘fixed-price` - The purchase price of the Reserved Instance (for example, 9800.0).

    • ‘instance-type` - The instance type that is covered by the reservation.

    • ‘scope` - The scope of the Reserved Instance (`Region` or `Availability Zone`).

    • ‘product-description` - The Reserved Instance product platform description (`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).

  • :offering_type (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.

Returns:

See Also:



31509
31510
31511
31512
 
# File 'lib/aws-sdk-ec2/client.rb', line 31509

def describe_reserved_instances(params = {}, options = {})
  req = build_request(:describe_reserved_instances, params)
  req.send_request(options)
end

#describe_reserved_instances_listings(params = {}) ⇒ Types::DescribeReservedInstancesListingsResult

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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_instances_listings({
  reserved_instances_id: "ReservationId",
  reserved_instances_listing_id: "ReservedInstancesListingId",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.reserved_instances_listings #=> Array
resp.reserved_instances_listings[0].client_token #=> String
resp.reserved_instances_listings[0].create_date #=> Time
resp.reserved_instances_listings[0].instance_counts #=> Array
resp.reserved_instances_listings[0].instance_counts[0].instance_count #=> Integer
resp.reserved_instances_listings[0].instance_counts[0].state #=> String, one of "available", "sold", "cancelled", "pending"
resp.reserved_instances_listings[0].price_schedules #=> Array
resp.reserved_instances_listings[0].price_schedules[0].active #=> Boolean
resp.reserved_instances_listings[0].price_schedules[0].currency_code #=> String, one of "USD"
resp.reserved_instances_listings[0].price_schedules[0].price #=> Float
resp.reserved_instances_listings[0].price_schedules[0].term #=> Integer
resp.reserved_instances_listings[0].reserved_instances_id #=> String
resp.reserved_instances_listings[0].reserved_instances_listing_id #=> String
resp.reserved_instances_listings[0].status #=> String, one of "active", "pending", "cancelled", "closed"
resp.reserved_instances_listings[0].status_message #=> String
resp.reserved_instances_listings[0].tags #=> Array
resp.reserved_instances_listings[0].tags[0].key #=> String
resp.reserved_instances_listings[0].tags[0].value #=> String
resp.reserved_instances_listings[0].update_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_instances_id (String) —

    One or more Reserved Instance IDs.

  • :reserved_instances_listing_id (String) —

    One or more Reserved Instance listing IDs.

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘reserved-instances-id` - The ID of the Reserved Instances.

    • ‘reserved-instances-listing-id` - The ID of the Reserved Instances listing.

    • ‘status` - The status of the Reserved Instance listing (`pending` | `active` | `cancelled` | `closed`).

    • ‘status-message` - The reason for the status.

Returns:

See Also:



31610
31611
31612
31613
 
# File 'lib/aws-sdk-ec2/client.rb', line 31610

def describe_reserved_instances_listings(params = {}, options = {})
  req = build_request(:describe_reserved_instances_listings, params)
  req.send_request(options)
end

#describe_reserved_instances_modifications(params = {}) ⇒ Types::DescribeReservedInstancesModificationsResult

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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_instances_modifications({
  reserved_instances_modification_ids: ["ReservedInstancesModificationId"],
  next_token: "String",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.reserved_instances_modifications #=> Array
resp.reserved_instances_modifications[0].client_token #=> String
resp.reserved_instances_modifications[0].create_date #=> Time
resp.reserved_instances_modifications[0].effective_date #=> Time
resp.reserved_instances_modifications[0].modification_results #=> Array
resp.reserved_instances_modifications[0].modification_results[0].reserved_instances_id #=> String
resp.reserved_instances_modifications[0].modification_results[0].target_configuration.availability_zone #=> String
resp.reserved_instances_modifications[0].modification_results[0].target_configuration.instance_count #=> Integer
resp.reserved_instances_modifications[0].modification_results[0].target_configuration.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.reserved_instances_modifications[0].modification_results[0].target_configuration.platform #=> String
resp.reserved_instances_modifications[0].modification_results[0].target_configuration.scope #=> String, one of "Availability Zone", "Region"
resp.reserved_instances_modifications[0].reserved_instances_ids #=> Array
resp.reserved_instances_modifications[0].reserved_instances_ids[0].reserved_instances_id #=> String
resp.reserved_instances_modifications[0].reserved_instances_modification_id #=> String
resp.reserved_instances_modifications[0].status #=> String
resp.reserved_instances_modifications[0].status_message #=> String
resp.reserved_instances_modifications[0].update_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_instances_modification_ids (Array<String>) —

    IDs for the submitted modification request.

  • :next_token (String) —

    The token to retrieve the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘client-token` - The idempotency token for the modification request.

    • ‘create-date` - The time when the modification request was created.

    • ‘effective-date` - The time when the modification becomes effective.

    • ‘modification-result.reserved-instances-id` - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is `fulfilled`.

    • ‘modification-result.target-configuration.availability-zone` - The Availability Zone for the new Reserved Instances.

    • ‘modification-result.target-configuration.instance-count ` - The number of new Reserved Instances.

    • ‘modification-result.target-configuration.instance-type` - The instance type of the new Reserved Instances.

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

Returns:

See Also:



31720
31721
31722
31723
 
# File 'lib/aws-sdk-ec2/client.rb', line 31720

def describe_reserved_instances_modifications(params = {}, options = {})
  req = build_request(:describe_reserved_instances_modifications, params)
  req.send_request(options)
end

#describe_reserved_instances_offerings(params = {}) ⇒ Types::DescribeReservedInstancesOfferingsResult

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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_instances_offerings({
  availability_zone: "String",
  include_marketplace: false,
  instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
  max_duration: 1,
  max_instance_count: 1,
  min_duration: 1,
  offering_class: "standard", # accepts standard, convertible
  product_description: "Linux/UNIX", # accepts Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
  reserved_instances_offering_ids: ["ReservedInstancesOfferingId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  instance_tenancy: "default", # accepts default, dedicated, host
  offering_type: "Heavy Utilization", # accepts Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
  next_token: "String",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.reserved_instances_offerings #=> Array
resp.reserved_instances_offerings[0].currency_code #=> String, one of "USD"
resp.reserved_instances_offerings[0].instance_tenancy #=> String, one of "default", "dedicated", "host"
resp.reserved_instances_offerings[0].marketplace #=> Boolean
resp.reserved_instances_offerings[0].offering_class #=> String, one of "standard", "convertible"
resp.reserved_instances_offerings[0].offering_type #=> String, one of "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront"
resp.reserved_instances_offerings[0].pricing_details #=> Array
resp.reserved_instances_offerings[0].pricing_details[0].count #=> Integer
resp.reserved_instances_offerings[0].pricing_details[0].price #=> Float
resp.reserved_instances_offerings[0].recurring_charges #=> Array
resp.reserved_instances_offerings[0].recurring_charges[0].amount #=> Float
resp.reserved_instances_offerings[0].recurring_charges[0].frequency #=> String, one of "Hourly"
resp.reserved_instances_offerings[0].scope #=> String, one of "Availability Zone", "Region"
resp.reserved_instances_offerings[0].reserved_instances_offering_id #=> String
resp.reserved_instances_offerings[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.reserved_instances_offerings[0].availability_zone #=> String
resp.reserved_instances_offerings[0].duration #=> Integer
resp.reserved_instances_offerings[0].usage_price #=> Float
resp.reserved_instances_offerings[0].fixed_price #=> Float
resp.reserved_instances_offerings[0].product_description #=> String, one of "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :availability_zone (String) —

    The Availability Zone in which the Reserved Instance can be used.

  • :include_marketplace (Boolean) —

    Include Reserved Instance Marketplace offerings in the response.

  • :instance_type (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

  • :max_duration (Integer) —

    The maximum duration (in seconds) to filter when searching for offerings.

    Default: 94608000 (3 years)

  • :max_instance_count (Integer) —

    The maximum number of instances to filter when searching for offerings.

    Default: 20

  • :min_duration (Integer) —

    The minimum duration (in seconds) to filter when searching for offerings.

    Default: 2592000 (1 month)

  • :offering_class (String) —

    The offering class of the Reserved Instance. Can be ‘standard` or `convertible`.

  • :product_description (String) —

    The Reserved Instance product platform description. Instances that include ‘(Amazon VPC)` in the description are for use with Amazon VPC.

  • :reserved_instances_offering_ids (Array<String>) —

    One or more Reserved Instances offering IDs.

  • :dry_run (Boolean) —

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

    One or more filters.

    • ‘availability-zone` - The Availability Zone where the Reserved Instance can be used.

    • ‘duration` - The duration of the Reserved Instance (for example, one year or three years), in seconds (`31536000` | `94608000`).

    • ‘fixed-price` - The purchase price of the Reserved Instance (for example, 9800.0).

    • ‘instance-type` - The instance type that is covered by the reservation.

    • ‘marketplace` - Set to `true` to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both 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).

  • :instance_tenancy (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`

  • :offering_type (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.

  • :next_token (String) —

    The token to retrieve the next page of results.

  • :max_results (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

Returns:

See Also:



31922
31923
31924
31925
 
# File 'lib/aws-sdk-ec2/client.rb', line 31922

def describe_reserved_instances_offerings(params = {}, options = {})
  req = build_request(:describe_reserved_instances_offerings, params)
  req.send_request(options)
end

#describe_route_tables(params = {}) ⇒ Types::DescribeRouteTablesResult

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

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe a route table


# This example describes the specified route table.

resp = client.describe_route_tables({
  route_table_ids: [
    "rtb-1f382e7d", 
  ], 
})

resp.to_h outputs the following:
{
  route_tables: [
    {
      associations: [
        {
          main: true, 
          route_table_association_id: "rtbassoc-d8ccddba", 
          route_table_id: "rtb-1f382e7d", 
        }, 
      ], 
      propagating_vgws: [
      ], 
      route_table_id: "rtb-1f382e7d", 
      routes: [
        {
          destination_cidr_block: "10.0.0.0/16", 
          gateway_id: "local", 
          state: "active", 
        }, 
      ], 
      tags: [
      ], 
      vpc_id: "vpc-a01106c2", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_route_tables({
  next_token: "String",
  max_results: 1,
  dry_run: false,
  route_table_ids: ["RouteTableId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.route_tables #=> Array
resp.route_tables[0].associations #=> Array
resp.route_tables[0].associations[0].main #=> Boolean
resp.route_tables[0].associations[0].route_table_association_id #=> String
resp.route_tables[0].associations[0].route_table_id #=> String
resp.route_tables[0].associations[0].subnet_id #=> String
resp.route_tables[0].associations[0].gateway_id #=> String
resp.route_tables[0].associations[0].association_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failed"
resp.route_tables[0].associations[0].association_state.status_message #=> String
resp.route_tables[0].propagating_vgws #=> Array
resp.route_tables[0].propagating_vgws[0].gateway_id #=> String
resp.route_tables[0].route_table_id #=> String
resp.route_tables[0].routes #=> Array
resp.route_tables[0].routes[0].destination_cidr_block #=> String
resp.route_tables[0].routes[0].destination_ipv_6_cidr_block #=> String
resp.route_tables[0].routes[0].destination_prefix_list_id #=> String
resp.route_tables[0].routes[0].egress_only_internet_gateway_id #=> String
resp.route_tables[0].routes[0].gateway_id #=> String
resp.route_tables[0].routes[0].instance_id #=> String
resp.route_tables[0].routes[0].instance_owner_id #=> String
resp.route_tables[0].routes[0].nat_gateway_id #=> String
resp.route_tables[0].routes[0].transit_gateway_id #=> String
resp.route_tables[0].routes[0].local_gateway_id #=> String
resp.route_tables[0].routes[0].carrier_gateway_id #=> String
resp.route_tables[0].routes[0].network_interface_id #=> String
resp.route_tables[0].routes[0].origin #=> String, one of "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation"
resp.route_tables[0].routes[0].state #=> String, one of "active", "blackhole"
resp.route_tables[0].routes[0].vpc_peering_connection_id #=> String
resp.route_tables[0].routes[0].core_network_arn #=> String
resp.route_tables[0].tags #=> Array
resp.route_tables[0].tags[0].key #=> String
resp.route_tables[0].tags[0].value #=> String
resp.route_tables[0].vpc_id #=> String
resp.route_tables[0].owner_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

  • :route_table_ids (Array<String>) —

    The IDs of the route tables.

  • :filters (Array<Types::Filter>) —

    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`:&lt;key&gt; - 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.

Returns:

See Also:



32143
32144
32145
32146
 
# File 'lib/aws-sdk-ec2/client.rb', line 32143

def describe_route_tables(params = {}, options = {})
  req = build_request(:describe_route_tables, params)
  req.send_request(options)
end

#describe_scheduled_instance_availability(params = {}) ⇒ Types::DescribeScheduledInstanceAvailabilityResult

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_scheduled_instance_availability({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  first_slot_start_time_range: { # required
    earliest_time: Time.now, # required
    latest_time: Time.now, # required
  },
  max_results: 1,
  max_slot_duration_in_hours: 1,
  min_slot_duration_in_hours: 1,
  next_token: "String",
  recurrence: { # required
    frequency: "String",
    interval: 1,
    occurrence_days: [1],
    occurrence_relative_to_end: false,
    occurrence_unit: "String",
  },
})

Response structure


resp.next_token #=> String
resp.scheduled_instance_availability_set #=> Array
resp.scheduled_instance_availability_set[0].availability_zone #=> String
resp.scheduled_instance_availability_set[0].available_instance_count #=> Integer
resp.scheduled_instance_availability_set[0].first_slot_start_time #=> Time
resp.scheduled_instance_availability_set[0].hourly_price #=> String
resp.scheduled_instance_availability_set[0].instance_type #=> String
resp.scheduled_instance_availability_set[0].max_term_duration_in_days #=> Integer
resp.scheduled_instance_availability_set[0].min_term_duration_in_days #=> Integer
resp.scheduled_instance_availability_set[0].network_platform #=> String
resp.scheduled_instance_availability_set[0].platform #=> String
resp.scheduled_instance_availability_set[0].purchase_token #=> String
resp.scheduled_instance_availability_set[0].recurrence.frequency #=> String
resp.scheduled_instance_availability_set[0].recurrence.interval #=> Integer
resp.scheduled_instance_availability_set[0].recurrence.occurrence_day_set #=> Array
resp.scheduled_instance_availability_set[0].recurrence.occurrence_day_set[0] #=> Integer
resp.scheduled_instance_availability_set[0].recurrence.occurrence_relative_to_end #=> Boolean
resp.scheduled_instance_availability_set[0].recurrence.occurrence_unit #=> String
resp.scheduled_instance_availability_set[0].slot_duration_in_hours #=> Integer
resp.scheduled_instance_availability_set[0].total_scheduled_instance_hours #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

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

  • :first_slot_start_time_range (required, Types::SlotDateTimeRangeRequest) —

    The time period for the first schedule to start.

  • :max_results (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.

  • :max_slot_duration_in_hours (Integer) —

    The maximum available duration, in hours. This value must be greater than ‘MinSlotDurationInHours` and less than 1,720.

  • :min_slot_duration_in_hours (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.

  • :next_token (String) —

    The token for the next set of results.

  • :recurrence (required, Types::ScheduledInstanceRecurrenceRequest) —

    The schedule recurrence.

Returns:

See Also:



32262
32263
32264
32265
 
# File 'lib/aws-sdk-ec2/client.rb', line 32262

def describe_scheduled_instance_availability(params = {}, options = {})
  req = build_request(:describe_scheduled_instance_availability, params)
  req.send_request(options)
end

#describe_scheduled_instances(params = {}) ⇒ Types::DescribeScheduledInstancesResult

Describes the specified Scheduled Instances or all your Scheduled Instances.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_scheduled_instances({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  scheduled_instance_ids: ["ScheduledInstanceId"],
  slot_start_time_range: {
    earliest_time: Time.now,
    latest_time: Time.now,
  },
})

Response structure


resp.next_token #=> String
resp.scheduled_instance_set #=> Array
resp.scheduled_instance_set[0].availability_zone #=> String
resp.scheduled_instance_set[0].create_date #=> Time
resp.scheduled_instance_set[0].hourly_price #=> String
resp.scheduled_instance_set[0].instance_count #=> Integer
resp.scheduled_instance_set[0].instance_type #=> String
resp.scheduled_instance_set[0].network_platform #=> String
resp.scheduled_instance_set[0].next_slot_start_time #=> Time
resp.scheduled_instance_set[0].platform #=> String
resp.scheduled_instance_set[0].previous_slot_end_time #=> Time
resp.scheduled_instance_set[0].recurrence.frequency #=> String
resp.scheduled_instance_set[0].recurrence.interval #=> Integer
resp.scheduled_instance_set[0].recurrence.occurrence_day_set #=> Array
resp.scheduled_instance_set[0].recurrence.occurrence_day_set[0] #=> Integer
resp.scheduled_instance_set[0].recurrence.occurrence_relative_to_end #=> Boolean
resp.scheduled_instance_set[0].recurrence.occurrence_unit #=> String
resp.scheduled_instance_set[0].scheduled_instance_id #=> String
resp.scheduled_instance_set[0].slot_duration_in_hours #=> Integer
resp.scheduled_instance_set[0].term_end_date #=> Time
resp.scheduled_instance_set[0].term_start_date #=> Time
resp.scheduled_instance_set[0].total_scheduled_instance_hours #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

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

  • :max_results (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.

  • :next_token (String) —

    The token for the next set of results.

  • :scheduled_instance_ids (Array<String>) —

    The Scheduled Instance IDs.

  • :slot_start_time_range (Types::SlotStartTimeRangeRequest) —

    The time period for the first schedule to start.

Returns:

See Also:



32356
32357
32358
32359
 
# File 'lib/aws-sdk-ec2/client.rb', line 32356

def describe_scheduled_instances(params = {}, options = {})
  req = build_request(:describe_scheduled_instances, params)
  req.send_request(options)
end

#describe_security_group_references(params = {}) ⇒ Types::DescribeSecurityGroupReferencesResult

Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you’ve specified in this request.

Examples:

Example: To describe security group references


# This example describes the security group references for the specified security group.

resp = client.describe_security_group_references({
  group_id: [
    "sg-903004f8", 
  ], 
})

resp.to_h outputs the following:
{
  security_group_reference_set: [
    {
      group_id: "sg-903004f8", 
      referencing_vpc_id: "vpc-1a2b3c4d", 
      vpc_peering_connection_id: "pcx-b04deed9", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_security_group_references({
  dry_run: false,
  group_id: ["SecurityGroupId"], # required
})

Response structure


resp.security_group_reference_set #=> Array
resp.security_group_reference_set[0].group_id #=> String
resp.security_group_reference_set[0].referencing_vpc_id #=> String
resp.security_group_reference_set[0].vpc_peering_connection_id #=> String
resp.security_group_reference_set[0].transit_gateway_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :group_id (required, Array<String>) —

    The IDs of the security groups in your account.

Returns:

See Also:



32418
32419
32420
32421
 
# File 'lib/aws-sdk-ec2/client.rb', line 32418

def describe_security_group_references(params = {}, options = {})
  req = build_request(:describe_security_group_references, params)
  req.send_request(options)
end

#describe_security_group_rules(params = {}) ⇒ Types::DescribeSecurityGroupRulesResult

Describes one or more of your security group rules.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_security_group_rules({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  security_group_rule_ids: ["String"],
  dry_run: false,
  next_token: "String",
  max_results: 1,
})

Response structure


resp.security_group_rules #=> Array
resp.security_group_rules[0].security_group_rule_id #=> String
resp.security_group_rules[0].group_id #=> String
resp.security_group_rules[0].group_owner_id #=> String
resp.security_group_rules[0].is_egress #=> Boolean
resp.security_group_rules[0].ip_protocol #=> String
resp.security_group_rules[0].from_port #=> Integer
resp.security_group_rules[0].to_port #=> Integer
resp.security_group_rules[0].cidr_ipv_4 #=> String
resp.security_group_rules[0].cidr_ipv_6 #=> String
resp.security_group_rules[0].prefix_list_id #=> String
resp.security_group_rules[0].referenced_group_info.group_id #=> String
resp.security_group_rules[0].referenced_group_info.peering_status #=> String
resp.security_group_rules[0].referenced_group_info.user_id #=> String
resp.security_group_rules[0].referenced_group_info.vpc_id #=> String
resp.security_group_rules[0].referenced_group_info.vpc_peering_connection_id #=> String
resp.security_group_rules[0].description #=> String
resp.security_group_rules[0].tags #=> Array
resp.security_group_rules[0].tags[0].key #=> String
resp.security_group_rules[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘group-id` - The ID of the security group.

    • ‘security-group-rule-id` - The ID of the security group rule.

    • ‘tag`:&lt;key&gt; - 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.

  • :security_group_rule_ids (Array<String>) —

    The IDs of the security group rules.

  • :dry_run (Boolean) —

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

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



32512
32513
32514
32515
 
# File 'lib/aws-sdk-ec2/client.rb', line 32512

def describe_security_group_rules(params = {}, options = {})
  req = build_request(:describe_security_group_rules, params)
  req.send_request(options)
end

#describe_security_groups(params = {}) ⇒ Types::DescribeSecurityGroupsResult

Describes the specified security groups or all of your security groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* security_group_exists

Examples:

Example: To describe a security group


# This example describes the specified security group.

resp = client.describe_security_groups({
  group_ids: [
    "sg-903004f8", 
  ], 
})

resp.to_h outputs the following:
{
}

Example: To describe a tagged security group


# This example describes the security groups that include the specified tag (Purpose=test).

resp = client.describe_security_groups({
  filters: [
    {
      name: "tag:Purpose", 
      values: [
        "test", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.describe_security_groups({
  group_ids: ["SecurityGroupId"],
  group_names: ["SecurityGroupName"],
  next_token: "String",
  max_results: 1,
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.security_groups #=> Array
resp.security_groups[0].group_id #=> String
resp.security_groups[0].ip_permissions_egress #=> Array
resp.security_groups[0].ip_permissions_egress[0].ip_protocol #=> String
resp.security_groups[0].ip_permissions_egress[0].from_port #=> Integer
resp.security_groups[0].ip_permissions_egress[0].to_port #=> Integer
resp.security_groups[0].ip_permissions_egress[0].user_id_group_pairs #=> Array
resp.security_groups[0].ip_permissions_egress[0].user_id_group_pairs[0].description #=> String
resp.security_groups[0].ip_permissions_egress[0].user_id_group_pairs[0].user_id #=> String
resp.security_groups[0].ip_permissions_egress[0].user_id_group_pairs[0].group_name #=> String
resp.security_groups[0].ip_permissions_egress[0].user_id_group_pairs[0].group_id #=> String
resp.security_groups[0].ip_permissions_egress[0].user_id_group_pairs[0].vpc_id #=> String
resp.security_groups[0].ip_permissions_egress[0].user_id_group_pairs[0].vpc_peering_connection_id #=> String
resp.security_groups[0].ip_permissions_egress[0].user_id_group_pairs[0].peering_status #=> String
resp.security_groups[0].ip_permissions_egress[0].ip_ranges #=> Array
resp.security_groups[0].ip_permissions_egress[0].ip_ranges[0].description #=> String
resp.security_groups[0].ip_permissions_egress[0].ip_ranges[0].cidr_ip #=> String
resp.security_groups[0].ip_permissions_egress[0].ipv_6_ranges #=> Array
resp.security_groups[0].ip_permissions_egress[0].ipv_6_ranges[0].description #=> String
resp.security_groups[0].ip_permissions_egress[0].ipv_6_ranges[0].cidr_ipv_6 #=> String
resp.security_groups[0].ip_permissions_egress[0].prefix_list_ids #=> Array
resp.security_groups[0].ip_permissions_egress[0].prefix_list_ids[0].description #=> String
resp.security_groups[0].ip_permissions_egress[0].prefix_list_ids[0].prefix_list_id #=> String
resp.security_groups[0].tags #=> Array
resp.security_groups[0].tags[0].key #=> String
resp.security_groups[0].tags[0].value #=> String
resp.security_groups[0].vpc_id #=> String
resp.security_groups[0].owner_id #=> String
resp.security_groups[0].group_name #=> String
resp.security_groups[0].description #=> String
resp.security_groups[0].ip_permissions #=> Array
resp.security_groups[0].ip_permissions[0].ip_protocol #=> String
resp.security_groups[0].ip_permissions[0].from_port #=> Integer
resp.security_groups[0].ip_permissions[0].to_port #=> Integer
resp.security_groups[0].ip_permissions[0].user_id_group_pairs #=> Array
resp.security_groups[0].ip_permissions[0].user_id_group_pairs[0].description #=> String
resp.security_groups[0].ip_permissions[0].user_id_group_pairs[0].user_id #=> String
resp.security_groups[0].ip_permissions[0].user_id_group_pairs[0].group_name #=> String
resp.security_groups[0].ip_permissions[0].user_id_group_pairs[0].group_id #=> String
resp.security_groups[0].ip_permissions[0].user_id_group_pairs[0].vpc_id #=> String
resp.security_groups[0].ip_permissions[0].user_id_group_pairs[0].vpc_peering_connection_id #=> String
resp.security_groups[0].ip_permissions[0].user_id_group_pairs[0].peering_status #=> String
resp.security_groups[0].ip_permissions[0].ip_ranges #=> Array
resp.security_groups[0].ip_permissions[0].ip_ranges[0].description #=> String
resp.security_groups[0].ip_permissions[0].ip_ranges[0].cidr_ip #=> String
resp.security_groups[0].ip_permissions[0].ipv_6_ranges #=> Array
resp.security_groups[0].ip_permissions[0].ipv_6_ranges[0].description #=> String
resp.security_groups[0].ip_permissions[0].ipv_6_ranges[0].cidr_ipv_6 #=> String
resp.security_groups[0].ip_permissions[0].prefix_list_ids #=> Array
resp.security_groups[0].ip_permissions[0].prefix_list_ids[0].description #=> String
resp.security_groups[0].ip_permissions[0].prefix_list_ids[0].prefix_list_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_ids (Array<String>) —

    The IDs of the security groups. Required for security groups in a nondefault VPC.

    Default: Describes all of your security groups.

  • :group_names (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.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

    The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

    • ‘description` - The description of the security group.

    • ‘egress.ip-permission.cidr` - An IPv4 CIDR block for an outbound security group rule.

    • ‘egress.ip-permission.from-port` - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

    • ‘egress.ip-permission.group-id` - The ID of a security group that has been referenced in an outbound security group rule.

    • ‘egress.ip-permission.group-name` - The name of a security group that is referenced in an outbound security group rule.

    • ‘egress.ip-permission.ipv6-cidr` - An IPv6 CIDR block for an outbound security group rule.

    • ‘egress.ip-permission.prefix-list-id` - The ID of a prefix list to which a security group rule allows outbound access.

    • ‘egress.ip-permission.protocol` - The IP protocol for an outbound security group rule (`tcp` | `udp` | `icmp`, a protocol number, or -1 for all protocols).

    • ‘egress.ip-permission.to-port` - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

    • ‘egress.ip-permission.user-id` - The ID of an 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`:&lt;key&gt; - 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.

Returns:

See Also:



32757
32758
32759
32760
 
# File 'lib/aws-sdk-ec2/client.rb', line 32757

def describe_security_groups(params = {}, options = {})
  req = build_request(:describe_security_groups, params)
  req.send_request(options)
end

#describe_snapshot_attribute(params = {}) ⇒ Types::DescribeSnapshotAttributeResult

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

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshots.html

Examples:

Example: To describe snapshot attributes


# This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of
# ``snap-066877671789bd71b``.

resp = client.describe_snapshot_attribute({
  attribute: "createVolumePermission", 
  snapshot_id: "snap-066877671789bd71b", 
})

resp.to_h outputs the following:
{
  create_volume_permissions: [
  ], 
  snapshot_id: "snap-066877671789bd71b", 
}

Request syntax with placeholder values


resp = client.describe_snapshot_attribute({
  attribute: "productCodes", # required, accepts productCodes, createVolumePermission
  snapshot_id: "SnapshotId", # required
  dry_run: false,
})

Response structure


resp.product_codes #=> Array
resp.product_codes[0].product_code_id #=> String
resp.product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"
resp.snapshot_id #=> String
resp.create_volume_permissions #=> Array
resp.create_volume_permissions[0].user_id #=> String
resp.create_volume_permissions[0].group #=> String, one of "all"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute (required, String) —

    The snapshot attribute you would like to view.

  • :snapshot_id (required, String) —

    The ID of the EBS snapshot.

  • :dry_run (Boolean) —

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

Returns:

See Also:



32830
32831
32832
32833
 
# File 'lib/aws-sdk-ec2/client.rb', line 32830

def describe_snapshot_attribute(params = {}, options = {})
  req = build_request(:describe_snapshot_attribute, params)
  req.send_request(options)
end

#describe_snapshot_tier_status(params = {}) ⇒ Types::DescribeSnapshotTierStatusResult

Describes the storage tier status of one or more Amazon EBS snapshots.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_snapshot_tier_status({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  next_token: "String",
  max_results: 1,
})

Response structure


resp.snapshot_tier_statuses #=> Array
resp.snapshot_tier_statuses[0].snapshot_id #=> String
resp.snapshot_tier_statuses[0].volume_id #=> String
resp.snapshot_tier_statuses[0].status #=> String, one of "pending", "completed", "error", "recoverable", "recovering"
resp.snapshot_tier_statuses[0].owner_id #=> String
resp.snapshot_tier_statuses[0].tags #=> Array
resp.snapshot_tier_statuses[0].tags[0].key #=> String
resp.snapshot_tier_statuses[0].tags[0].value #=> String
resp.snapshot_tier_statuses[0].storage_tier #=> String, one of "archive", "standard"
resp.snapshot_tier_statuses[0].last_tiering_start_time #=> Time
resp.snapshot_tier_statuses[0].last_tiering_progress #=> Integer
resp.snapshot_tier_statuses[0].last_tiering_operation_status #=> String, one of "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"
resp.snapshot_tier_statuses[0].last_tiering_operation_status_detail #=> String
resp.snapshot_tier_statuses[0].archival_complete_time #=> Time
resp.snapshot_tier_statuses[0].restore_expiry_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

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

  • :dry_run (Boolean) —

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

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



32914
32915
32916
32917
 
# File 'lib/aws-sdk-ec2/client.rb', line 32914

def describe_snapshot_tier_status(params = {}, options = {})
  req = build_request(:describe_snapshot_tier_status, params)
  req.send_request(options)
end

#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResult

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination [2]: docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshots.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* snapshot_completed

Examples:

Example: To describe a snapshot


# This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``.

resp = client.describe_snapshots({
  snapshot_ids: [
    "snap-1234567890abcdef0", 
  ], 
})

resp.to_h outputs the following:
{
  next_token: "", 
  snapshots: [
    {
      description: "This is my snapshot.", 
      owner_id: "012345678910", 
      progress: "100%", 
      snapshot_id: "snap-1234567890abcdef0", 
      start_time: Time.parse("2014-02-28T21:28:32.000Z"), 
      state: "completed", 
      volume_id: "vol-049df61146c4d7901", 
      volume_size: 8, 
    }, 
  ], 
}

Example: To describe snapshots using filters


# This example describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status.

resp = client.describe_snapshots({
  filters: [
    {
      name: "status", 
      values: [
        "pending", 
      ], 
    }, 
  ], 
  owner_ids: [
    "012345678910", 
  ], 
})

resp.to_h outputs the following:
{
  next_token: "", 
  snapshots: [
    {
      description: "This is my copied snapshot.", 
      owner_id: "012345678910", 
      progress: "87%", 
      snapshot_id: "snap-066877671789bd71b", 
      start_time: Time.parse("2014-02-28T21:37:27.000Z"), 
      state: "pending", 
      volume_id: "vol-1234567890abcdef0", 
      volume_size: 8, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_snapshots({
  max_results: 1,
  next_token: "String",
  owner_ids: ["String"],
  restorable_by_user_ids: ["String"],
  snapshot_ids: ["SnapshotId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.snapshots #=> Array
resp.snapshots[0].owner_alias #=> String
resp.snapshots[0].outpost_arn #=> String
resp.snapshots[0].tags #=> Array
resp.snapshots[0].tags[0].key #=> String
resp.snapshots[0].tags[0].value #=> String
resp.snapshots[0].storage_tier #=> String, one of "archive", "standard"
resp.snapshots[0].restore_expiry_time #=> Time
resp.snapshots[0].sse_type #=> String, one of "sse-ebs", "sse-kms", "none"
resp.snapshots[0].snapshot_id #=> String
resp.snapshots[0].volume_id #=> String
resp.snapshots[0].state #=> String, one of "pending", "completed", "error", "recoverable", "recovering"
resp.snapshots[0].state_message #=> String
resp.snapshots[0].start_time #=> Time
resp.snapshots[0].progress #=> String
resp.snapshots[0].owner_id #=> String
resp.snapshots[0].description #=> String
resp.snapshots[0].volume_size #=> Integer
resp.snapshots[0].encrypted #=> Boolean
resp.snapshots[0].kms_key_id #=> String
resp.snapshots[0].data_encryption_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :owner_ids (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`.

  • :restorable_by_user_ids (Array<String>) —

    The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

  • :snapshot_ids (Array<String>) —

    The snapshot IDs.

    Default: Describes the snapshots for which you have create volume permissions.

  • :dry_run (Boolean) —

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

    The filters.

    • ‘description` - A description of the snapshot.

    • ‘encrypted` - Indicates whether the snapshot is encrypted (`true` | `false`)

    • ‘owner-alias` - The owner alias, from an Amazon-maintained list (`amazon`). This is not the user-configured 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`:&lt;key&gt; - 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.

Returns:

See Also:



33178
33179
33180
33181
 
# File 'lib/aws-sdk-ec2/client.rb', line 33178

def describe_snapshots(params = {}, options = {})
  req = build_request(:describe_snapshots, params)
  req.send_request(options)
end

#describe_spot_datafeed_subscription(params = {}) ⇒ Types::DescribeSpotDatafeedSubscriptionResult

Describes the data feed for Spot Instances. For more information, see

Spot Instance data feed][1

in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html

Examples:

Example: To describe the datafeed for your AWS account


# This example describes the Spot Instance datafeed subscription for your AWS account.

resp = client.describe_spot_datafeed_subscription({
})

resp.to_h outputs the following:
{
  spot_datafeed_subscription: {
    bucket: "my-s3-bucket", 
    owner_id: "123456789012", 
    prefix: "spotdata", 
    state: "Active", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_spot_datafeed_subscription({
  dry_run: false,
})

Response structure


resp.spot_datafeed_subscription.bucket #=> String
resp.spot_datafeed_subscription.fault.code #=> String
resp.spot_datafeed_subscription.fault.message #=> String
resp.spot_datafeed_subscription.owner_id #=> String
resp.spot_datafeed_subscription.prefix #=> String
resp.spot_datafeed_subscription.state #=> String, one of "Active", "Inactive"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



33237
33238
33239
33240
 
# File 'lib/aws-sdk-ec2/client.rb', line 33237

def describe_spot_datafeed_subscription(params = {}, options = {})
  req = build_request(:describe_spot_datafeed_subscription, params)
  req.send_request(options)
end

#describe_spot_fleet_instances(params = {}) ⇒ Types::DescribeSpotFleetInstancesResponse

Describes the running instances for the specified Spot Fleet.

Examples:

Example: To describe the Spot Instances associated with a Spot fleet


# This example lists the Spot Instances associated with the specified Spot fleet.

resp = client.describe_spot_fleet_instances({
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
})

resp.to_h outputs the following:
{
  active_instances: [
    {
      instance_id: "i-1234567890abcdef0", 
      instance_type: "m3.medium", 
      spot_instance_request_id: "sir-08b93456", 
    }, 
  ], 
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
}

Request syntax with placeholder values


resp = client.describe_spot_fleet_instances({
  dry_run: false,
  spot_fleet_request_id: "SpotFleetRequestId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.active_instances #=> Array
resp.active_instances[0].instance_id #=> String
resp.active_instances[0].instance_type #=> String
resp.active_instances[0].spot_instance_request_id #=> String
resp.active_instances[0].instance_health #=> String, one of "healthy", "unhealthy"
resp.next_token #=> String
resp.spot_fleet_request_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :spot_fleet_request_id (required, String) —

    The ID of the Spot Fleet request.

  • :next_token (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.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



33316
33317
33318
33319
 
# File 'lib/aws-sdk-ec2/client.rb', line 33316

def describe_spot_fleet_instances(params = {}, options = {})
  req = build_request(:describe_spot_fleet_instances, params)
  req.send_request(options)
end

#describe_spot_fleet_request_history(params = {}) ⇒ Types::DescribeSpotFleetRequestHistoryResponse

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html

Examples:

Example: To describe Spot fleet history


# This example returns the history for the specified Spot fleet starting at the specified time.

resp = client.describe_spot_fleet_request_history({
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
  start_time: Time.parse("2015-05-26T00:00:00Z"), 
})

resp.to_h outputs the following:
{
  history_records: [
    {
      event_information: {
        event_sub_type: "submitted", 
      }, 
      event_type: "fleetRequestChange", 
      timestamp: Time.parse("2015-05-26T23:17:20.697Z"), 
    }, 
    {
      event_information: {
        event_sub_type: "active", 
      }, 
      event_type: "fleetRequestChange", 
      timestamp: Time.parse("2015-05-26T23:17:20.873Z"), 
    }, 
    {
      event_information: {
        event_sub_type: "launched", 
        instance_id: "i-1234567890abcdef0", 
      }, 
      event_type: "instanceChange", 
      timestamp: Time.parse("2015-05-26T23:21:21.712Z"), 
    }, 
    {
      event_information: {
        event_sub_type: "launched", 
        instance_id: "i-1234567890abcdef1", 
      }, 
      event_type: "instanceChange", 
      timestamp: Time.parse("2015-05-26T23:21:21.816Z"), 
    }, 
  ], 
  next_token: "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=", 
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
  start_time: Time.parse("2015-05-26T00:00:00Z"), 
}

Request syntax with placeholder values


resp = client.describe_spot_fleet_request_history({
  dry_run: false,
  spot_fleet_request_id: "SpotFleetRequestId", # required
  event_type: "instanceChange", # accepts instanceChange, fleetRequestChange, error, information
  start_time: Time.now, # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.history_records #=> Array
resp.history_records[0].event_information.event_description #=> String
resp.history_records[0].event_information.event_sub_type #=> String
resp.history_records[0].event_information.instance_id #=> String
resp.history_records[0].event_type #=> String, one of "instanceChange", "fleetRequestChange", "error", "information"
resp.history_records[0].timestamp #=> Time
resp.last_evaluated_time #=> Time
resp.next_token #=> String
resp.spot_fleet_request_id #=> String
resp.start_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :spot_fleet_request_id (required, String) —

    The ID of the Spot Fleet request.

  • :event_type (String) —

    The type of events to describe. By default, all events are described.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The starting date and time for the events, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z).

  • :next_token (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.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



33450
33451
33452
33453
 
# File 'lib/aws-sdk-ec2/client.rb', line 33450

def describe_spot_fleet_request_history(params = {}, options = {})
  req = build_request(:describe_spot_fleet_request_history, params)
  req.send_request(options)
end

#describe_spot_fleet_requests(params = {}) ⇒ Types::DescribeSpotFleetRequestsResponse

Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe a Spot fleet request


# This example describes the specified Spot fleet request.

resp = client.describe_spot_fleet_requests({
  spot_fleet_request_ids: [
    "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
  ], 
})

resp.to_h outputs the following:
{
  spot_fleet_request_configs: [
    {
      spot_fleet_request_config: {
        iam_fleet_role: "arn:aws:iam::123456789012:role/my-spot-fleet-role", 
        launch_specifications: [
          {
            ebs_optimized: false, 
            image_id: "ami-1a2b3c4d", 
            instance_type: "cc2.8xlarge", 
            network_interfaces: [
              {
                associate_public_ip_address: true, 
                delete_on_termination: false, 
                device_index: 0, 
                secondary_private_ip_address_count: 0, 
                subnet_id: "subnet-a61dafcf", 
              }, 
            ], 
          }, 
          {
            ebs_optimized: false, 
            image_id: "ami-1a2b3c4d", 
            instance_type: "r3.8xlarge", 
            network_interfaces: [
              {
                associate_public_ip_address: true, 
                delete_on_termination: false, 
                device_index: 0, 
                secondary_private_ip_address_count: 0, 
                subnet_id: "subnet-a61dafcf", 
              }, 
            ], 
          }, 
        ], 
        spot_price: "0.05", 
        target_capacity: 20, 
      }, 
      spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
      spot_fleet_request_state: "active", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_spot_fleet_requests({
  dry_run: false,
  spot_fleet_request_ids: ["SpotFleetRequestId"],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.spot_fleet_request_configs #=> Array
resp.spot_fleet_request_configs[0].activity_status #=> String, one of "error", "pending_fulfillment", "pending_termination", "fulfilled"
resp.spot_fleet_request_configs[0].create_time #=> Time
resp.spot_fleet_request_configs[0].spot_fleet_request_config.allocation_strategy #=> String, one of "lowestPrice", "diversified", "capacityOptimized", "capacityOptimizedPrioritized", "priceCapacityOptimized"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.on_demand_allocation_strategy #=> String, one of "lowestPrice", "prioritized"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.spot_maintenance_strategies.capacity_rebalance.replacement_strategy #=> String, one of "launch", "launch-before-terminate"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.spot_maintenance_strategies.capacity_rebalance.termination_delay #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.client_token #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.excess_capacity_termination_policy #=> String, one of "noTermination", "default"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.fulfilled_capacity #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.on_demand_fulfilled_capacity #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.iam_fleet_role #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].addressing_type #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].ebs.iops #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].ebs.snapshot_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].ebs.volume_size #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].ebs.kms_key_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].ebs.throughput #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].ebs.outpost_arn #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].ebs.encrypted #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].no_device #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].device_name #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].block_device_mappings[0].virtual_name #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].ebs_optimized #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].iam_instance_profile.arn #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].iam_instance_profile.name #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].image_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].kernel_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].key_name #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].monitoring.enabled #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].associate_public_ip_address #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].delete_on_termination #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].description #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].device_index #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].groups #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].groups[0] #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_6_address_count #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_6_addresses #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_6_addresses[0].ipv_6_address #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].network_interface_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].private_ip_address #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].private_ip_addresses #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].private_ip_addresses[0].primary #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].secondary_private_ip_address_count #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].subnet_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].associate_carrier_ip_address #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].interface_type #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].network_card_index #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_4_prefixes #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_4_prefix_count #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_6_prefixes #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ipv_6_prefix_count #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].primary_ipv_6 #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ena_srd_specification.ena_srd_enabled #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].connection_tracking_specification.tcp_established_timeout #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].connection_tracking_specification.udp_stream_timeout #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].network_interfaces[0].connection_tracking_specification.udp_timeout #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].placement.availability_zone #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].placement.group_name #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].placement.tenancy #=> String, one of "default", "dedicated", "host"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].ramdisk_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].spot_price #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].subnet_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].user_data #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].weighted_capacity #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].tag_specifications #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].tag_specifications[0].resource_type #=> String, one of "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"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].tag_specifications[0].tags #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].tag_specifications[0].tags[0].key #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].tag_specifications[0].tags[0].value #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.v_cpu_count.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.v_cpu_count.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.memory_mi_b.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.memory_mi_b.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.cpu_manufacturers #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.excluded_instance_types #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.excluded_instance_types[0] #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.instance_generations #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.require_hibernate_support #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.network_interface_count.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.network_interface_count.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.local_storage_types #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.total_local_storage_gb.min #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.total_local_storage_gb.max #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_types #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_count.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_count.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_manufacturers #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_names #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.network_bandwidth_gbps.min #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.network_bandwidth_gbps.max #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.allowed_instance_types #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.allowed_instance_types[0] #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].security_groups #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].security_groups[0].group_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_specifications[0].security_groups[0].group_name #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].launch_template_specification.launch_template_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].launch_template_specification.launch_template_name #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].launch_template_specification.version #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].spot_price #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].subnet_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].availability_zone #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].weighted_capacity #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].priority #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.v_cpu_count.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.v_cpu_count.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.memory_mi_b.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.memory_mi_b.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.cpu_manufacturers #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.excluded_instance_types #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.excluded_instance_types[0] #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.instance_generations #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.require_hibernate_support #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.network_interface_count.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.network_interface_count.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.local_storage_types #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.total_local_storage_gb.min #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.total_local_storage_gb.max #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_types #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_count.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_count.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_manufacturers #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_names #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.network_bandwidth_gbps.min #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.network_bandwidth_gbps.max #=> Float
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.allowed_instance_types #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.allowed_instance_types[0] #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.launch_template_configs[0].overrides[0].instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.spot_price #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.target_capacity #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.on_demand_target_capacity #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.on_demand_max_total_price #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.spot_max_total_price #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.terminate_instances_with_expiration #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.type #=> String, one of "request", "maintain", "instant"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.valid_from #=> Time
resp.spot_fleet_request_configs[0].spot_fleet_request_config.valid_until #=> Time
resp.spot_fleet_request_configs[0].spot_fleet_request_config.replace_unhealthy_instances #=> Boolean
resp.spot_fleet_request_configs[0].spot_fleet_request_config.instance_interruption_behavior #=> String, one of "hibernate", "stop", "terminate"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.load_balancers_config.classic_load_balancers_config.classic_load_balancers #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.load_balancers_config.classic_load_balancers_config.classic_load_balancers[0].name #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.load_balancers_config.target_groups_config.target_groups #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.load_balancers_config.target_groups_config.target_groups[0].arn #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.instance_pools_to_use_count #=> Integer
resp.spot_fleet_request_configs[0].spot_fleet_request_config.context #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.target_capacity_unit_type #=> String, one of "vcpu", "memory-mib", "units"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.tag_specifications #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.tag_specifications[0].resource_type #=> String, one of "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"
resp.spot_fleet_request_configs[0].spot_fleet_request_config.tag_specifications[0].tags #=> Array
resp.spot_fleet_request_configs[0].spot_fleet_request_config.tag_specifications[0].tags[0].key #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_config.tag_specifications[0].tags[0].value #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_id #=> String
resp.spot_fleet_request_configs[0].spot_fleet_request_state #=> String, one of "submitted", "active", "cancelled", "failed", "cancelled_running", "cancelled_terminating", "modifying"
resp.spot_fleet_request_configs[0].tags #=> Array
resp.spot_fleet_request_configs[0].tags[0].key #=> String
resp.spot_fleet_request_configs[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :spot_fleet_request_ids (Array<String>) —

    The IDs of the Spot Fleet requests.

  • :next_token (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.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



33767
33768
33769
33770
 
# File 'lib/aws-sdk-ec2/client.rb', line 33767

def describe_spot_fleet_requests(params = {}, options = {})
  req = build_request(:describe_spot_fleet_requests, params)
  req.send_request(options)
end

#describe_spot_instance_requests(params = {}) ⇒ Types::DescribeSpotInstanceRequestsResult

Describes the specified Spot Instance requests.

You can use ‘DescribeSpotInstanceRequests` to find a running Spot Instance by examining the response. If the status of the Spot Instance is `fulfilled`, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use

DescribeInstances][1

with a filter to look for instances where the

instance lifecycle is ‘spot`.

We recommend that you set ‘MaxResults` to a value between 5 and 1000 to limit the number of items returned. This paginates the output, which makes the list more manageable and returns the items faster. If the list of items exceeds your `MaxResults` value, then that number of items is returned along with a `NextToken` value that can be passed to a subsequent `DescribeSpotInstanceRequests` request to retrieve the remaining items.

Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* spot_instance_request_fulfilled

Examples:

Example: To describe a Spot Instance request


# This example describes the specified Spot Instance request.

resp = client.describe_spot_instance_requests({
  spot_instance_request_ids: [
    "sir-08b93456", 
  ], 
})

resp.to_h outputs the following:
{
  spot_instance_requests: [
    {
      create_time: Time.parse("2014-04-30T18:14:55.000Z"), 
      instance_id: "i-1234567890abcdef0", 
      launch_specification: {
        block_device_mappings: [
          {
            device_name: "/dev/sda1", 
            ebs: {
              delete_on_termination: true, 
              volume_size: 8, 
              volume_type: "standard", 
            }, 
          }, 
        ], 
        ebs_optimized: false, 
        image_id: "ami-7aba833f", 
        instance_type: "m1.small", 
        key_name: "my-key-pair", 
        security_groups: [
          {
            group_id: "sg-e38f24a7", 
            group_name: "my-security-group", 
          }, 
        ], 
      }, 
      launched_availability_zone: "us-west-1b", 
      product_description: "Linux/UNIX", 
      spot_instance_request_id: "sir-08b93456", 
      spot_price: "0.010000", 
      state: "active", 
      status: {
        code: "fulfilled", 
        message: "Your Spot request is fulfilled.", 
        update_time: Time.parse("2014-04-30T18:16:21.000Z"), 
      }, 
      type: "one-time", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_spot_instance_requests({
  next_token: "String",
  max_results: 1,
  dry_run: false,
  spot_instance_request_ids: ["SpotInstanceRequestId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.spot_instance_requests #=> Array
resp.spot_instance_requests[0].actual_block_hourly_price #=> String
resp.spot_instance_requests[0].availability_zone_group #=> String
resp.spot_instance_requests[0].block_duration_minutes #=> Integer
resp.spot_instance_requests[0].create_time #=> Time
resp.spot_instance_requests[0].fault.code #=> String
resp.spot_instance_requests[0].fault.message #=> String
resp.spot_instance_requests[0].instance_id #=> String
resp.spot_instance_requests[0].launch_group #=> String
resp.spot_instance_requests[0].launch_specification.user_data #=> String
resp.spot_instance_requests[0].launch_specification.addressing_type #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings #=> Array
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.iops #=> Integer
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.snapshot_id #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.volume_size #=> Integer
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.kms_key_id #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.throughput #=> Integer
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.outpost_arn #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.encrypted #=> Boolean
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].no_device #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].device_name #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].virtual_name #=> String
resp.spot_instance_requests[0].launch_specification.ebs_optimized #=> Boolean
resp.spot_instance_requests[0].launch_specification.iam_instance_profile.arn #=> String
resp.spot_instance_requests[0].launch_specification.iam_instance_profile.name #=> String
resp.spot_instance_requests[0].launch_specification.image_id #=> String
resp.spot_instance_requests[0].launch_specification.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.spot_instance_requests[0].launch_specification.kernel_id #=> String
resp.spot_instance_requests[0].launch_specification.key_name #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].associate_public_ip_address #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].delete_on_termination #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].description #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].device_index #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].groups #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].groups[0] #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_address_count #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_addresses #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_addresses[0].ipv_6_address #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].network_interface_id #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].private_ip_address #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].private_ip_addresses #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].private_ip_addresses[0].primary #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].secondary_private_ip_address_count #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].subnet_id #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].associate_carrier_ip_address #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].interface_type #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].network_card_index #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_4_prefixes #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_4_prefix_count #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_prefixes #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_prefix_count #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].primary_ipv_6 #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ena_srd_specification.ena_srd_enabled #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].connection_tracking_specification.tcp_established_timeout #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].connection_tracking_specification.udp_stream_timeout #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].connection_tracking_specification.udp_timeout #=> Integer
resp.spot_instance_requests[0].launch_specification.placement.availability_zone #=> String
resp.spot_instance_requests[0].launch_specification.placement.group_name #=> String
resp.spot_instance_requests[0].launch_specification.placement.tenancy #=> String, one of "default", "dedicated", "host"
resp.spot_instance_requests[0].launch_specification.ramdisk_id #=> String
resp.spot_instance_requests[0].launch_specification.subnet_id #=> String
resp.spot_instance_requests[0].launch_specification.security_groups #=> Array
resp.spot_instance_requests[0].launch_specification.security_groups[0].group_id #=> String
resp.spot_instance_requests[0].launch_specification.security_groups[0].group_name #=> String
resp.spot_instance_requests[0].launch_specification.monitoring.enabled #=> Boolean
resp.spot_instance_requests[0].launched_availability_zone #=> String
resp.spot_instance_requests[0].product_description #=> String, one of "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)"
resp.spot_instance_requests[0].spot_instance_request_id #=> String
resp.spot_instance_requests[0].spot_price #=> String
resp.spot_instance_requests[0].state #=> String, one of "open", "active", "closed", "cancelled", "failed", "disabled"
resp.spot_instance_requests[0].status.code #=> String
resp.spot_instance_requests[0].status.message #=> String
resp.spot_instance_requests[0].status.update_time #=> Time
resp.spot_instance_requests[0].tags #=> Array
resp.spot_instance_requests[0].tags[0].key #=> String
resp.spot_instance_requests[0].tags[0].value #=> String
resp.spot_instance_requests[0].type #=> String, one of "one-time", "persistent"
resp.spot_instance_requests[0].valid_from #=> Time
resp.spot_instance_requests[0].valid_until #=> Time
resp.spot_instance_requests[0].instance_interruption_behavior #=> String, one of "hibernate", "stop", "terminate"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

  • :spot_instance_request_ids (Array<String>) —

    The IDs of the Spot Instance requests.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘availability-zone-group` - The Availability Zone group.

    • ‘create-time` - The time stamp when the Spot Instance request was created.

    • ‘fault-code` - The fault code related to the request.

    • ‘fault-message` - The fault message related to the request.

    • ‘instance-id` - The ID of the instance that fulfilled the request.

    • ‘launch-group` - The Spot Instance launch group.

    • ‘launch.block-device-mapping.delete-on-termination` - Indicates whether the EBS volume is deleted on instance termination.

    • ‘launch.block-device-mapping.device-name` - The device name for the volume in the block device mapping (for example, `/dev/sdh` or `xvdh`).

    • ‘launch.block-device-mapping.snapshot-id` - The ID of the snapshot for the EBS volume.

    • ‘launch.block-device-mapping.volume-size` - The size of the EBS volume, in GiB.

    • ‘launch.block-device-mapping.volume-type` - The type of EBS volume: `gp2` or `gp3` for General Purpose SSD, `io1` or `io2` for Provisioned IOPS SSD, `st1` for Throughput Optimized HDD, `sc1` for Cold HDD, or `standard` for Magnetic.

    • ‘launch.group-id` - The ID of the security group for the instance.

    • ‘launch.group-name` - The name of the security group for the instance.

    • ‘launch.image-id` - The ID of the AMI.

    • ‘launch.instance-type` - The type of instance (for example, `m3.medium`).

    • ‘launch.kernel-id` - The kernel ID.

    • ‘launch.key-name` - The name of the key pair the instance launched with.

    • ‘launch.monitoring-enabled` - Whether detailed monitoring is enabled for the Spot Instance.

    • ‘launch.ramdisk-id` - The RAM disk ID.

    • ‘launched-availability-zone` - The Availability Zone in which the request is launched.

    • ‘network-interface.addresses.primary` - Indicates whether the IP address is the primary private IP address.

    • ‘network-interface.delete-on-termination` - Indicates whether the network interface is deleted when the instance is terminated.

    • ‘network-interface.description` - A description of the network interface.

    • ‘network-interface.device-index` - The index of the device for the network interface attachment on the instance.

    • ‘network-interface.group-id` - The ID of the security group associated with the network interface.

    • ‘network-interface.network-interface-id` - The ID of the network interface.

    • ‘network-interface.private-ip-address` - The primary private IP address of the network interface.

    • ‘network-interface.subnet-id` - The ID of the subnet for the instance.

    • ‘product-description` - The product description associated with the instance (`Linux/UNIX` | `Windows`).

    • ‘spot-instance-request-id` - The Spot Instance request ID.

    • ‘spot-price` - The maximum hourly price for any Spot Instance launched to fulfill the request.

    • ‘state` - The state of the Spot Instance request (`open` | `active` | `closed` | `cancelled` | `failed`). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see [Spot request status] in the *Amazon EC2 User Guide*.

    • ‘status-code` - The short code describing the most recent evaluation of your Spot Instance request.

    • ‘status-message` - The message explaining the status of the Spot Instance request.

    • ‘tag:<key>` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • ‘type` - The type of Spot Instance request (`one-time` | `persistent`).

    • ‘valid-from` - The start date of the request.

    • ‘valid-until` - The end date of the request.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html

Returns:

See Also:



34117
34118
34119
34120
 
# File 'lib/aws-sdk-ec2/client.rb', line 34117

def describe_spot_instance_requests(params = {}, options = {})
  req = build_request(:describe_spot_instance_requests, params)
  req.send_request(options)
end

#describe_spot_price_history(params = {}) ⇒ Types::DescribeSpotPriceHistoryResult

Describes the Spot price history. For more information, see [Spot Instance pricing history] in the *Amazon EC2 User Guide*.

When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe Spot price history for Linux/UNIX (Amazon VPC)


# This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in
# January.

resp = client.describe_spot_price_history({
  end_time: Time.parse("2014-01-06T08:09:10.05Z"), 
  instance_types: [
    "m1.xlarge", 
  ], 
  product_descriptions: [
    "Linux/UNIX (Amazon VPC)", 
  ], 
  start_time: Time.parse("2014-01-06T07:08:09.05Z"), 
})

resp.to_h outputs the following:
{
  spot_price_history: [
    {
      availability_zone: "us-west-1a", 
      instance_type: "m1.xlarge", 
      product_description: "Linux/UNIX (Amazon VPC)", 
      spot_price: "0.080000", 
      timestamp: Time.parse("2014-01-06T04:32:53.000Z"), 
    }, 
    {
      availability_zone: "us-west-1c", 
      instance_type: "m1.xlarge", 
      product_description: "Linux/UNIX (Amazon VPC)", 
      spot_price: "0.080000", 
      timestamp: Time.parse("2014-01-05T11:28:26.000Z"), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_spot_price_history({
  dry_run: false,
  start_time: Time.now,
  end_time: Time.now,
  instance_types: ["a1.medium"], # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
  product_descriptions: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  availability_zone: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.spot_price_history #=> Array
resp.spot_price_history[0].availability_zone #=> String
resp.spot_price_history[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.spot_price_history[0].product_description #=> String, one of "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)"
resp.spot_price_history[0].spot_price #=> String
resp.spot_price_history[0].timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :start_time (Time, DateTime, Date, Integer, String) —

    The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z).

  • :end_time (Time, DateTime, Date, Integer, String) —

    The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z).

  • :instance_types (Array<String>) —

    Filters the results by the specified instance types.

  • :product_descriptions (Array<String>) —

    Filters the results by the specified basic product descriptions.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘availability-zone` - The Availability Zone for which prices should be returned.

    • ‘instance-type` - The type of instance (for example, `m3.medium`).

    • ‘product-description` - The product description for the Spot price (`Linux/UNIX` | `Red Hat Enterprise Linux` | `SUSE Linux` | `Windows` | `Linux/UNIX (Amazon VPC)` | `Red Hat Enterprise Linux (Amazon VPC)` | `SUSE Linux (Amazon VPC)` | `Windows (Amazon VPC)`).

    • ‘spot-price` - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

    • ‘timestamp` - The time stamp of the Spot price history, in UTC format (for example, *ddd MMM dd HH*:mm:ss UTC YYYY). You can use wildcards (`*` and `?`). Greater than or less than comparison is not supported.

  • :availability_zone (String) —

    Filters the results by the specified Availability Zone.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



34271
34272
34273
34274
 
# File 'lib/aws-sdk-ec2/client.rb', line 34271

def describe_spot_price_history(params = {}, options = {})
  req = build_request(:describe_spot_price_history, params)
  req.send_request(options)
end

#describe_stale_security_groups(params = {}) ⇒ Types::DescribeStaleSecurityGroupsResult

Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peered VPC. Rules can also be stale if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_stale_security_groups({
  dry_run: false,
  max_results: 1,
  next_token: "DescribeStaleSecurityGroupsNextToken",
  vpc_id: "VpcId", # required
})

Response structure


resp.next_token #=> String
resp.stale_security_group_set #=> Array
resp.stale_security_group_set[0].description #=> String
resp.stale_security_group_set[0].group_id #=> String
resp.stale_security_group_set[0].group_name #=> String
resp.stale_security_group_set[0].stale_ip_permissions #=> Array
resp.stale_security_group_set[0].stale_ip_permissions[0].from_port #=> Integer
resp.stale_security_group_set[0].stale_ip_permissions[0].ip_protocol #=> String
resp.stale_security_group_set[0].stale_ip_permissions[0].ip_ranges #=> Array
resp.stale_security_group_set[0].stale_ip_permissions[0].ip_ranges[0] #=> String
resp.stale_security_group_set[0].stale_ip_permissions[0].prefix_list_ids #=> Array
resp.stale_security_group_set[0].stale_ip_permissions[0].prefix_list_ids[0] #=> String
resp.stale_security_group_set[0].stale_ip_permissions[0].to_port #=> Integer
resp.stale_security_group_set[0].stale_ip_permissions[0].user_id_group_pairs #=> Array
resp.stale_security_group_set[0].stale_ip_permissions[0].user_id_group_pairs[0].description #=> String
resp.stale_security_group_set[0].stale_ip_permissions[0].user_id_group_pairs[0].user_id #=> String
resp.stale_security_group_set[0].stale_ip_permissions[0].user_id_group_pairs[0].group_name #=> String
resp.stale_security_group_set[0].stale_ip_permissions[0].user_id_group_pairs[0].group_id #=> String
resp.stale_security_group_set[0].stale_ip_permissions[0].user_id_group_pairs[0].vpc_id #=> String
resp.stale_security_group_set[0].stale_ip_permissions[0].user_id_group_pairs[0].vpc_peering_connection_id #=> String
resp.stale_security_group_set[0].stale_ip_permissions[0].user_id_group_pairs[0].peering_status #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress #=> Array
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].from_port #=> Integer
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].ip_protocol #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].ip_ranges #=> Array
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].ip_ranges[0] #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].prefix_list_ids #=> Array
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].prefix_list_ids[0] #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].to_port #=> Integer
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].user_id_group_pairs #=> Array
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].user_id_group_pairs[0].description #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].user_id_group_pairs[0].user_id #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].user_id_group_pairs[0].group_name #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].user_id_group_pairs[0].group_id #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].user_id_group_pairs[0].vpc_id #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].user_id_group_pairs[0].vpc_peering_connection_id #=> String
resp.stale_security_group_set[0].stale_ip_permissions_egress[0].user_id_group_pairs[0].peering_status #=> String
resp.stale_security_group_set[0].vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :vpc_id (required, String) —

    The ID of the VPC.

Returns:

See Also:



34365
34366
34367
34368
 
# File 'lib/aws-sdk-ec2/client.rb', line 34365

def describe_stale_security_groups(params = {}, options = {})
  req = build_request(:describe_stale_security_groups, params)
  req.send_request(options)
end

#describe_store_image_tasks(params = {}) ⇒ Types::DescribeStoreImageTasksResult

Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don’t specify the AMIs, you get a paginated list of store tasks from the last 31 days.

For each AMI task, the response indicates if the task is ‘InProgress`, `Completed`, or `Failed`. For tasks `InProgress`, the response shows the estimated progress as a percentage.

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.

To use this API, you must have the required permissions. For more information, see [Permissions for storing and restoring AMIs using 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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* store_image_task_complete

Examples:

Request syntax with placeholder values


resp = client.describe_store_image_tasks({
  image_ids: ["ImageId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.store_image_task_results #=> Array
resp.store_image_task_results[0].ami_id #=> String
resp.store_image_task_results[0].task_start_time #=> Time
resp.store_image_task_results[0].bucket #=> String
resp.store_image_task_results[0].s3object_key #=> String
resp.store_image_task_results[0].progress_percentage #=> Integer
resp.store_image_task_results[0].store_task_state #=> String
resp.store_image_task_results[0].store_task_failure_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_ids (Array<String>) —

    The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.

  • :dry_run (Boolean) —

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

    The filters.

    • ‘task-state` - Returns tasks in a certain state (`InProgress` | `Completed` | `Failed`)

    • ‘bucket` - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.

    <note markdown=“1”> When you specify the ‘ImageIds` parameter, any filters that you specify are ignored. To use the filters, you must remove the `ImageIds` parameter.

    </note>
  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination].

    You cannot specify this parameter and the ‘ImageIds` parameter in the same call.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



34477
34478
34479
34480
 
# File 'lib/aws-sdk-ec2/client.rb', line 34477

def describe_store_image_tasks(params = {}, options = {})
  req = build_request(:describe_store_image_tasks, params)
  req.send_request(options)
end

#describe_subnets(params = {}) ⇒ Types::DescribeSubnetsResult

Describes your subnets. The default is to describe all your subnets. Alternatively, you can specify specific subnet IDs or filter the results to include only the subnets that match specific criteria.

For more information, see [Subnets] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* subnet_available

Examples:

Example: To describe the subnets for a VPC


# This example describes the subnets for the specified VPC.

resp = client.describe_subnets({
  filters: [
    {
      name: "vpc-id", 
      values: [
        "vpc-a01106c2", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  subnets: [
    {
      availability_zone: "us-east-1c", 
      available_ip_address_count: 251, 
      cidr_block: "10.0.1.0/24", 
      default_for_az: false, 
      map_public_ip_on_launch: false, 
      state: "available", 
      subnet_id: "subnet-9d4a7b6c", 
      vpc_id: "vpc-a01106c2", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_subnets({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  subnet_ids: ["SubnetId"],
  next_token: "String",
  max_results: 1,
  dry_run: false,
})

Response structure


resp.next_token #=> String
resp.subnets #=> Array
resp.subnets[0].availability_zone_id #=> String
resp.subnets[0].enable_lni_at_device_index #=> Integer
resp.subnets[0].map_customer_owned_ip_on_launch #=> Boolean
resp.subnets[0].customer_owned_ipv_4_pool #=> String
resp.subnets[0].owner_id #=> String
resp.subnets[0].assign_ipv_6_address_on_creation #=> Boolean
resp.subnets[0].ipv_6_cidr_block_association_set #=> Array
resp.subnets[0].ipv_6_cidr_block_association_set[0].association_id #=> String
resp.subnets[0].ipv_6_cidr_block_association_set[0].ipv_6_cidr_block #=> String
resp.subnets[0].ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.subnets[0].ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.status_message #=> String
resp.subnets[0].ipv_6_cidr_block_association_set[0].ipv_6_address_attribute #=> String, one of "public", "private"
resp.subnets[0].ipv_6_cidr_block_association_set[0].ip_source #=> String, one of "amazon", "byoip", "none"
resp.subnets[0].tags #=> Array
resp.subnets[0].tags[0].key #=> String
resp.subnets[0].tags[0].value #=> String
resp.subnets[0].subnet_arn #=> String
resp.subnets[0].outpost_arn #=> String
resp.subnets[0].enable_dns_64 #=> Boolean
resp.subnets[0].ipv_6_native #=> Boolean
resp.subnets[0].private_dns_name_options_on_launch.hostname_type #=> String, one of "ip-name", "resource-name"
resp.subnets[0].private_dns_name_options_on_launch.enable_resource_name_dns_a_record #=> Boolean
resp.subnets[0].private_dns_name_options_on_launch.enable_resource_name_dns_aaaa_record #=> Boolean
resp.subnets[0].subnet_id #=> String
resp.subnets[0].state #=> String, one of "pending", "available", "unavailable"
resp.subnets[0].vpc_id #=> String
resp.subnets[0].cidr_block #=> String
resp.subnets[0].available_ip_address_count #=> Integer
resp.subnets[0].availability_zone #=> String
resp.subnets[0].default_for_az #=> Boolean
resp.subnets[0].map_public_ip_on_launch #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘availability-zone` - The Availability Zone for the subnet. You can also use `availabilityZone` as the filter name.

    • ‘availability-zone-id` - The ID of the Availability Zone for the subnet. You can also use `availabilityZoneId` as the filter name.

    • ‘available-ip-address-count` - The number of IPv4 addresses in the subnet that are available.

    • ‘cidr-block` - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet’s CIDR block for information to be returned for the subnet. You can also use ‘cidr` or `cidrBlock` as the filter names.

    • ‘customer-owned-ipv4-pool` - The customer-owned IPv4 address pool associated with the subnet.

    • ‘default-for-az` - Indicates whether this is the default subnet for the Availability Zone (`true` | `false`). You can also use `defaultForAz` as the filter name.

    • ‘enable-dns64` - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

    • ‘enable-lni-at-device-index` - Indicates the device position for local network interfaces in this subnet. For example, `1` indicates local network interfaces in this subnet are the secondary network interface (eth1).

    • ‘ipv6-cidr-block-association.ipv6-cidr-block` - An IPv6 CIDR block associated with the subnet.

    • ‘ipv6-cidr-block-association.association-id` - An association ID for an IPv6 CIDR block associated with the subnet.

    • ‘ipv6-cidr-block-association.state` - The state of an IPv6 CIDR block associated with the subnet.

    • ‘ipv6-native` - Indicates whether this is an IPv6 only subnet (`true` | `false`).

    • ‘map-customer-owned-ip-on-launch` - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

    • ‘map-public-ip-on-launch` - Indicates whether instances launched in this subnet receive a public IPv4 address.

    • ‘outpost-arn` - The Amazon Resource Name (ARN) of the Outpost.

    • ‘owner-id` - The ID of the Amazon Web Services account that owns the subnet.

    • ‘private-dns-name-options-on-launch.hostname-type` - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).

    • ‘private-dns-name-options-on-launch.enable-resource-name-dns-a-record`

      • Indicates whether to respond to DNS queries for instance hostnames

      with DNS A records.

    • ‘private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record`

      • Indicates whether to respond to DNS queries for instance hostnames

      with DNS AAAA records.

    • ‘state` - The state of the subnet (`pending` | `available`).

    • ‘subnet-arn` - The Amazon Resource Name (ARN) of the subnet.

    • ‘subnet-id` - The ID of the subnet.

    • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • ‘vpc-id` - The ID of the VPC for the subnet.

  • :subnet_ids (Array<String>) —

    The IDs of the subnets.

    Default: Describes all your subnets.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

Returns:

See Also:



34705
34706
34707
34708
 
# File 'lib/aws-sdk-ec2/client.rb', line 34705

def describe_subnets(params = {}, options = {})
  req = build_request(:describe_subnets, params)
  req.send_request(options)
end

#describe_tags(params = {}) ⇒ Types::DescribeTagsResult

Describes the specified tags for your EC2 resources.

For more information about tags, see [Tag your Amazon EC2 resources] in the *Amazon Elastic Compute Cloud User Guide*.

We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe the tags for a single resource


# This example describes the tags for the specified instance.

resp = client.describe_tags({
  filters: [
    {
      name: "resource-id", 
      values: [
        "i-1234567890abcdef8", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  tags: [
    {
      key: "Stack", 
      resource_id: "i-1234567890abcdef8", 
      resource_type: "instance", 
      value: "test", 
    }, 
    {
      key: "Name", 
      resource_id: "i-1234567890abcdef8", 
      resource_type: "instance", 
      value: "Beta Server", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_tags({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].resource_id #=> String
resp.tags[0].resource_type #=> String, one of "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"
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The filters.

    • ‘key` - The tag key.

    • ‘resource-id` - The ID of the resource.

    • ‘resource-type` - The resource type. For a list of possible values, see [TagSpecification].

    • ‘tag`:&lt;key&gt; - The key/value combination of the tag. For example, specify “tag:Owner” for the filter name and “TeamA” for the filter value to find resources with the tag “Owner=TeamA”.

    • ‘value` - The tag value.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TagSpecification.html

  • :max_results (Integer) —

    The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



34836
34837
34838
34839
 
# File 'lib/aws-sdk-ec2/client.rb', line 34836

def describe_tags(params = {}, options = {})
  req = build_request(:describe_tags, params)
  req.send_request(options)
end

#describe_traffic_mirror_filter_rules(params = {}) ⇒ Types::DescribeTrafficMirrorFilterRulesResult

Describe traffic mirror filters that determine the traffic that is mirrored.

Examples:

Request syntax with placeholder values


resp = client.describe_traffic_mirror_filter_rules({
  traffic_mirror_filter_rule_ids: ["TrafficMirrorFilterRuleIdWithResolver"],
  traffic_mirror_filter_id: "TrafficMirrorFilterId",
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.traffic_mirror_filter_rules #=> Array
resp.traffic_mirror_filter_rules[0].traffic_mirror_filter_rule_id #=> String
resp.traffic_mirror_filter_rules[0].traffic_mirror_filter_id #=> String
resp.traffic_mirror_filter_rules[0].traffic_direction #=> String, one of "ingress", "egress"
resp.traffic_mirror_filter_rules[0].rule_number #=> Integer
resp.traffic_mirror_filter_rules[0].rule_action #=> String, one of "accept", "reject"
resp.traffic_mirror_filter_rules[0].protocol #=> Integer
resp.traffic_mirror_filter_rules[0].destination_port_range.from_port #=> Integer
resp.traffic_mirror_filter_rules[0].destination_port_range.to_port #=> Integer
resp.traffic_mirror_filter_rules[0].source_port_range.from_port #=> Integer
resp.traffic_mirror_filter_rules[0].source_port_range.to_port #=> Integer
resp.traffic_mirror_filter_rules[0].destination_cidr_block #=> String
resp.traffic_mirror_filter_rules[0].source_cidr_block #=> String
resp.traffic_mirror_filter_rules[0].description #=> String
resp.traffic_mirror_filter_rules[0].tags #=> Array
resp.traffic_mirror_filter_rules[0].tags[0].key #=> String
resp.traffic_mirror_filter_rules[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_filter_rule_ids (Array<String>) —

    Traffic filter rule IDs.

  • :traffic_mirror_filter_id (String) —

    Traffic filter ID.

  • :dry_run (Boolean) —

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

    Traffic mirror filters.

    • ‘traffic-mirror-filter-rule-id`: The ID of the Traffic Mirror rule.

    • ‘traffic-mirror-filter-id`: The ID of the filter that this rule is associated with.

    • ‘rule-number`: The number of the Traffic Mirror rule.

    • ‘rule-action`: The action taken on the filtered traffic. Possible actions are `accept` and `reject`.

    • ‘traffic-direction`: The traffic direction. Possible directions are `ingress` and `egress`.

    • ‘protocol`: The protocol, for example UDP, assigned to the Traffic Mirror rule.

    • ‘source-cidr-block`: The source CIDR block assigned to the Traffic Mirror rule.

    • ‘destination-cidr-block`: The destination CIDR block assigned to the Traffic Mirror rule.

    • ‘description`: The description of the Traffic Mirror rule.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



34937
34938
34939
34940
 
# File 'lib/aws-sdk-ec2/client.rb', line 34937

def describe_traffic_mirror_filter_rules(params = {}, options = {})
  req = build_request(:describe_traffic_mirror_filter_rules, params)
  req.send_request(options)
end

#describe_traffic_mirror_filters(params = {}) ⇒ Types::DescribeTrafficMirrorFiltersResult

Describes one or more Traffic Mirror filters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_traffic_mirror_filters({
  traffic_mirror_filter_ids: ["TrafficMirrorFilterId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.traffic_mirror_filters #=> Array
resp.traffic_mirror_filters[0].traffic_mirror_filter_id #=> String
resp.traffic_mirror_filters[0].ingress_filter_rules #=> Array
resp.traffic_mirror_filters[0].ingress_filter_rules[0].traffic_mirror_filter_rule_id #=> String
resp.traffic_mirror_filters[0].ingress_filter_rules[0].traffic_mirror_filter_id #=> String
resp.traffic_mirror_filters[0].ingress_filter_rules[0].traffic_direction #=> String, one of "ingress", "egress"
resp.traffic_mirror_filters[0].ingress_filter_rules[0].rule_number #=> Integer
resp.traffic_mirror_filters[0].ingress_filter_rules[0].rule_action #=> String, one of "accept", "reject"
resp.traffic_mirror_filters[0].ingress_filter_rules[0].protocol #=> Integer
resp.traffic_mirror_filters[0].ingress_filter_rules[0].destination_port_range.from_port #=> Integer
resp.traffic_mirror_filters[0].ingress_filter_rules[0].destination_port_range.to_port #=> Integer
resp.traffic_mirror_filters[0].ingress_filter_rules[0].source_port_range.from_port #=> Integer
resp.traffic_mirror_filters[0].ingress_filter_rules[0].source_port_range.to_port #=> Integer
resp.traffic_mirror_filters[0].ingress_filter_rules[0].destination_cidr_block #=> String
resp.traffic_mirror_filters[0].ingress_filter_rules[0].source_cidr_block #=> String
resp.traffic_mirror_filters[0].ingress_filter_rules[0].description #=> String
resp.traffic_mirror_filters[0].ingress_filter_rules[0].tags #=> Array
resp.traffic_mirror_filters[0].ingress_filter_rules[0].tags[0].key #=> String
resp.traffic_mirror_filters[0].ingress_filter_rules[0].tags[0].value #=> String
resp.traffic_mirror_filters[0].egress_filter_rules #=> Array
resp.traffic_mirror_filters[0].egress_filter_rules[0].traffic_mirror_filter_rule_id #=> String
resp.traffic_mirror_filters[0].egress_filter_rules[0].traffic_mirror_filter_id #=> String
resp.traffic_mirror_filters[0].egress_filter_rules[0].traffic_direction #=> String, one of "ingress", "egress"
resp.traffic_mirror_filters[0].egress_filter_rules[0].rule_number #=> Integer
resp.traffic_mirror_filters[0].egress_filter_rules[0].rule_action #=> String, one of "accept", "reject"
resp.traffic_mirror_filters[0].egress_filter_rules[0].protocol #=> Integer
resp.traffic_mirror_filters[0].egress_filter_rules[0].destination_port_range.from_port #=> Integer
resp.traffic_mirror_filters[0].egress_filter_rules[0].destination_port_range.to_port #=> Integer
resp.traffic_mirror_filters[0].egress_filter_rules[0].source_port_range.from_port #=> Integer
resp.traffic_mirror_filters[0].egress_filter_rules[0].source_port_range.to_port #=> Integer
resp.traffic_mirror_filters[0].egress_filter_rules[0].destination_cidr_block #=> String
resp.traffic_mirror_filters[0].egress_filter_rules[0].source_cidr_block #=> String
resp.traffic_mirror_filters[0].egress_filter_rules[0].description #=> String
resp.traffic_mirror_filters[0].egress_filter_rules[0].tags #=> Array
resp.traffic_mirror_filters[0].egress_filter_rules[0].tags[0].key #=> String
resp.traffic_mirror_filters[0].egress_filter_rules[0].tags[0].value #=> String
resp.traffic_mirror_filters[0].network_services #=> Array
resp.traffic_mirror_filters[0].network_services[0] #=> String, one of "amazon-dns"
resp.traffic_mirror_filters[0].description #=> String
resp.traffic_mirror_filters[0].tags #=> Array
resp.traffic_mirror_filters[0].tags[0].key #=> String
resp.traffic_mirror_filters[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_filter_ids (Array<String>) —

    The ID of the Traffic Mirror filter.

  • :dry_run (Boolean) —

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

    One or more filters. The possible values are:

    • ‘description`: The Traffic Mirror filter description.

    • ‘traffic-mirror-filter-id`: The ID of the Traffic Mirror filter.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



35040
35041
35042
35043
 
# File 'lib/aws-sdk-ec2/client.rb', line 35040

def describe_traffic_mirror_filters(params = {}, options = {})
  req = build_request(:describe_traffic_mirror_filters, params)
  req.send_request(options)
end

#describe_traffic_mirror_sessions(params = {}) ⇒ Types::DescribeTrafficMirrorSessionsResult

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_traffic_mirror_sessions({
  traffic_mirror_session_ids: ["TrafficMirrorSessionId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.traffic_mirror_sessions #=> Array
resp.traffic_mirror_sessions[0].traffic_mirror_session_id #=> String
resp.traffic_mirror_sessions[0].traffic_mirror_target_id #=> String
resp.traffic_mirror_sessions[0].traffic_mirror_filter_id #=> String
resp.traffic_mirror_sessions[0].network_interface_id #=> String
resp.traffic_mirror_sessions[0].owner_id #=> String
resp.traffic_mirror_sessions[0].packet_length #=> Integer
resp.traffic_mirror_sessions[0].session_number #=> Integer
resp.traffic_mirror_sessions[0].virtual_network_id #=> Integer
resp.traffic_mirror_sessions[0].description #=> String
resp.traffic_mirror_sessions[0].tags #=> Array
resp.traffic_mirror_sessions[0].tags[0].key #=> String
resp.traffic_mirror_sessions[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_session_ids (Array<String>) —

    The ID of the Traffic Mirror session.

  • :dry_run (Boolean) —

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

    One or more filters. The possible values are:

    • ‘description`: The Traffic Mirror session description.

    • ‘network-interface-id`: The ID of the Traffic Mirror session network interface.

    • ‘owner-id`: The ID of the account that owns the Traffic Mirror session.

    • ‘packet-length`: The assigned number of packets to mirror.

    • ‘session-number`: The assigned session number.

    • ‘traffic-mirror-filter-id`: The ID of the Traffic Mirror filter.

    • ‘traffic-mirror-session-id`: The ID of the Traffic Mirror session.

    • ‘traffic-mirror-target-id`: The ID of the Traffic Mirror target.

    • ‘virtual-network-id`: The virtual network ID of the Traffic Mirror session.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



35133
35134
35135
35136
 
# File 'lib/aws-sdk-ec2/client.rb', line 35133

def describe_traffic_mirror_sessions(params = {}, options = {})
  req = build_request(:describe_traffic_mirror_sessions, params)
  req.send_request(options)
end

#describe_traffic_mirror_targets(params = {}) ⇒ Types::DescribeTrafficMirrorTargetsResult

Information about one or more Traffic Mirror targets.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_traffic_mirror_targets({
  traffic_mirror_target_ids: ["TrafficMirrorTargetId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.traffic_mirror_targets #=> Array
resp.traffic_mirror_targets[0].traffic_mirror_target_id #=> String
resp.traffic_mirror_targets[0].network_interface_id #=> String
resp.traffic_mirror_targets[0].network_load_balancer_arn #=> String
resp.traffic_mirror_targets[0].type #=> String, one of "network-interface", "network-load-balancer", "gateway-load-balancer-endpoint"
resp.traffic_mirror_targets[0].description #=> String
resp.traffic_mirror_targets[0].owner_id #=> String
resp.traffic_mirror_targets[0].tags #=> Array
resp.traffic_mirror_targets[0].tags[0].key #=> String
resp.traffic_mirror_targets[0].tags[0].value #=> String
resp.traffic_mirror_targets[0].gateway_load_balancer_endpoint_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_target_ids (Array<String>) —

    The ID of the Traffic Mirror targets.

  • :dry_run (Boolean) —

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

    One or more filters. The possible values are:

    • ‘description`: The Traffic Mirror target description.

    • ‘network-interface-id`: The ID of the Traffic Mirror session network interface.

    • ‘network-load-balancer-arn`: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.

    • ‘owner-id`: The ID of the account that owns the Traffic Mirror session.

    • ‘traffic-mirror-target-id`: The ID of the Traffic Mirror target.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



35214
35215
35216
35217
 
# File 'lib/aws-sdk-ec2/client.rb', line 35214

def describe_traffic_mirror_targets(params = {}, options = {})
  req = build_request(:describe_traffic_mirror_targets, params)
  req.send_request(options)
end

#describe_transit_gateway_attachments(params = {}) ⇒ Types::DescribeTransitGatewayAttachmentsResult

Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateway_attachments({
  transit_gateway_attachment_ids: ["TransitGatewayAttachmentId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_attachments #=> Array
resp.transit_gateway_attachments[0].transit_gateway_attachment_id #=> String
resp.transit_gateway_attachments[0].transit_gateway_id #=> String
resp.transit_gateway_attachments[0].transit_gateway_owner_id #=> String
resp.transit_gateway_attachments[0].resource_owner_id #=> String
resp.transit_gateway_attachments[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.transit_gateway_attachments[0].resource_id #=> String
resp.transit_gateway_attachments[0].state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_attachments[0].association.transit_gateway_route_table_id #=> String
resp.transit_gateway_attachments[0].association.state #=> String, one of "associating", "associated", "disassociating", "disassociated"
resp.transit_gateway_attachments[0].creation_time #=> Time
resp.transit_gateway_attachments[0].tags #=> Array
resp.transit_gateway_attachments[0].tags[0].key #=> String
resp.transit_gateway_attachments[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_ids (Array<String>) —

    The IDs of the attachments.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘association.state` - The state of the association (`associating` | `associated` | `disassociating`).

    • ‘association.transit-gateway-route-table-id` - The ID of the route table for the transit gateway.

    • ‘resource-id` - The ID of the resource.

    • ‘resource-owner-id` - The ID of the Amazon Web Services account that owns the resource.

    • ‘resource-type` - The resource type. Valid values are `vpc` | `vpn` | `direct-connect-gateway` | `peering` | `connect`.

    • ‘state` - The state of the attachment. Valid values are `available` | `deleted` | `deleting` | `failed` | `failing` | `initiatingRequest` | `modifying` | `pendingAcceptance` | `pending` | `rollingBack` | `rejected` | `rejecting`.

    • ‘transit-gateway-attachment-id` - The ID of the attachment.

    • ‘transit-gateway-id` - The ID of the transit gateway.

    • ‘transit-gateway-owner-id` - The ID of the Amazon Web Services account that owns the transit gateway.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



35314
35315
35316
35317
 
# File 'lib/aws-sdk-ec2/client.rb', line 35314

def describe_transit_gateway_attachments(params = {}, options = {})
  req = build_request(:describe_transit_gateway_attachments, params)
  req.send_request(options)
end

#describe_transit_gateway_connect_peers(params = {}) ⇒ Types::DescribeTransitGatewayConnectPeersResult

Describes one or more Connect peers.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateway_connect_peers({
  transit_gateway_connect_peer_ids: ["TransitGatewayConnectPeerId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_connect_peers #=> Array
resp.transit_gateway_connect_peers[0].transit_gateway_attachment_id #=> String
resp.transit_gateway_connect_peers[0].transit_gateway_connect_peer_id #=> String
resp.transit_gateway_connect_peers[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_connect_peers[0].creation_time #=> Time
resp.transit_gateway_connect_peers[0].connect_peer_configuration.transit_gateway_address #=> String
resp.transit_gateway_connect_peers[0].connect_peer_configuration.peer_address #=> String
resp.transit_gateway_connect_peers[0].connect_peer_configuration.inside_cidr_blocks #=> Array
resp.transit_gateway_connect_peers[0].connect_peer_configuration.inside_cidr_blocks[0] #=> String
resp.transit_gateway_connect_peers[0].connect_peer_configuration.protocol #=> String, one of "gre"
resp.transit_gateway_connect_peers[0].connect_peer_configuration.bgp_configurations #=> Array
resp.transit_gateway_connect_peers[0].connect_peer_configuration.bgp_configurations[0].transit_gateway_asn #=> Integer
resp.transit_gateway_connect_peers[0].connect_peer_configuration.bgp_configurations[0].peer_asn #=> Integer
resp.transit_gateway_connect_peers[0].connect_peer_configuration.bgp_configurations[0].transit_gateway_address #=> String
resp.transit_gateway_connect_peers[0].connect_peer_configuration.bgp_configurations[0].peer_address #=> String
resp.transit_gateway_connect_peers[0].connect_peer_configuration.bgp_configurations[0].bgp_status #=> String, one of "up", "down"
resp.transit_gateway_connect_peers[0].tags #=> Array
resp.transit_gateway_connect_peers[0].tags[0].key #=> String
resp.transit_gateway_connect_peers[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_connect_peer_ids (Array<String>) —

    The IDs of the Connect peers.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘state` - The state of the Connect peer (`pending` | `available` | `deleting` | `deleted`).

    • ‘transit-gateway-attachment-id` - The ID of the attachment.

    • ‘transit-gateway-connect-peer-id` - The ID of the Connect peer.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



35397
35398
35399
35400
 
# File 'lib/aws-sdk-ec2/client.rb', line 35397

def describe_transit_gateway_connect_peers(params = {}, options = {})
  req = build_request(:describe_transit_gateway_connect_peers, params)
  req.send_request(options)
end

#describe_transit_gateway_connects(params = {}) ⇒ Types::DescribeTransitGatewayConnectsResult

Describes one or more Connect attachments.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateway_connects({
  transit_gateway_attachment_ids: ["TransitGatewayAttachmentId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_connects #=> Array
resp.transit_gateway_connects[0].transit_gateway_attachment_id #=> String
resp.transit_gateway_connects[0].transport_transit_gateway_attachment_id #=> String
resp.transit_gateway_connects[0].transit_gateway_id #=> String
resp.transit_gateway_connects[0].state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_connects[0].creation_time #=> Time
resp.transit_gateway_connects[0].options.protocol #=> String, one of "gre"
resp.transit_gateway_connects[0].tags #=> Array
resp.transit_gateway_connects[0].tags[0].key #=> String
resp.transit_gateway_connects[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_ids (Array<String>) —

    The IDs of the attachments.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘options.protocol` - The tunnel protocol (`gre`).

    • ‘state` - The state of the attachment (`initiating` | `initiatingRequest` | `pendingAcceptance` | `rollingBack` | `pending` | `available` | `modifying` | `deleting` | `deleted` | `failed` | `rejected` | `rejecting` | `failing`).

    • ‘transit-gateway-attachment-id` - The ID of the Connect attachment.

    • ‘transit-gateway-id` - The ID of the transit gateway.

    • ‘transport-transit-gateway-attachment-id` - The ID of the transit gateway attachment from which the Connect attachment was created.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



35478
35479
35480
35481
 
# File 'lib/aws-sdk-ec2/client.rb', line 35478

def describe_transit_gateway_connects(params = {}, options = {})
  req = build_request(:describe_transit_gateway_connects, params)
  req.send_request(options)
end

#describe_transit_gateway_multicast_domains(params = {}) ⇒ Types::DescribeTransitGatewayMulticastDomainsResult

Describes one or more transit gateway multicast domains.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateway_multicast_domains({
  transit_gateway_multicast_domain_ids: ["TransitGatewayMulticastDomainId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_multicast_domains #=> Array
resp.transit_gateway_multicast_domains[0].transit_gateway_multicast_domain_id #=> String
resp.transit_gateway_multicast_domains[0].transit_gateway_id #=> String
resp.transit_gateway_multicast_domains[0].transit_gateway_multicast_domain_arn #=> String
resp.transit_gateway_multicast_domains[0].owner_id #=> String
resp.transit_gateway_multicast_domains[0].options.igmpv_2_support #=> String, one of "enable", "disable"
resp.transit_gateway_multicast_domains[0].options.static_sources_support #=> String, one of "enable", "disable"
resp.transit_gateway_multicast_domains[0].options.auto_accept_shared_associations #=> String, one of "enable", "disable"
resp.transit_gateway_multicast_domains[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_multicast_domains[0].creation_time #=> Time
resp.transit_gateway_multicast_domains[0].tags #=> Array
resp.transit_gateway_multicast_domains[0].tags[0].key #=> String
resp.transit_gateway_multicast_domains[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_ids (Array<String>) —

    The ID of the transit gateway multicast domain.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘state` - The state of the transit gateway multicast domain. Valid values are `pending` | `available` | `deleting` | `deleted`.

    • ‘transit-gateway-id` - The ID of the transit gateway.

    • ‘transit-gateway-multicast-domain-id` - The ID of the transit gateway multicast domain.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



35556
35557
35558
35559
 
# File 'lib/aws-sdk-ec2/client.rb', line 35556

def describe_transit_gateway_multicast_domains(params = {}, options = {})
  req = build_request(:describe_transit_gateway_multicast_domains, params)
  req.send_request(options)
end

#describe_transit_gateway_peering_attachments(params = {}) ⇒ Types::DescribeTransitGatewayPeeringAttachmentsResult

Describes your transit gateway peering attachments.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateway_peering_attachments({
  transit_gateway_attachment_ids: ["TransitGatewayAttachmentId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_peering_attachments #=> Array
resp.transit_gateway_peering_attachments[0].transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachments[0].accepter_transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachments[0].requester_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachments[0].requester_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachments[0].requester_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachments[0].requester_tgw_info.region #=> String
resp.transit_gateway_peering_attachments[0].accepter_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachments[0].accepter_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachments[0].accepter_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachments[0].accepter_tgw_info.region #=> String
resp.transit_gateway_peering_attachments[0].options.dynamic_routing #=> String, one of "enable", "disable"
resp.transit_gateway_peering_attachments[0].status.code #=> String
resp.transit_gateway_peering_attachments[0].status.message #=> String
resp.transit_gateway_peering_attachments[0].state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_peering_attachments[0].creation_time #=> Time
resp.transit_gateway_peering_attachments[0].tags #=> Array
resp.transit_gateway_peering_attachments[0].tags[0].key #=> String
resp.transit_gateway_peering_attachments[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_ids (Array<String>) —

    One or more IDs of the transit gateway peering attachments.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘transit-gateway-attachment-id` - The ID of the transit gateway attachment.

    • ‘local-owner-id` - The ID of your Amazon Web Services account.

    • ‘remote-owner-id` - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.

    • ‘state` - The state of the peering attachment. Valid values are `available` | `deleted` | `deleting` | `failed` | `failing` | `initiatingRequest` | `modifying` | `pendingAcceptance` | `pending` | `rollingBack` | `rejected` | `rejecting`).

    • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

    • ‘transit-gateway-id` - The ID of the transit gateway.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



35657
35658
35659
35660
 
# File 'lib/aws-sdk-ec2/client.rb', line 35657

def describe_transit_gateway_peering_attachments(params = {}, options = {})
  req = build_request(:describe_transit_gateway_peering_attachments, params)
  req.send_request(options)
end

#describe_transit_gateway_policy_tables(params = {}) ⇒ Types::DescribeTransitGatewayPolicyTablesResult

Describes one or more transit gateway route policy tables.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateway_policy_tables({
  transit_gateway_policy_table_ids: ["TransitGatewayPolicyTableId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_policy_tables #=> Array
resp.transit_gateway_policy_tables[0].transit_gateway_policy_table_id #=> String
resp.transit_gateway_policy_tables[0].transit_gateway_id #=> String
resp.transit_gateway_policy_tables[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_policy_tables[0].creation_time #=> Time
resp.transit_gateway_policy_tables[0].tags #=> Array
resp.transit_gateway_policy_tables[0].tags[0].key #=> String
resp.transit_gateway_policy_tables[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_policy_table_ids (Array<String>) —

    The IDs of the transit gateway policy tables.

  • :filters (Array<Types::Filter>) —

    The filters associated with the transit gateway policy table.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



35722
35723
35724
35725
 
# File 'lib/aws-sdk-ec2/client.rb', line 35722

def describe_transit_gateway_policy_tables(params = {}, options = {})
  req = build_request(:describe_transit_gateway_policy_tables, params)
  req.send_request(options)
end

#describe_transit_gateway_route_table_announcements(params = {}) ⇒ Types::DescribeTransitGatewayRouteTableAnnouncementsResult

Describes one or more transit gateway route table advertisements.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateway_route_table_announcements({
  transit_gateway_route_table_announcement_ids: ["TransitGatewayRouteTableAnnouncementId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_route_table_announcements #=> Array
resp.transit_gateway_route_table_announcements[0].transit_gateway_route_table_announcement_id #=> String
resp.transit_gateway_route_table_announcements[0].transit_gateway_id #=> String
resp.transit_gateway_route_table_announcements[0].core_network_id #=> String
resp.transit_gateway_route_table_announcements[0].peer_transit_gateway_id #=> String
resp.transit_gateway_route_table_announcements[0].peer_core_network_id #=> String
resp.transit_gateway_route_table_announcements[0].peering_attachment_id #=> String
resp.transit_gateway_route_table_announcements[0].announcement_direction #=> String, one of "outgoing", "incoming"
resp.transit_gateway_route_table_announcements[0].transit_gateway_route_table_id #=> String
resp.transit_gateway_route_table_announcements[0].state #=> String, one of "available", "pending", "failing", "failed", "deleting", "deleted"
resp.transit_gateway_route_table_announcements[0].creation_time #=> Time
resp.transit_gateway_route_table_announcements[0].tags #=> Array
resp.transit_gateway_route_table_announcements[0].tags[0].key #=> String
resp.transit_gateway_route_table_announcements[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_announcement_ids (Array<String>) —

    The IDs of the transit gateway route tables that are being advertised.

  • :filters (Array<Types::Filter>) —

    The filters associated with the transit gateway policy table.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



35793
35794
35795
35796
 
# File 'lib/aws-sdk-ec2/client.rb', line 35793

def describe_transit_gateway_route_table_announcements(params = {}, options = {})
  req = build_request(:describe_transit_gateway_route_table_announcements, params)
  req.send_request(options)
end

#describe_transit_gateway_route_tables(params = {}) ⇒ Types::DescribeTransitGatewayRouteTablesResult

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateway_route_tables({
  transit_gateway_route_table_ids: ["TransitGatewayRouteTableId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_route_tables #=> Array
resp.transit_gateway_route_tables[0].transit_gateway_route_table_id #=> String
resp.transit_gateway_route_tables[0].transit_gateway_id #=> String
resp.transit_gateway_route_tables[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.transit_gateway_route_tables[0].default_association_route_table #=> Boolean
resp.transit_gateway_route_tables[0].default_propagation_route_table #=> Boolean
resp.transit_gateway_route_tables[0].creation_time #=> Time
resp.transit_gateway_route_tables[0].tags #=> Array
resp.transit_gateway_route_tables[0].tags[0].key #=> String
resp.transit_gateway_route_tables[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_ids (Array<String>) —

    The IDs of the transit gateway route tables.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘default-association-route-table` - Indicates whether this is the default association route table for the transit gateway (`true` | `false`).

    • ‘default-propagation-route-table` - Indicates whether this is the default propagation route table for the transit gateway (`true` | `false`).

    • ‘state` - The state of the route table (`available` | `deleting` | `deleted` | `pending`).

    • ‘transit-gateway-id` - The ID of the transit gateway.

    • ‘transit-gateway-route-table-id` - The ID of the transit gateway route table.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



35878
35879
35880
35881
 
# File 'lib/aws-sdk-ec2/client.rb', line 35878

def describe_transit_gateway_route_tables(params = {}, options = {})
  req = build_request(:describe_transit_gateway_route_tables, params)
  req.send_request(options)
end

#describe_transit_gateway_vpc_attachments(params = {}) ⇒ Types::DescribeTransitGatewayVpcAttachmentsResult

Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateway_vpc_attachments({
  transit_gateway_attachment_ids: ["TransitGatewayAttachmentId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_vpc_attachments #=> Array
resp.transit_gateway_vpc_attachments[0].transit_gateway_attachment_id #=> String
resp.transit_gateway_vpc_attachments[0].transit_gateway_id #=> String
resp.transit_gateway_vpc_attachments[0].vpc_id #=> String
resp.transit_gateway_vpc_attachments[0].vpc_owner_id #=> String
resp.transit_gateway_vpc_attachments[0].state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_vpc_attachments[0].subnet_ids #=> Array
resp.transit_gateway_vpc_attachments[0].subnet_ids[0] #=> String
resp.transit_gateway_vpc_attachments[0].creation_time #=> Time
resp.transit_gateway_vpc_attachments[0].options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachments[0].options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachments[0].options.ipv_6_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachments[0].options.appliance_mode_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachments[0].tags #=> Array
resp.transit_gateway_vpc_attachments[0].tags[0].key #=> String
resp.transit_gateway_vpc_attachments[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_ids (Array<String>) —

    The IDs of the attachments.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘state` - The state of the attachment. Valid values are `available` | `deleted` | `deleting` | `failed` | `failing` | `initiatingRequest` | `modifying` | `pendingAcceptance` | `pending` | `rollingBack` | `rejected` | `rejecting`.

    • ‘transit-gateway-attachment-id` - The ID of the attachment.

    • ‘transit-gateway-id` - The ID of the transit gateway.

    • ‘vpc-id` - The ID of the VPC.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



35963
35964
35965
35966
 
# File 'lib/aws-sdk-ec2/client.rb', line 35963

def describe_transit_gateway_vpc_attachments(params = {}, options = {})
  req = build_request(:describe_transit_gateway_vpc_attachments, params)
  req.send_request(options)
end

#describe_transit_gateways(params = {}) ⇒ Types::DescribeTransitGatewaysResult

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_transit_gateways({
  transit_gateway_ids: ["TransitGatewayId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateways #=> Array
resp.transit_gateways[0].transit_gateway_id #=> String
resp.transit_gateways[0].transit_gateway_arn #=> String
resp.transit_gateways[0].state #=> String, one of "pending", "available", "modifying", "deleting", "deleted"
resp.transit_gateways[0].owner_id #=> String
resp.transit_gateways[0].description #=> String
resp.transit_gateways[0].creation_time #=> Time
resp.transit_gateways[0].options.amazon_side_asn #=> Integer
resp.transit_gateways[0].options.transit_gateway_cidr_blocks #=> Array
resp.transit_gateways[0].options.transit_gateway_cidr_blocks[0] #=> String
resp.transit_gateways[0].options.auto_accept_shared_attachments #=> String, one of "enable", "disable"
resp.transit_gateways[0].options.default_route_table_association #=> String, one of "enable", "disable"
resp.transit_gateways[0].options.association_default_route_table_id #=> String
resp.transit_gateways[0].options.default_route_table_propagation #=> String, one of "enable", "disable"
resp.transit_gateways[0].options.propagation_default_route_table_id #=> String
resp.transit_gateways[0].options.vpn_ecmp_support #=> String, one of "enable", "disable"
resp.transit_gateways[0].options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateways[0].options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateways[0].options.multicast_support #=> String, one of "enable", "disable"
resp.transit_gateways[0].tags #=> Array
resp.transit_gateways[0].tags[0].key #=> String
resp.transit_gateways[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_ids (Array<String>) —

    The IDs of the transit gateways.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘options.propagation-default-route-table-id` - The ID of the default propagation route table.

    • ‘options.amazon-side-asn` - The private ASN for the Amazon side of a BGP session.

    • ‘options.association-default-route-table-id` - The ID of the default association route table.

    • ‘options.auto-accept-shared-attachments` - Indicates whether there is automatic acceptance of attachment requests (`enable` | `disable`).

    • ‘options.default-route-table-association` - Indicates whether resource attachments are automatically associated with the default association route table (`enable` | `disable`).

    • ‘options.default-route-table-propagation` - Indicates whether resource attachments automatically propagate routes to the default propagation route table (`enable` | `disable`).

    • ‘options.dns-support` - Indicates whether DNS support is enabled (`enable` | `disable`).

    • ‘options.vpn-ecmp-support` - Indicates whether Equal Cost Multipath Protocol support is enabled (`enable` | `disable`).

    • ‘owner-id` - The ID of the Amazon Web Services account that owns the transit gateway.

    • ‘state` - The state of the transit gateway (`available` | `deleted` | `deleting` | `modifying` | `pending`).

    • ‘transit-gateway-id` - The ID of the transit gateway.

    • ‘tag-key `- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



36084
36085
36086
36087
 
# File 'lib/aws-sdk-ec2/client.rb', line 36084

def describe_transit_gateways(params = {}, options = {})
  req = build_request(:describe_transit_gateways, params)
  req.send_request(options)
end

#describe_trunk_interface_associations(params = {}) ⇒ Types::DescribeTrunkInterfaceAssociationsResult

Describes one or more network interface trunk associations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_trunk_interface_associations({
  association_ids: ["TrunkInterfaceAssociationId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.interface_associations #=> Array
resp.interface_associations[0].association_id #=> String
resp.interface_associations[0].branch_interface_id #=> String
resp.interface_associations[0].trunk_interface_id #=> String
resp.interface_associations[0].interface_protocol #=> String, one of "VLAN", "GRE"
resp.interface_associations[0].vlan_id #=> Integer
resp.interface_associations[0].gre_key #=> Integer
resp.interface_associations[0].tags #=> Array
resp.interface_associations[0].tags[0].key #=> String
resp.interface_associations[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :association_ids (Array<String>) —

    The IDs of the associations.

  • :dry_run (Boolean) —

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

    One or more filters.

    • ‘gre-key` - The ID of a trunk interface association.

    • ‘interface-protocol` - The interface protocol. Valid values are `VLAN` and `GRE`.

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (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.

Returns:

See Also:



36156
36157
36158
36159
 
# File 'lib/aws-sdk-ec2/client.rb', line 36156

def describe_trunk_interface_associations(params = {}, options = {})
  req = build_request(:describe_trunk_interface_associations, params)
  req.send_request(options)
end

#describe_verified_access_endpoints(params = {}) ⇒ Types::DescribeVerifiedAccessEndpointsResult

Describes the specified Amazon Web Services Verified Access endpoints.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_verified_access_endpoints({
  verified_access_endpoint_ids: ["VerifiedAccessEndpointId"],
  verified_access_instance_id: "VerifiedAccessInstanceId",
  verified_access_group_id: "VerifiedAccessGroupId",
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.verified_access_endpoints #=> Array
resp.verified_access_endpoints[0].verified_access_instance_id #=> String
resp.verified_access_endpoints[0].verified_access_group_id #=> String
resp.verified_access_endpoints[0].verified_access_endpoint_id #=> String
resp.verified_access_endpoints[0].application_domain #=> String
resp.verified_access_endpoints[0].endpoint_type #=> String, one of "load-balancer", "network-interface"
resp.verified_access_endpoints[0].attachment_type #=> String, one of "vpc"
resp.verified_access_endpoints[0].domain_certificate_arn #=> String
resp.verified_access_endpoints[0].endpoint_domain #=> String
resp.verified_access_endpoints[0].device_validation_domain #=> String
resp.verified_access_endpoints[0].security_group_ids #=> Array
resp.verified_access_endpoints[0].security_group_ids[0] #=> String
resp.verified_access_endpoints[0].load_balancer_options.protocol #=> String, one of "http", "https"
resp.verified_access_endpoints[0].load_balancer_options.port #=> Integer
resp.verified_access_endpoints[0].load_balancer_options.load_balancer_arn #=> String
resp.verified_access_endpoints[0].load_balancer_options.subnet_ids #=> Array
resp.verified_access_endpoints[0].load_balancer_options.subnet_ids[0] #=> String
resp.verified_access_endpoints[0].network_interface_options.network_interface_id #=> String
resp.verified_access_endpoints[0].network_interface_options.protocol #=> String, one of "http", "https"
resp.verified_access_endpoints[0].network_interface_options.port #=> Integer
resp.verified_access_endpoints[0].status.code #=> String, one of "pending", "active", "updating", "deleting", "deleted"
resp.verified_access_endpoints[0].status.message #=> String
resp.verified_access_endpoints[0].description #=> String
resp.verified_access_endpoints[0].creation_time #=> String
resp.verified_access_endpoints[0].last_updated_time #=> String
resp.verified_access_endpoints[0].deletion_time #=> String
resp.verified_access_endpoints[0].tags #=> Array
resp.verified_access_endpoints[0].tags[0].key #=> String
resp.verified_access_endpoints[0].tags[0].value #=> String
resp.verified_access_endpoints[0].sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_endpoints[0].sse_specification.kms_key_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_endpoint_ids (Array<String>) —

    The ID of the Verified Access endpoint.

  • :verified_access_instance_id (String) —

    The ID of the Verified Access instance.

  • :verified_access_group_id (String) —

    The ID of the Verified Access group.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

  • :dry_run (Boolean) —

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

Returns:

See Also:



36252
36253
36254
36255
 
# File 'lib/aws-sdk-ec2/client.rb', line 36252

def describe_verified_access_endpoints(params = {}, options = {})
  req = build_request(:describe_verified_access_endpoints, params)
  req.send_request(options)
end

#describe_verified_access_groups(params = {}) ⇒ Types::DescribeVerifiedAccessGroupsResult

Describes the specified Verified Access groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_verified_access_groups({
  verified_access_group_ids: ["VerifiedAccessGroupId"],
  verified_access_instance_id: "VerifiedAccessInstanceId",
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.verified_access_groups #=> Array
resp.verified_access_groups[0].verified_access_group_id #=> String
resp.verified_access_groups[0].verified_access_instance_id #=> String
resp.verified_access_groups[0].description #=> String
resp.verified_access_groups[0].owner #=> String
resp.verified_access_groups[0].verified_access_group_arn #=> String
resp.verified_access_groups[0].creation_time #=> String
resp.verified_access_groups[0].last_updated_time #=> String
resp.verified_access_groups[0].deletion_time #=> String
resp.verified_access_groups[0].tags #=> Array
resp.verified_access_groups[0].tags[0].key #=> String
resp.verified_access_groups[0].tags[0].value #=> String
resp.verified_access_groups[0].sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_groups[0].sse_specification.kms_key_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_group_ids (Array<String>) —

    The ID of the Verified Access groups.

  • :verified_access_instance_id (String) —

    The ID of the Verified Access instance.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

  • :dry_run (Boolean) —

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

Returns:

See Also:



36327
36328
36329
36330
 
# File 'lib/aws-sdk-ec2/client.rb', line 36327

def describe_verified_access_groups(params = {}, options = {})
  req = build_request(:describe_verified_access_groups, params)
  req.send_request(options)
end

#describe_verified_access_instance_logging_configurations(params = {}) ⇒ Types::DescribeVerifiedAccessInstanceLoggingConfigurationsResult

Describes the specified Amazon Web Services Verified Access instances.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_verified_access_instance_logging_configurations({
  verified_access_instance_ids: ["VerifiedAccessInstanceId"],
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.logging_configurations #=> Array
resp.logging_configurations[0].verified_access_instance_id #=> String
resp.logging_configurations[0].access_logs.s3.enabled #=> Boolean
resp.logging_configurations[0].access_logs.s3.delivery_status.code #=> String, one of "success", "failed"
resp.logging_configurations[0].access_logs.s3.delivery_status.message #=> String
resp.logging_configurations[0].access_logs.s3.bucket_name #=> String
resp.logging_configurations[0].access_logs.s3.prefix #=> String
resp.logging_configurations[0].access_logs.s3.bucket_owner #=> String
resp.logging_configurations[0].access_logs.cloud_watch_logs.enabled #=> Boolean
resp.logging_configurations[0].access_logs.cloud_watch_logs.delivery_status.code #=> String, one of "success", "failed"
resp.logging_configurations[0].access_logs.cloud_watch_logs.delivery_status.message #=> String
resp.logging_configurations[0].access_logs.cloud_watch_logs.log_group #=> String
resp.logging_configurations[0].access_logs.kinesis_data_firehose.enabled #=> Boolean
resp.logging_configurations[0].access_logs.kinesis_data_firehose.delivery_status.code #=> String, one of "success", "failed"
resp.logging_configurations[0].access_logs.kinesis_data_firehose.delivery_status.message #=> String
resp.logging_configurations[0].access_logs.kinesis_data_firehose.delivery_stream #=> String
resp.logging_configurations[0].access_logs.log_version #=> String
resp.logging_configurations[0].access_logs.include_trust_context #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_instance_ids (Array<String>) —

    The IDs of the Verified Access instances.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

  • :dry_run (Boolean) —

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

Returns:

See Also:



36402
36403
36404
36405
 
# File 'lib/aws-sdk-ec2/client.rb', line 36402

def describe_verified_access_instance_logging_configurations(params = {}, options = {})
  req = build_request(:describe_verified_access_instance_logging_configurations, params)
  req.send_request(options)
end

#describe_verified_access_instances(params = {}) ⇒ Types::DescribeVerifiedAccessInstancesResult

Describes the specified Amazon Web Services Verified Access instances.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_verified_access_instances({
  verified_access_instance_ids: ["VerifiedAccessInstanceId"],
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.verified_access_instances #=> Array
resp.verified_access_instances[0].verified_access_instance_id #=> String
resp.verified_access_instances[0].description #=> String
resp.verified_access_instances[0].verified_access_trust_providers #=> Array
resp.verified_access_instances[0].verified_access_trust_providers[0].verified_access_trust_provider_id #=> String
resp.verified_access_instances[0].verified_access_trust_providers[0].description #=> String
resp.verified_access_instances[0].verified_access_trust_providers[0].trust_provider_type #=> String, one of "user", "device"
resp.verified_access_instances[0].verified_access_trust_providers[0].user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_instances[0].verified_access_trust_providers[0].device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_instances[0].creation_time #=> String
resp.verified_access_instances[0].last_updated_time #=> String
resp.verified_access_instances[0].tags #=> Array
resp.verified_access_instances[0].tags[0].key #=> String
resp.verified_access_instances[0].tags[0].value #=> String
resp.verified_access_instances[0].fips_enabled #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_instance_ids (Array<String>) —

    The IDs of the Verified Access instances.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

  • :dry_run (Boolean) —

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

Returns:

See Also:



36474
36475
36476
36477
 
# File 'lib/aws-sdk-ec2/client.rb', line 36474

def describe_verified_access_instances(params = {}, options = {})
  req = build_request(:describe_verified_access_instances, params)
  req.send_request(options)
end

#describe_verified_access_trust_providers(params = {}) ⇒ Types::DescribeVerifiedAccessTrustProvidersResult

Describes the specified Amazon Web Services Verified Access trust providers.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_verified_access_trust_providers({
  verified_access_trust_provider_ids: ["VerifiedAccessTrustProviderId"],
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.verified_access_trust_providers #=> Array
resp.verified_access_trust_providers[0].verified_access_trust_provider_id #=> String
resp.verified_access_trust_providers[0].description #=> String
resp.verified_access_trust_providers[0].trust_provider_type #=> String, one of "user", "device"
resp.verified_access_trust_providers[0].user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_trust_providers[0].device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_trust_providers[0].oidc_options.issuer #=> String
resp.verified_access_trust_providers[0].oidc_options.authorization_endpoint #=> String
resp.verified_access_trust_providers[0].oidc_options.token_endpoint #=> String
resp.verified_access_trust_providers[0].oidc_options. #=> String
resp.verified_access_trust_providers[0].oidc_options.client_id #=> String
resp.verified_access_trust_providers[0].oidc_options.client_secret #=> String
resp.verified_access_trust_providers[0].oidc_options.scope #=> String
resp.verified_access_trust_providers[0].device_options.tenant_id #=> String
resp.verified_access_trust_providers[0].device_options.public_signing_key_url #=> String
resp.verified_access_trust_providers[0].policy_reference_name #=> String
resp.verified_access_trust_providers[0].creation_time #=> String
resp.verified_access_trust_providers[0].last_updated_time #=> String
resp.verified_access_trust_providers[0].tags #=> Array
resp.verified_access_trust_providers[0].tags[0].key #=> String
resp.verified_access_trust_providers[0].tags[0].value #=> String
resp.verified_access_trust_providers[0].sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_trust_providers[0].sse_specification.kms_key_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_trust_provider_ids (Array<String>) —

    The IDs of the Verified Access trust providers.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

  • :dry_run (Boolean) —

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

Returns:

See Also:



36555
36556
36557
36558
 
# File 'lib/aws-sdk-ec2/client.rb', line 36555

def describe_verified_access_trust_providers(params = {}, options = {})
  req = build_request(:describe_verified_access_trust_providers, params)
  req.send_request(options)
end

#describe_volume_attribute(params = {}) ⇒ Types::DescribeVolumeAttributeResult

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see [Amazon EBS volumes] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes.html

Examples:

Example: To describe a volume attribute


# This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.

resp = client.describe_volume_attribute({
  attribute: "autoEnableIO", 
  volume_id: "vol-049df61146c4d7901", 
})

resp.to_h outputs the following:
{
  auto_enable_io: {
    value: false, 
  }, 
  volume_id: "vol-049df61146c4d7901", 
}

Request syntax with placeholder values


resp = client.describe_volume_attribute({
  attribute: "autoEnableIO", # required, accepts autoEnableIO, productCodes
  volume_id: "VolumeId", # required
  dry_run: false,
})

Response structure


resp.auto_enable_io.value #=> Boolean
resp.product_codes #=> Array
resp.product_codes[0].product_code_id #=> String
resp.product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"
resp.volume_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute (required, String) —

    The attribute of the volume. This parameter is required.

  • :volume_id (required, String) —

    The ID of the volume.

  • :dry_run (Boolean) —

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

Returns:

See Also:



36626
36627
36628
36629
 
# File 'lib/aws-sdk-ec2/client.rb', line 36626

def describe_volume_attribute(params = {}, options = {})
  req = build_request(:describe_volume_attribute, params)
  req.send_request(options)
end

#describe_volume_status(params = {}) ⇒ Types::DescribeVolumeStatusResult

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume’s underlying host. If the volume’s underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The ‘DescribeVolumeStatus` operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ‘ok`, `impaired` , `warning`, or `insufficient-data`. If all checks pass, the overall status of the volume is `ok`. If the check fails, the overall status is `impaired`. If the status is `insufficient-data`, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see [Monitor the status of your volumes] in the *Amazon EBS User Guide*.

Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an ‘impaired` status, then the volume event might be `potential-data-inconsistency`. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.

Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is ‘impaired` and the volume event shows `potential-data-inconsistency`, then the action shows `enable-volume-io`. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the ‘error` state (for example, when a volume is incapable of accepting I/O.)

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-status.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe the status of a single volume


# This example describes the status for the volume ``vol-1234567890abcdef0``.

resp = client.describe_volume_status({
  volume_ids: [
    "vol-1234567890abcdef0", 
  ], 
})

resp.to_h outputs the following:
{
  volume_statuses: [
    {
      actions: [
      ], 
      availability_zone: "us-east-1a", 
      events: [
      ], 
      volume_id: "vol-1234567890abcdef0", 
      volume_status: {
        details: [
          {
            name: "io-enabled", 
            status: "passed", 
          }, 
          {
            name: "io-performance", 
            status: "not-applicable", 
          }, 
        ], 
        status: "ok", 
      }, 
    }, 
  ], 
}

Example: To describe the status of impaired volumes


# This example describes the status for all volumes that are impaired. In this example output, there are no impaired
# volumes.

resp = client.describe_volume_status({
  filters: [
    {
      name: "volume-status.status", 
      values: [
        "impaired", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  volume_statuses: [
  ], 
}

Request syntax with placeholder values


resp = client.describe_volume_status({
  max_results: 1,
  next_token: "String",
  volume_ids: ["VolumeId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.volume_statuses #=> Array
resp.volume_statuses[0].actions #=> Array
resp.volume_statuses[0].actions[0].code #=> String
resp.volume_statuses[0].actions[0].description #=> String
resp.volume_statuses[0].actions[0].event_id #=> String
resp.volume_statuses[0].actions[0].event_type #=> String
resp.volume_statuses[0].availability_zone #=> String
resp.volume_statuses[0].outpost_arn #=> String
resp.volume_statuses[0].events #=> Array
resp.volume_statuses[0].events[0].description #=> String
resp.volume_statuses[0].events[0].event_id #=> String
resp.volume_statuses[0].events[0].event_type #=> String
resp.volume_statuses[0].events[0].not_after #=> Time
resp.volume_statuses[0].events[0].not_before #=> Time
resp.volume_statuses[0].events[0].instance_id #=> String
resp.volume_statuses[0].volume_id #=> String
resp.volume_statuses[0].volume_status.details #=> Array
resp.volume_statuses[0].volume_status.details[0].name #=> String, one of "io-enabled", "io-performance"
resp.volume_statuses[0].volume_status.details[0].status #=> String
resp.volume_statuses[0].volume_status.status #=> String, one of "ok", "impaired", "insufficient-data"
resp.volume_statuses[0].attachment_statuses #=> Array
resp.volume_statuses[0].attachment_statuses[0].io_performance #=> String
resp.volume_statuses[0].attachment_statuses[0].instance_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :volume_ids (Array<String>) —

    The IDs of the volumes.

    Default: Describes all your volumes.

  • :dry_run (Boolean) —

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

    The filters.

    • ‘action.code` - The action code for the event (for example, `enable-volume-io`).

    • ‘action.description` - A description of the action.

    • ‘action.event-id` - The event ID associated with the action.

    • ‘availability-zone` - The Availability Zone of the instance.

    • ‘event.description` - A description of the event.

    • ‘event.event-id` - The event ID.

    • ‘event.event-type` - The event type (for `io-enabled`: `passed` | `failed`; for `io-performance`: `io-performance:degraded` | `io-performance:severely-degraded` | `io-performance:stalled`).

    • ‘event.not-after` - The latest end time for the event.

    • ‘event.not-before` - The earliest start time for the event.

    • ‘volume-status.details-name` - The cause for `volume-status.status` (`io-enabled` | `io-performance`).

    • ‘volume-status.details-status` - The status of `volume-status.details-name` (for `io-enabled`: `passed` | `failed`; for `io-performance`: `normal` | `degraded` | `severely-degraded` | `stalled`).

    • ‘volume-status.status` - The status of the volume (`ok` | `impaired` | `warning` | `insufficient-data`).

Returns:

See Also:



36854
36855
36856
36857
 
# File 'lib/aws-sdk-ec2/client.rb', line 36854

def describe_volume_status(params = {}, options = {})
  req = build_request(:describe_volume_status, params)
  req.send_request(options)
end

#describe_volumes(params = {}) ⇒ Types::DescribeVolumesResult

Describes the specified EBS volumes or all of your EBS volumes.

If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see [Pagination].

For more information about EBS volumes, see [Amazon EBS volumes] in the *Amazon EBS User Guide*.

We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination [2]: docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* volume_available
* volume_deleted
* volume_in_use

Examples:

Example: To describe all volumes


# This example describes all of your volumes in the default region.

resp = client.describe_volumes({
})

resp.to_h outputs the following:
{
  next_token: "", 
  volumes: [
    {
      attachments: [
        {
          attach_time: Time.parse("2013-12-18T22:35:00.000Z"), 
          delete_on_termination: true, 
          device: "/dev/sda1", 
          instance_id: "i-1234567890abcdef0", 
          state: "attached", 
          volume_id: "vol-049df61146c4d7901", 
        }, 
      ], 
      availability_zone: "us-east-1a", 
      create_time: Time.parse("2013-12-18T22:35:00.084Z"), 
      size: 8, 
      snapshot_id: "snap-1234567890abcdef0", 
      state: "in-use", 
      volume_id: "vol-049df61146c4d7901", 
      volume_type: "standard", 
    }, 
  ], 
}

Example: To describe volumes that are attached to a specific instance


# This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to
# delete when the instance terminates.

resp = client.describe_volumes({
  filters: [
    {
      name: "attachment.instance-id", 
      values: [
        "i-1234567890abcdef0", 
      ], 
    }, 
    {
      name: "attachment.delete-on-termination", 
      values: [
        "true", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  volumes: [
    {
      attachments: [
        {
          attach_time: Time.parse("2013-12-18T22:35:00.000Z"), 
          delete_on_termination: true, 
          device: "/dev/sda1", 
          instance_id: "i-1234567890abcdef0", 
          state: "attached", 
          volume_id: "vol-049df61146c4d7901", 
        }, 
      ], 
      availability_zone: "us-east-1a", 
      create_time: Time.parse("2013-12-18T22:35:00.084Z"), 
      size: 8, 
      snapshot_id: "snap-1234567890abcdef0", 
      state: "in-use", 
      volume_id: "vol-049df61146c4d7901", 
      volume_type: "standard", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_volumes({
  volume_ids: ["VolumeId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.volumes #=> Array
resp.volumes[0].outpost_arn #=> String
resp.volumes[0].iops #=> Integer
resp.volumes[0].tags #=> Array
resp.volumes[0].tags[0].key #=> String
resp.volumes[0].tags[0].value #=> String
resp.volumes[0].volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.volumes[0].fast_restored #=> Boolean
resp.volumes[0].multi_attach_enabled #=> Boolean
resp.volumes[0].throughput #=> Integer
resp.volumes[0].sse_type #=> String, one of "sse-ebs", "sse-kms", "none"
resp.volumes[0].volume_id #=> String
resp.volumes[0].size #=> Integer
resp.volumes[0].snapshot_id #=> String
resp.volumes[0].availability_zone #=> String
resp.volumes[0].state #=> String, one of "creating", "available", "in-use", "deleting", "deleted", "error"
resp.volumes[0].create_time #=> Time
resp.volumes[0].attachments #=> Array
resp.volumes[0].attachments[0].delete_on_termination #=> Boolean
resp.volumes[0].attachments[0].associated_resource #=> String
resp.volumes[0].attachments[0].instance_owning_service #=> String
resp.volumes[0].attachments[0].volume_id #=> String
resp.volumes[0].attachments[0].instance_id #=> String
resp.volumes[0].attachments[0].device #=> String
resp.volumes[0].attachments[0].state #=> String, one of "attaching", "attached", "detaching", "detached", "busy"
resp.volumes[0].attachments[0].attach_time #=> Time
resp.volumes[0].encrypted #=> Boolean
resp.volumes[0].kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :volume_ids (Array<String>) —

    The volume IDs. If not specified, then all volumes are included in the response.

  • :dry_run (Boolean) —

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

    The filters.

    • ‘attachment.attach-time` - The time stamp when the attachment initiated.

    • ‘attachment.delete-on-termination` - Whether the volume is deleted on instance termination.

    • ‘attachment.device` - The device name specified in the block device mapping (for example, `/dev/sda1`).

    • ‘attachment.instance-id` - The ID of the instance the volume is attached to.

    • ‘attachment.status` - The attachment state (`attaching` | `attached` | `detaching`).

    • ‘availability-zone` - The Availability Zone in which the volume was created.

    • ‘create-time` - The time stamp when the volume was created.

    • ‘encrypted` - Indicates whether the volume is encrypted (`true` | `false`)

    • ‘multi-attach-enabled` - Indicates whether the volume is enabled for Multi-Attach (`true` | `false`)

    • ‘fast-restored` - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (`true` | `false`).

    • ‘size` - The size of the volume, in GiB.

    • ‘snapshot-id` - The snapshot from which the volume was created.

    • ‘status` - The state of the volume (`creating` | `available` | `in-use` | `deleting` | `deleted` | `error`).

    • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • ‘volume-id` - The volume ID.

    • ‘volume-type` - The Amazon EBS volume type (`gp2` | `gp3` | `io1` | `io2` | `st1` | `sc1`| `standard`)

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



37106
37107
37108
37109
 
# File 'lib/aws-sdk-ec2/client.rb', line 37106

def describe_volumes(params = {}, options = {})
  req = build_request(:describe_volumes, params)
  req.send_request(options)
end

#describe_volumes_modifications(params = {}) ⇒ Types::DescribeVolumesModificationsResult

Describes the most recent volume modification request for the specified EBS volumes.

For more information, see [ Monitor the progress of volume modifications] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_volumes_modifications({
  dry_run: false,
  volume_ids: ["VolumeId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.volumes_modifications #=> Array
resp.volumes_modifications[0].volume_id #=> String
resp.volumes_modifications[0].modification_state #=> String, one of "modifying", "optimizing", "completed", "failed"
resp.volumes_modifications[0].status_message #=> String
resp.volumes_modifications[0].target_size #=> Integer
resp.volumes_modifications[0].target_iops #=> Integer
resp.volumes_modifications[0].target_volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.volumes_modifications[0].target_throughput #=> Integer
resp.volumes_modifications[0].target_multi_attach_enabled #=> Boolean
resp.volumes_modifications[0].original_size #=> Integer
resp.volumes_modifications[0].original_iops #=> Integer
resp.volumes_modifications[0].original_volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.volumes_modifications[0].original_throughput #=> Integer
resp.volumes_modifications[0].original_multi_attach_enabled #=> Boolean
resp.volumes_modifications[0].progress #=> Integer
resp.volumes_modifications[0].start_time #=> Time
resp.volumes_modifications[0].end_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :volume_ids (Array<String>) —

    The IDs of the volumes.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘modification-state` - The current modification state (modifying | optimizing | completed | failed).

    • ‘original-iops` - The original IOPS rate of the volume.

    • ‘original-size` - The original size of the volume, in GiB.

    • ‘original-volume-type` - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).

    • ‘originalMultiAttachEnabled` - Indicates whether Multi-Attach support was enabled (true | false).

    • ‘start-time` - The modification start time.

    • ‘target-iops` - The target IOPS rate of the volume.

    • ‘target-size` - The target size of the volume, in GiB.

    • ‘target-volume-type` - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).

    • ‘targetMultiAttachEnabled` - Indicates whether Multi-Attach support is to be enabled (true | false).

    • ‘volume-id` - The ID of the volume.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (Integer) —

    The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see [Pagination].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

See Also:



37219
37220
37221
37222
 
# File 'lib/aws-sdk-ec2/client.rb', line 37219

def describe_volumes_modifications(params = {}, options = {})
  req = build_request(:describe_volumes_modifications, params)
  req.send_request(options)
end

#describe_vpc_attribute(params = {}) ⇒ Types::DescribeVpcAttributeResult

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

Examples:

Example: To describe the enableDnsSupport attribute


# This example describes the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for
# the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their
# corresponding IP addresses; otherwise, it does not.

resp = client.describe_vpc_attribute({
  attribute: "enableDnsSupport", 
  vpc_id: "vpc-a01106c2", 
})

resp.to_h outputs the following:
{
  enable_dns_support: {
    value: true, 
  }, 
  vpc_id: "vpc-a01106c2", 
}

Example: To describe the enableDnsHostnames attribute


# This example describes the enableDnsHostnames attribute. This attribute indicates whether the instances launched in the
# VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

resp = client.describe_vpc_attribute({
  attribute: "enableDnsHostnames", 
  vpc_id: "vpc-a01106c2", 
})

resp.to_h outputs the following:
{
  enable_dns_hostnames: {
    value: true, 
  }, 
  vpc_id: "vpc-a01106c2", 
}

Request syntax with placeholder values


resp = client.describe_vpc_attribute({
  attribute: "enableDnsSupport", # required, accepts enableDnsSupport, enableDnsHostnames, enableNetworkAddressUsageMetrics
  vpc_id: "VpcId", # required
  dry_run: false,
})

Response structure


resp.enable_dns_hostnames.value #=> Boolean
resp.enable_dns_support.value #=> Boolean
resp.enable_network_address_usage_metrics.value #=> Boolean
resp.vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute (required, String) —

    The VPC attribute.

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :dry_run (Boolean) —

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

Returns:

See Also:



37303
37304
37305
37306
 
# File 'lib/aws-sdk-ec2/client.rb', line 37303

def describe_vpc_attribute(params = {}, options = {})
  req = build_request(:describe_vpc_attribute, params)
  req.send_request(options)
end

#describe_vpc_classic_link(params = {}) ⇒ Types::DescribeVpcClassicLinkResult

<note markdown=“1”> This action is deprecated.

</note>

Describes the ClassicLink status of the specified VPCs.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_classic_link({
  dry_run: false,
  vpc_ids: ["VpcId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.vpcs #=> Array
resp.vpcs[0].classic_link_enabled #=> Boolean
resp.vpcs[0].tags #=> Array
resp.vpcs[0].tags[0].key #=> String
resp.vpcs[0].tags[0].value #=> String
resp.vpcs[0].vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_ids (Array<String>) —

    The VPCs for which you want to describe the ClassicLink status.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘is-classic-link-enabled` - Whether the VPC is enabled for ClassicLink (`true` | `false`).

    • ‘tag`:&lt;key&gt; - 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.

Returns:

See Also:



37369
37370
37371
37372
 
# File 'lib/aws-sdk-ec2/client.rb', line 37369

def describe_vpc_classic_link(params = {}, options = {})
  req = build_request(:describe_vpc_classic_link, params)
  req.send_request(options)
end

#describe_vpc_classic_link_dns_support(params = {}) ⇒ Types::DescribeVpcClassicLinkDnsSupportResult

<note markdown=“1”> This action is deprecated.

</note>

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it’s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_classic_link_dns_support({
  vpc_ids: ["VpcId"],
  max_results: 1,
  next_token: "DescribeVpcClassicLinkDnsSupportNextToken",
})

Response structure


resp.next_token #=> String
resp.vpcs #=> Array
resp.vpcs[0].classic_link_dns_supported #=> Boolean
resp.vpcs[0].vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_ids (Array<String>) —

    The IDs of the VPCs.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



37427
37428
37429
37430
 
# File 'lib/aws-sdk-ec2/client.rb', line 37427

def describe_vpc_classic_link_dns_support(params = {}, options = {})
  req = build_request(:describe_vpc_classic_link_dns_support, params)
  req.send_request(options)
end

#describe_vpc_endpoint_connection_notifications(params = {}) ⇒ Types::DescribeVpcEndpointConnectionNotificationsResult

Describes the connection notifications for VPC endpoints and VPC endpoint services.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_endpoint_connection_notifications({
  dry_run: false,
  connection_notification_id: "ConnectionNotificationId",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.connection_notification_set #=> Array
resp.connection_notification_set[0].connection_notification_id #=> String
resp.connection_notification_set[0].service_id #=> String
resp.connection_notification_set[0].vpc_endpoint_id #=> String
resp.connection_notification_set[0].connection_notification_type #=> String, one of "Topic"
resp.connection_notification_set[0].connection_notification_arn #=> String
resp.connection_notification_set[0].connection_events #=> Array
resp.connection_notification_set[0].connection_events[0] #=> String
resp.connection_notification_set[0].connection_notification_state #=> String, one of "Enabled", "Disabled"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :connection_notification_id (String) —

    The ID of the notification.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘connection-notification-arn` - The ARN of the SNS topic for the notification.

    • ‘connection-notification-id` - The ID of the notification.

    • ‘connection-notification-state` - The state of the notification (`Enabled` | `Disabled`).

    • ‘connection-notification-type` - The type of notification (`Topic`).

    • ‘service-id` - The ID of the endpoint service.

    • ‘vpc-endpoint-id` - The ID of the VPC endpoint.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned ‘NextToken` value.

  • :next_token (String) —

    The token to request the next page of results.

Returns:

See Also:



37508
37509
37510
37511
 
# File 'lib/aws-sdk-ec2/client.rb', line 37508

def describe_vpc_endpoint_connection_notifications(params = {}, options = {})
  req = build_request(:describe_vpc_endpoint_connection_notifications, params)
  req.send_request(options)
end

#describe_vpc_endpoint_connections(params = {}) ⇒ Types::DescribeVpcEndpointConnectionsResult

Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_endpoint_connections({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.vpc_endpoint_connections #=> Array
resp.vpc_endpoint_connections[0].service_id #=> String
resp.vpc_endpoint_connections[0].vpc_endpoint_id #=> String
resp.vpc_endpoint_connections[0].vpc_endpoint_owner #=> String
resp.vpc_endpoint_connections[0].vpc_endpoint_state #=> String, one of "PendingAcceptance", "Pending", "Available", "Deleting", "Deleted", "Rejected", "Failed", "Expired"
resp.vpc_endpoint_connections[0].creation_timestamp #=> Time
resp.vpc_endpoint_connections[0].dns_entries #=> Array
resp.vpc_endpoint_connections[0].dns_entries[0].dns_name #=> String
resp.vpc_endpoint_connections[0].dns_entries[0].hosted_zone_id #=> String
resp.vpc_endpoint_connections[0].network_load_balancer_arns #=> Array
resp.vpc_endpoint_connections[0].network_load_balancer_arns[0] #=> String
resp.vpc_endpoint_connections[0].gateway_load_balancer_arns #=> Array
resp.vpc_endpoint_connections[0].gateway_load_balancer_arns[0] #=> String
resp.vpc_endpoint_connections[0].ip_address_type #=> String, one of "ipv4", "dualstack", "ipv6"
resp.vpc_endpoint_connections[0].vpc_endpoint_connection_id #=> String
resp.vpc_endpoint_connections[0].tags #=> Array
resp.vpc_endpoint_connections[0].tags[0].key #=> String
resp.vpc_endpoint_connections[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The filters.

    • ‘ip-address-type` - The IP address type (`ipv4` | `ipv6`).

    • ‘service-id` - The ID of the service.

    • ‘vpc-endpoint-owner` - The ID of the Amazon Web Services account ID that owns the endpoint.

    • ‘vpc-endpoint-state` - The state of the endpoint (`pendingAcceptance` | `pending` | `available` | `deleting` | `deleted` | `rejected` | `failed`).

    • ‘vpc-endpoint-id` - The ID of the endpoint.

  • :max_results (Integer) —

    The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned ‘NextToken` value. This value can be between 5 and 1,000; if `MaxResults` is given a value larger than 1,000, only 1,000 results are returned.

  • :next_token (String) —

    The token to retrieve the next page of results.

Returns:

See Also:



37595
37596
37597
37598
 
# File 'lib/aws-sdk-ec2/client.rb', line 37595

def describe_vpc_endpoint_connections(params = {}, options = {})
  req = build_request(:describe_vpc_endpoint_connections, params)
  req.send_request(options)
end

#describe_vpc_endpoint_service_configurations(params = {}) ⇒ Types::DescribeVpcEndpointServiceConfigurationsResult

Describes the VPC endpoint service configurations in your account (your services).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_endpoint_service_configurations({
  dry_run: false,
  service_ids: ["VpcEndpointServiceId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.service_configurations #=> Array
resp.service_configurations[0].service_type #=> Array
resp.service_configurations[0].service_type[0].service_type #=> String, one of "Interface", "Gateway", "GatewayLoadBalancer"
resp.service_configurations[0].service_id #=> String
resp.service_configurations[0].service_name #=> String
resp.service_configurations[0].service_state #=> String, one of "Pending", "Available", "Deleting", "Deleted", "Failed"
resp.service_configurations[0].availability_zones #=> Array
resp.service_configurations[0].availability_zones[0] #=> String
resp.service_configurations[0].acceptance_required #=> Boolean
resp.service_configurations[0].manages_vpc_endpoints #=> Boolean
resp.service_configurations[0].network_load_balancer_arns #=> Array
resp.service_configurations[0].network_load_balancer_arns[0] #=> String
resp.service_configurations[0].gateway_load_balancer_arns #=> Array
resp.service_configurations[0].gateway_load_balancer_arns[0] #=> String
resp.service_configurations[0].supported_ip_address_types #=> Array
resp.service_configurations[0].supported_ip_address_types[0] #=> String, one of "ipv4", "ipv6"
resp.service_configurations[0].base_endpoint_dns_names #=> Array
resp.service_configurations[0].base_endpoint_dns_names[0] #=> String
resp.service_configurations[0].private_dns_name #=> String
resp.service_configurations[0].private_dns_name_configuration.state #=> String, one of "pendingVerification", "verified", "failed"
resp.service_configurations[0].private_dns_name_configuration.type #=> String
resp.service_configurations[0].private_dns_name_configuration.value #=> String
resp.service_configurations[0].private_dns_name_configuration.name #=> String
resp.service_configurations[0].payer_responsibility #=> String, one of "ServiceOwner"
resp.service_configurations[0].tags #=> Array
resp.service_configurations[0].tags[0].key #=> String
resp.service_configurations[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_ids (Array<String>) —

    The IDs of the endpoint services.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘service-name` - The name of the service.

    • ‘service-id` - The ID of the service.

    • ‘service-state` - The state of the service (`Pending` | `Available` | `Deleting` | `Deleted` | `Failed`).

    • ‘supported-ip-address-types` - The IP address type (`ipv4` | `ipv6`).

    • ‘tag`:&lt;key&gt; - 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.

  • :max_results (Integer) —

    The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned ‘NextToken` value. This value can be between 5 and 1,000; if `MaxResults` is given a value larger than 1,000, only 1,000 results are returned.

  • :next_token (String) —

    The token to retrieve the next page of results.

Returns:

See Also:



37702
37703
37704
37705
 
# File 'lib/aws-sdk-ec2/client.rb', line 37702

def describe_vpc_endpoint_service_configurations(params = {}, options = {})
  req = build_request(:describe_vpc_endpoint_service_configurations, params)
  req.send_request(options)
end

#describe_vpc_endpoint_service_permissions(params = {}) ⇒ Types::DescribeVpcEndpointServicePermissionsResult

Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_endpoint_service_permissions({
  dry_run: false,
  service_id: "VpcEndpointServiceId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.allowed_principals #=> Array
resp.allowed_principals[0].principal_type #=> String, one of "All", "Service", "OrganizationUnit", "Account", "User", "Role"
resp.allowed_principals[0].principal #=> String
resp.allowed_principals[0].service_permission_id #=> String
resp.allowed_principals[0].tags #=> Array
resp.allowed_principals[0].tags[0].key #=> String
resp.allowed_principals[0].tags[0].value #=> String
resp.allowed_principals[0].service_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_id (required, String) —

    The ID of the service.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘principal` - The ARN of the principal.

    • ‘principal-type` - The principal type (`All` | `Service` | `OrganizationUnit` | `Account` | `User` | `Role`).

  • :max_results (Integer) —

    The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned ‘NextToken` value. This value can be between 5 and 1,000; if `MaxResults` is given a value larger than 1,000, only 1,000 results are returned.

  • :next_token (String) —

    The token to retrieve the next page of results.

Returns:

See Also:



37775
37776
37777
37778
 
# File 'lib/aws-sdk-ec2/client.rb', line 37775

def describe_vpc_endpoint_service_permissions(params = {}, options = {})
  req = build_request(:describe_vpc_endpoint_service_permissions, params)
  req.send_request(options)
end

#describe_vpc_endpoint_services(params = {}) ⇒ Types::DescribeVpcEndpointServicesResult

Describes available services to which you can create a VPC endpoint.

When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses ‘us-east-1a` and `us-east-1c` and the consumer uses `us-east-1a` and `us-east-1b`, the response includes the VPC endpoint services in the common Availability Zone, `us-east-1a`.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_endpoint_services({
  dry_run: false,
  service_names: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.service_names #=> Array
resp.service_names[0] #=> String
resp.service_details #=> Array
resp.service_details[0].service_name #=> String
resp.service_details[0].service_id #=> String
resp.service_details[0].service_type #=> Array
resp.service_details[0].service_type[0].service_type #=> String, one of "Interface", "Gateway", "GatewayLoadBalancer"
resp.service_details[0].availability_zones #=> Array
resp.service_details[0].availability_zones[0] #=> String
resp.service_details[0].owner #=> String
resp.service_details[0].base_endpoint_dns_names #=> Array
resp.service_details[0].base_endpoint_dns_names[0] #=> String
resp.service_details[0].private_dns_name #=> String
resp.service_details[0].private_dns_names #=> Array
resp.service_details[0].private_dns_names[0].private_dns_name #=> String
resp.service_details[0].vpc_endpoint_policy_supported #=> Boolean
resp.service_details[0].acceptance_required #=> Boolean
resp.service_details[0].manages_vpc_endpoints #=> Boolean
resp.service_details[0].payer_responsibility #=> String, one of "ServiceOwner"
resp.service_details[0].tags #=> Array
resp.service_details[0].tags[0].key #=> String
resp.service_details[0].tags[0].value #=> String
resp.service_details[0].private_dns_name_verification_state #=> String, one of "pendingVerification", "verified", "failed"
resp.service_details[0].supported_ip_address_types #=> Array
resp.service_details[0].supported_ip_address_types[0] #=> String, one of "ipv4", "ipv6"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_names (Array<String>) —

    The service names.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘owner` - The ID or alias of the Amazon Web Services account that owns the service.

    • ‘service-name` - The name of the service.

    • ‘service-type` - The type of service (`Interface` | `Gateway` | `GatewayLoadBalancer`).

    • ‘supported-ip-address-types` - The IP address type (`ipv4` | `ipv6`).

    • ‘tag`:&lt;key&gt; - 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.

  • :max_results (Integer) —

    The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

    Constraint: If the value is greater than 1,000, we return only 1,000 items.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a prior call.)

Returns:

See Also:



37889
37890
37891
37892
 
# File 'lib/aws-sdk-ec2/client.rb', line 37889

def describe_vpc_endpoint_services(params = {}, options = {})
  req = build_request(:describe_vpc_endpoint_services, params)
  req.send_request(options)
end

#describe_vpc_endpoints(params = {}) ⇒ Types::DescribeVpcEndpointsResult

Describes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_endpoints({
  dry_run: false,
  vpc_endpoint_ids: ["VpcEndpointId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.vpc_endpoints #=> Array
resp.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.vpc_endpoints[0].vpc_endpoint_type #=> String, one of "Interface", "Gateway", "GatewayLoadBalancer"
resp.vpc_endpoints[0].vpc_id #=> String
resp.vpc_endpoints[0].service_name #=> String
resp.vpc_endpoints[0].state #=> String, one of "PendingAcceptance", "Pending", "Available", "Deleting", "Deleted", "Rejected", "Failed", "Expired"
resp.vpc_endpoints[0].policy_document #=> String
resp.vpc_endpoints[0].route_table_ids #=> Array
resp.vpc_endpoints[0].route_table_ids[0] #=> String
resp.vpc_endpoints[0].subnet_ids #=> Array
resp.vpc_endpoints[0].subnet_ids[0] #=> String
resp.vpc_endpoints[0].groups #=> Array
resp.vpc_endpoints[0].groups[0].group_id #=> String
resp.vpc_endpoints[0].groups[0].group_name #=> String
resp.vpc_endpoints[0].ip_address_type #=> String, one of "ipv4", "dualstack", "ipv6"
resp.vpc_endpoints[0].dns_options.dns_record_ip_type #=> String, one of "ipv4", "dualstack", "ipv6", "service-defined"
resp.vpc_endpoints[0].dns_options.private_dns_only_for_inbound_resolver_endpoint #=> Boolean
resp.vpc_endpoints[0].private_dns_enabled #=> Boolean
resp.vpc_endpoints[0].requester_managed #=> Boolean
resp.vpc_endpoints[0].network_interface_ids #=> Array
resp.vpc_endpoints[0].network_interface_ids[0] #=> String
resp.vpc_endpoints[0].dns_entries #=> Array
resp.vpc_endpoints[0].dns_entries[0].dns_name #=> String
resp.vpc_endpoints[0].dns_entries[0].hosted_zone_id #=> String
resp.vpc_endpoints[0].creation_timestamp #=> Time
resp.vpc_endpoints[0].tags #=> Array
resp.vpc_endpoints[0].tags[0].key #=> String
resp.vpc_endpoints[0].tags[0].value #=> String
resp.vpc_endpoints[0].owner_id #=> String
resp.vpc_endpoints[0].last_error.message #=> String
resp.vpc_endpoints[0].last_error.code #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_endpoint_ids (Array<String>) —

    The IDs of the VPC endpoints.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘ip-address-type` - The IP address type (`ipv4` | `ipv6`).

    • ‘service-name` - The name of the service.

    • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • ‘vpc-id` - The ID of the VPC in which the endpoint resides.

    • ‘vpc-endpoint-id` - The ID of the endpoint.

    • ‘vpc-endpoint-state` - The state of the endpoint (`pendingAcceptance` | `pending` | `available` | `deleting` | `deleted` | `rejected` | `failed`).

    • ‘vpc-endpoint-type` - The type of VPC endpoint (`Interface` | `Gateway` | `GatewayLoadBalancer`).

  • :max_results (Integer) —

    The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

    Constraint: If the value is greater than 1,000, we return only 1,000 items.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a prior call.)

Returns:

See Also:



38009
38010
38011
38012
 
# File 'lib/aws-sdk-ec2/client.rb', line 38009

def describe_vpc_endpoints(params = {}, options = {})
  req = build_request(:describe_vpc_endpoints, params)
  req.send_request(options)
end

#describe_vpc_peering_connections(params = {}) ⇒ Types::DescribeVpcPeeringConnectionsResult

Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* vpc_peering_connection_deleted
* vpc_peering_connection_exists

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_peering_connections({
  next_token: "String",
  max_results: 1,
  dry_run: false,
  vpc_peering_connection_ids: ["VpcPeeringConnectionId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
})

Response structure


resp.vpc_peering_connections #=> Array
resp.vpc_peering_connections[0].accepter_vpc_info.cidr_block #=> String
resp.vpc_peering_connections[0].accepter_vpc_info.ipv_6_cidr_block_set #=> Array
resp.vpc_peering_connections[0].accepter_vpc_info.ipv_6_cidr_block_set[0].ipv_6_cidr_block #=> String
resp.vpc_peering_connections[0].accepter_vpc_info.cidr_block_set #=> Array
resp.vpc_peering_connections[0].accepter_vpc_info.cidr_block_set[0].cidr_block #=> String
resp.vpc_peering_connections[0].accepter_vpc_info.owner_id #=> String
resp.vpc_peering_connections[0].accepter_vpc_info.peering_options.allow_dns_resolution_from_remote_vpc #=> Boolean
resp.vpc_peering_connections[0].accepter_vpc_info.peering_options.allow_egress_from_local_classic_link_to_remote_vpc #=> Boolean
resp.vpc_peering_connections[0].accepter_vpc_info.peering_options.allow_egress_from_local_vpc_to_remote_classic_link #=> Boolean
resp.vpc_peering_connections[0].accepter_vpc_info.vpc_id #=> String
resp.vpc_peering_connections[0].accepter_vpc_info.region #=> String
resp.vpc_peering_connections[0].expiration_time #=> Time
resp.vpc_peering_connections[0].requester_vpc_info.cidr_block #=> String
resp.vpc_peering_connections[0].requester_vpc_info.ipv_6_cidr_block_set #=> Array
resp.vpc_peering_connections[0].requester_vpc_info.ipv_6_cidr_block_set[0].ipv_6_cidr_block #=> String
resp.vpc_peering_connections[0].requester_vpc_info.cidr_block_set #=> Array
resp.vpc_peering_connections[0].requester_vpc_info.cidr_block_set[0].cidr_block #=> String
resp.vpc_peering_connections[0].requester_vpc_info.owner_id #=> String
resp.vpc_peering_connections[0].requester_vpc_info.peering_options.allow_dns_resolution_from_remote_vpc #=> Boolean
resp.vpc_peering_connections[0].requester_vpc_info.peering_options.allow_egress_from_local_classic_link_to_remote_vpc #=> Boolean
resp.vpc_peering_connections[0].requester_vpc_info.peering_options.allow_egress_from_local_vpc_to_remote_classic_link #=> Boolean
resp.vpc_peering_connections[0].requester_vpc_info.vpc_id #=> String
resp.vpc_peering_connections[0].requester_vpc_info.region #=> String
resp.vpc_peering_connections[0].status.code #=> String, one of "initiating-request", "pending-acceptance", "active", "deleted", "rejected", "failed", "expired", "provisioning", "deleting"
resp.vpc_peering_connections[0].status.message #=> String
resp.vpc_peering_connections[0].tags #=> Array
resp.vpc_peering_connections[0].tags[0].key #=> String
resp.vpc_peering_connections[0].tags[0].value #=> String
resp.vpc_peering_connections[0].vpc_peering_connection_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

  • :vpc_peering_connection_ids (Array<String>) —

    The IDs of the VPC peering connections.

    Default: Describes all your VPC peering connections.

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘accepter-vpc-info.cidr-block` - The IPv4 CIDR block of the accepter VPC.

    • ‘accepter-vpc-info.owner-id` - The ID of the Amazon Web Services account that owns the accepter VPC.

    • ‘accepter-vpc-info.vpc-id` - The ID of the accepter VPC.

    • ‘expiration-time` - The expiration date and time for the VPC peering connection.

    • ‘requester-vpc-info.cidr-block` - The IPv4 CIDR block of the requester’s VPC.

    • ‘requester-vpc-info.owner-id` - The ID of the Amazon Web Services account that owns the requester VPC.

    • ‘requester-vpc-info.vpc-id` - The ID of the requester VPC.

    • ‘status-code` - The status of the VPC peering connection (`pending-acceptance` | `failed` | `expired` | `provisioning` | `active` | `deleting` | `deleted` | `rejected`).

    • ‘status-message` - A message that provides more information about the status of the VPC peering connection, if applicable.

    • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • ‘vpc-peering-connection-id` - The ID of the VPC peering connection.

Returns:

See Also:



38150
38151
38152
38153
 
# File 'lib/aws-sdk-ec2/client.rb', line 38150

def describe_vpc_peering_connections(params = {}, options = {})
  req = build_request(:describe_vpc_peering_connections, params)
  req.send_request(options)
end

#describe_vpcs(params = {}) ⇒ Types::DescribeVpcsResult

Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* vpc_available
* vpc_exists

Examples:

Example: To describe a VPC


# This example describes the specified VPC.

resp = client.describe_vpcs({
  vpc_ids: [
    "vpc-a01106c2", 
  ], 
})

resp.to_h outputs the following:
{
  vpcs: [
    {
      cidr_block: "10.0.0.0/16", 
      dhcp_options_id: "dopt-7a8b9c2d", 
      instance_tenancy: "default", 
      is_default: false, 
      state: "available", 
      tags: [
        {
          key: "Name", 
          value: "MyVPC", 
        }, 
      ], 
      vpc_id: "vpc-a01106c2", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_vpcs({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  vpc_ids: ["VpcId"],
  next_token: "String",
  max_results: 1,
  dry_run: false,
})

Response structure


resp.next_token #=> String
resp.vpcs #=> Array
resp.vpcs[0].owner_id #=> String
resp.vpcs[0].instance_tenancy #=> String, one of "default", "dedicated", "host"
resp.vpcs[0].ipv_6_cidr_block_association_set #=> Array
resp.vpcs[0].ipv_6_cidr_block_association_set[0].association_id #=> String
resp.vpcs[0].ipv_6_cidr_block_association_set[0].ipv_6_cidr_block #=> String
resp.vpcs[0].ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.vpcs[0].ipv_6_cidr_block_association_set[0].ipv_6_cidr_block_state.status_message #=> String
resp.vpcs[0].ipv_6_cidr_block_association_set[0].network_border_group #=> String
resp.vpcs[0].ipv_6_cidr_block_association_set[0].ipv_6_pool #=> String
resp.vpcs[0].ipv_6_cidr_block_association_set[0].ipv_6_address_attribute #=> String, one of "public", "private"
resp.vpcs[0].ipv_6_cidr_block_association_set[0].ip_source #=> String, one of "amazon", "byoip", "none"
resp.vpcs[0].cidr_block_association_set #=> Array
resp.vpcs[0].cidr_block_association_set[0].association_id #=> String
resp.vpcs[0].cidr_block_association_set[0].cidr_block #=> String
resp.vpcs[0].cidr_block_association_set[0].cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.vpcs[0].cidr_block_association_set[0].cidr_block_state.status_message #=> String
resp.vpcs[0].is_default #=> Boolean
resp.vpcs[0].tags #=> Array
resp.vpcs[0].tags[0].key #=> String
resp.vpcs[0].tags[0].value #=> String
resp.vpcs[0].vpc_id #=> String
resp.vpcs[0].state #=> String, one of "pending", "available"
resp.vpcs[0].cidr_block #=> String
resp.vpcs[0].dhcp_options_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    The filters.

    • ‘cidr` - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC’s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, ‘/28`).

    • ‘cidr-block-association.cidr-block` - An IPv4 CIDR block associated with the VPC.

    • ‘cidr-block-association.association-id` - The association ID for an IPv4 CIDR block associated with the VPC.

    • ‘cidr-block-association.state` - The state of an IPv4 CIDR block associated with the VPC.

    • ‘dhcp-options-id` - The ID of a set of DHCP options.

    • ‘ipv6-cidr-block-association.ipv6-cidr-block` - An IPv6 CIDR block associated with the VPC.

    • ‘ipv6-cidr-block-association.ipv6-pool` - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

    • ‘ipv6-cidr-block-association.association-id` - The association ID for an IPv6 CIDR block associated with the VPC.

    • ‘ipv6-cidr-block-association.state` - The state of an IPv6 CIDR block associated with the VPC.

    • ‘is-default` - Indicates whether the VPC is the default VPC.

    • ‘owner-id` - The ID of the Amazon Web Services account that owns the VPC.

    • ‘state` - The state of the VPC (`pending` | `available`).

    • ‘tag`:&lt;key&gt; - 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.

  • :vpc_ids (Array<String>) —

    The IDs of the VPCs.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

Returns:

See Also:



38323
38324
38325
38326
 
# File 'lib/aws-sdk-ec2/client.rb', line 38323

def describe_vpcs(params = {}, options = {})
  req = build_request(:describe_vpcs, params)
  req.send_request(options)
end

#describe_vpn_connections(params = {}) ⇒ Types::DescribeVpnConnectionsResult

Describes one or more of your VPN connections.

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

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html

The following waiters are defined for this operation (see #wait_until for detailed usage):

* vpn_connection_available
* vpn_connection_deleted

Examples:

Request syntax with placeholder values


resp = client.describe_vpn_connections({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  vpn_connection_ids: ["VpnConnectionId"],
  dry_run: false,
})

Response structure


resp.vpn_connections #=> Array
resp.vpn_connections[0].category #=> String
resp.vpn_connections[0].transit_gateway_id #=> String
resp.vpn_connections[0].core_network_arn #=> String
resp.vpn_connections[0].core_network_attachment_arn #=> String
resp.vpn_connections[0].gateway_association_state #=> String, one of "associated", "not-associated", "associating", "disassociating"
resp.vpn_connections[0].options.enable_acceleration #=> Boolean
resp.vpn_connections[0].options.static_routes_only #=> Boolean
resp.vpn_connections[0].options.local_ipv_4_network_cidr #=> String
resp.vpn_connections[0].options.remote_ipv_4_network_cidr #=> String
resp.vpn_connections[0].options.local_ipv_6_network_cidr #=> String
resp.vpn_connections[0].options.remote_ipv_6_network_cidr #=> String
resp.vpn_connections[0].options.outside_ip_address_type #=> String
resp.vpn_connections[0].options.transport_transit_gateway_attachment_id #=> String
resp.vpn_connections[0].options.tunnel_inside_ip_version #=> String, one of "ipv4", "ipv6"
resp.vpn_connections[0].options.tunnel_options #=> Array
resp.vpn_connections[0].options.tunnel_options[0].outside_ip_address #=> String
resp.vpn_connections[0].options.tunnel_options[0].tunnel_inside_cidr #=> String
resp.vpn_connections[0].options.tunnel_options[0].tunnel_inside_ipv_6_cidr #=> String
resp.vpn_connections[0].options.tunnel_options[0].pre_shared_key #=> String
resp.vpn_connections[0].options.tunnel_options[0].phase_1_lifetime_seconds #=> Integer
resp.vpn_connections[0].options.tunnel_options[0].phase_2_lifetime_seconds #=> Integer
resp.vpn_connections[0].options.tunnel_options[0].rekey_margin_time_seconds #=> Integer
resp.vpn_connections[0].options.tunnel_options[0].rekey_fuzz_percentage #=> Integer
resp.vpn_connections[0].options.tunnel_options[0].replay_window_size #=> Integer
resp.vpn_connections[0].options.tunnel_options[0].dpd_timeout_seconds #=> Integer
resp.vpn_connections[0].options.tunnel_options[0].dpd_timeout_action #=> String
resp.vpn_connections[0].options.tunnel_options[0].phase_1_encryption_algorithms #=> Array
resp.vpn_connections[0].options.tunnel_options[0].phase_1_encryption_algorithms[0].value #=> String
resp.vpn_connections[0].options.tunnel_options[0].phase_2_encryption_algorithms #=> Array
resp.vpn_connections[0].options.tunnel_options[0].phase_2_encryption_algorithms[0].value #=> String
resp.vpn_connections[0].options.tunnel_options[0].phase_1_integrity_algorithms #=> Array
resp.vpn_connections[0].options.tunnel_options[0].phase_1_integrity_algorithms[0].value #=> String
resp.vpn_connections[0].options.tunnel_options[0].phase_2_integrity_algorithms #=> Array
resp.vpn_connections[0].options.tunnel_options[0].phase_2_integrity_algorithms[0].value #=> String
resp.vpn_connections[0].options.tunnel_options[0].phase_1_dh_group_numbers #=> Array
resp.vpn_connections[0].options.tunnel_options[0].phase_1_dh_group_numbers[0].value #=> Integer
resp.vpn_connections[0].options.tunnel_options[0].phase_2_dh_group_numbers #=> Array
resp.vpn_connections[0].options.tunnel_options[0].phase_2_dh_group_numbers[0].value #=> Integer
resp.vpn_connections[0].options.tunnel_options[0].ike_versions #=> Array
resp.vpn_connections[0].options.tunnel_options[0].ike_versions[0].value #=> String
resp.vpn_connections[0].options.tunnel_options[0].startup_action #=> String
resp.vpn_connections[0].options.tunnel_options[0].log_options.cloud_watch_log_options.log_enabled #=> Boolean
resp.vpn_connections[0].options.tunnel_options[0].log_options.cloud_watch_log_options.log_group_arn #=> String
resp.vpn_connections[0].options.tunnel_options[0].log_options.cloud_watch_log_options.log_output_format #=> String
resp.vpn_connections[0].options.tunnel_options[0].enable_tunnel_lifecycle_control #=> Boolean
resp.vpn_connections[0].routes #=> Array
resp.vpn_connections[0].routes[0].destination_cidr_block #=> String
resp.vpn_connections[0].routes[0].source #=> String, one of "Static"
resp.vpn_connections[0].routes[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connections[0].tags #=> Array
resp.vpn_connections[0].tags[0].key #=> String
resp.vpn_connections[0].tags[0].value #=> String
resp.vpn_connections[0].vgw_telemetry #=> Array
resp.vpn_connections[0].vgw_telemetry[0].accepted_route_count #=> Integer
resp.vpn_connections[0].vgw_telemetry[0].last_status_change #=> Time
resp.vpn_connections[0].vgw_telemetry[0].outside_ip_address #=> String
resp.vpn_connections[0].vgw_telemetry[0].status #=> String, one of "UP", "DOWN"
resp.vpn_connections[0].vgw_telemetry[0].status_message #=> String
resp.vpn_connections[0].vgw_telemetry[0].certificate_arn #=> String
resp.vpn_connections[0].vpn_connection_id #=> String
resp.vpn_connections[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connections[0].customer_gateway_configuration #=> String
resp.vpn_connections[0].type #=> String, one of "ipsec.1"
resp.vpn_connections[0].customer_gateway_id #=> String
resp.vpn_connections[0].vpn_gateway_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘customer-gateway-configuration` - The configuration information for the customer gateway.

    • ‘customer-gateway-id` - The ID of a customer gateway associated with the VPN connection.

    • ‘state` - The state of the VPN connection (`pending` | `available` | `deleting` | `deleted`).

    • ‘option.static-routes-only` - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

    • ‘route.destination-cidr-block` - The destination CIDR block. This corresponds to the subnet used in a customer data center.

    • ‘bgp-asn` - The BGP Autonomous System Number (ASN) associated with a BGP device.

    • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • ‘type` - The type of VPN connection. Currently the only supported type is `ipsec.1`.

    • ‘vpn-connection-id` - The ID of the VPN connection.

    • ‘vpn-gateway-id` - The ID of a virtual private gateway associated with the VPN connection.

    • ‘transit-gateway-id` - The ID of a transit gateway associated with the VPN connection.

  • :vpn_connection_ids (Array<String>) —

    One or more VPN connection IDs.

    Default: Describes your VPN connections.

  • :dry_run (Boolean) —

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

Returns:

See Also:



38487
38488
38489
38490
 
# File 'lib/aws-sdk-ec2/client.rb', line 38487

def describe_vpn_connections(params = {}, options = {})
  req = build_request(:describe_vpn_connections, params)
  req.send_request(options)
end

#describe_vpn_gateways(params = {}) ⇒ Types::DescribeVpnGatewaysResult

Describes one or more of your virtual private gateways.

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

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html

Examples:

Request syntax with placeholder values


resp = client.describe_vpn_gateways({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  vpn_gateway_ids: ["VpnGatewayId"],
  dry_run: false,
})

Response structure


resp.vpn_gateways #=> Array
resp.vpn_gateways[0].amazon_side_asn #=> Integer
resp.vpn_gateways[0].tags #=> Array
resp.vpn_gateways[0].tags[0].key #=> String
resp.vpn_gateways[0].tags[0].value #=> String
resp.vpn_gateways[0].vpn_gateway_id #=> String
resp.vpn_gateways[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_gateways[0].type #=> String, one of "ipsec.1"
resp.vpn_gateways[0].availability_zone #=> String
resp.vpn_gateways[0].vpc_attachments #=> Array
resp.vpn_gateways[0].vpc_attachments[0].vpc_id #=> String
resp.vpn_gateways[0].vpc_attachments[0].state #=> String, one of "attaching", "attached", "detaching", "detached"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘amazon-side-asn` - The Autonomous System Number (ASN) for the Amazon side of the gateway.

    • ‘attachment.state` - The current state of the attachment between the gateway and the VPC (`attaching` | `attached` | `detaching` | `detached`).

    • ‘attachment.vpc-id` - The ID of an attached VPC.

    • ‘availability-zone` - The Availability Zone for the virtual private gateway (if applicable).

    • ‘state` - The state of the virtual private gateway (`pending` | `available` | `deleting` | `deleted`).

    • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • ‘type` - The type of virtual private gateway. Currently the only supported type is `ipsec.1`.

    • ‘vpn-gateway-id` - The ID of the virtual private gateway.

  • :vpn_gateway_ids (Array<String>) —

    One or more virtual private gateway IDs.

    Default: Describes all your virtual private gateways.

  • :dry_run (Boolean) —

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

Returns:

See Also:



38581
38582
38583
38584
 
# File 'lib/aws-sdk-ec2/client.rb', line 38581

def describe_vpn_gateways(params = {}, options = {})
  req = build_request(:describe_vpn_gateways, params)
  req.send_request(options)
end

#detach_classic_link_vpc(params = {}) ⇒ Types::DetachClassicLinkVpcResult

<note markdown=“1”> This action is deprecated.

</note>

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it’s stopped.

Examples:

Request syntax with placeholder values


resp = client.detach_classic_link_vpc({
  dry_run: false,
  instance_id: "InstanceId", # required
  vpc_id: "VpcId", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the instance to unlink from the VPC.

  • :vpc_id (required, String) —

    The ID of the VPC to which the instance is linked.

Returns:

See Also:



38627
38628
38629
38630
 
# File 'lib/aws-sdk-ec2/client.rb', line 38627

def detach_classic_link_vpc(params = {}, options = {})
  req = build_request(:detach_classic_link_vpc, params)
  req.send_request(options)
end

#detach_internet_gateway(params = {}) ⇒ Struct

Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.

Examples:

Example: To detach an Internet gateway from a VPC


# This example detaches the specified Internet gateway from the specified VPC.

resp = client.detach_internet_gateway({
  internet_gateway_id: "igw-c0a643a9", 
  vpc_id: "vpc-a01106c2", 
})

Request syntax with placeholder values


resp = client.detach_internet_gateway({
  dry_run: false,
  internet_gateway_id: "InternetGatewayId", # required
  vpc_id: "VpcId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :internet_gateway_id (required, String) —

    The ID of the internet gateway.

  • :vpc_id (required, String) —

    The ID of the VPC.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



38672
38673
38674
38675
 
# File 'lib/aws-sdk-ec2/client.rb', line 38672

def detach_internet_gateway(params = {}, options = {})
  req = build_request(:detach_internet_gateway, params)
  req.send_request(options)
end

#detach_network_interface(params = {}) ⇒ Struct

Detaches a network interface from an instance.

Examples:

Example: To detach a network interface from an instance


# This example detaches the specified network interface from its attached instance.

resp = client.detach_network_interface({
  attachment_id: "eni-attach-66c4350a", 
})

Request syntax with placeholder values


resp = client.detach_network_interface({
  dry_run: false,
  attachment_id: "NetworkInterfaceAttachmentId", # required
  force: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :attachment_id (required, String) —

    The ID of the attachment.

  • :force (Boolean) —

    Specifies whether to force a detachment.

    <note markdown=“1”> * Use the ‘Force` parameter only as a last resort to detach a network

    interface from a failed instance.

    • If you use the ‘Force` parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.

    • If you force the detachment of a network interface, the [instance metadata] might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.

    </note>

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



38734
38735
38736
38737
 
# File 'lib/aws-sdk-ec2/client.rb', line 38734

def detach_network_interface(params = {}, options = {})
  req = build_request(:detach_network_interface, params)
  req.send_request(options)
end

#detach_verified_access_trust_provider(params = {}) ⇒ Types::DetachVerifiedAccessTrustProviderResult

Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.

Examples:

Request syntax with placeholder values


resp = client.detach_verified_access_trust_provider({
  verified_access_instance_id: "VerifiedAccessInstanceId", # required
  verified_access_trust_provider_id: "VerifiedAccessTrustProviderId", # required
  client_token: "String",
  dry_run: false,
})

Response structure


resp.verified_access_trust_provider.verified_access_trust_provider_id #=> String
resp.verified_access_trust_provider.description #=> String
resp.verified_access_trust_provider.trust_provider_type #=> String, one of "user", "device"
resp.verified_access_trust_provider.user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_trust_provider.device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_trust_provider.oidc_options.issuer #=> String
resp.verified_access_trust_provider.oidc_options.authorization_endpoint #=> String
resp.verified_access_trust_provider.oidc_options.token_endpoint #=> String
resp.verified_access_trust_provider.oidc_options. #=> String
resp.verified_access_trust_provider.oidc_options.client_id #=> String
resp.verified_access_trust_provider.oidc_options.client_secret #=> String
resp.verified_access_trust_provider.oidc_options.scope #=> String
resp.verified_access_trust_provider.device_options.tenant_id #=> String
resp.verified_access_trust_provider.device_options.public_signing_key_url #=> String
resp.verified_access_trust_provider.policy_reference_name #=> String
resp.verified_access_trust_provider.creation_time #=> String
resp.verified_access_trust_provider.last_updated_time #=> String
resp.verified_access_trust_provider.tags #=> Array
resp.verified_access_trust_provider.tags[0].key #=> String
resp.verified_access_trust_provider.tags[0].value #=> String
resp.verified_access_trust_provider.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_trust_provider.sse_specification.kms_key_arn #=> String
resp.verified_access_instance.verified_access_instance_id #=> String
resp.verified_access_instance.description #=> String
resp.verified_access_instance.verified_access_trust_providers #=> Array
resp.verified_access_instance.verified_access_trust_providers[0].verified_access_trust_provider_id #=> String
resp.verified_access_instance.verified_access_trust_providers[0].description #=> String
resp.verified_access_instance.verified_access_trust_providers[0].trust_provider_type #=> String, one of "user", "device"
resp.verified_access_instance.verified_access_trust_providers[0].user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_instance.verified_access_trust_providers[0].device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_instance.creation_time #=> String
resp.verified_access_instance.last_updated_time #=> String
resp.verified_access_instance.tags #=> Array
resp.verified_access_instance.tags[0].key #=> String
resp.verified_access_instance.tags[0].value #=> String
resp.verified_access_instance.fips_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_instance_id (required, String) —

    The ID of the Verified Access instance.

  • :verified_access_trust_provider_id (required, String) —

    The ID of the Verified Access trust provider.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



38824
38825
38826
38827
 
# File 'lib/aws-sdk-ec2/client.rb', line 38824

def detach_verified_access_trust_provider(params = {}, options = {})
  req = build_request(:detach_verified_access_trust_provider, params)
  req.send_request(options)
end

#detach_volume(params = {}) ⇒ Types::VolumeAttachment

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the ‘busy` state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can’t be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

You can’t detach or force detach volumes that are attached to Amazon ECS or Fargate tasks. Attempting to do this results in the ‘UnsupportedOperationException` exception with the `Unable to detach volume attached to ECS tasks` error message.

For more information, see [Detach an Amazon EBS volume] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-detaching-volume.html

Examples:

Example: To detach a volume from an instance


# This example detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to.

resp = client.detach_volume({
  volume_id: "vol-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
  attach_time: Time.parse("2014-02-27T19:23:06.000Z"), 
  device: "/dev/sdb", 
  instance_id: "i-1234567890abcdef0", 
  state: "detaching", 
  volume_id: "vol-049df61146c4d7901", 
}

Request syntax with placeholder values


resp = client.detach_volume({
  device: "String",
  force: false,
  instance_id: "InstanceIdForResolver",
  volume_id: "VolumeIdWithResolver", # required
  dry_run: false,
})

Response structure


resp.delete_on_termination #=> Boolean
resp.associated_resource #=> String
resp.instance_owning_service #=> String
resp.volume_id #=> String
resp.instance_id #=> String
resp.device #=> String
resp.state #=> String, one of "attaching", "attached", "detaching", "detached", "busy"
resp.attach_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device (String) —

    The device name.

  • :force (Boolean) —

    Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won’t have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

  • :instance_id (String) —

    The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

  • :volume_id (required, String) —

    The ID of the volume.

  • :dry_run (Boolean) —

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

Returns:

See Also:



38934
38935
38936
38937
 
# File 'lib/aws-sdk-ec2/client.rb', line 38934

def detach_volume(params = {}, options = {})
  req = build_request(:detach_volume, params)
  req.send_request(options)
end

#detach_vpn_gateway(params = {}) ⇒ Struct

Detaches a virtual private gateway from a VPC. You do this if you’re planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment’s state to switch to ‘detached` before you can delete the VPC or attach a different VPC to the virtual private gateway.

Examples:

Request syntax with placeholder values


resp = client.detach_vpn_gateway({
  vpc_id: "VpcId", # required
  vpn_gateway_id: "VpnGatewayId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :vpn_gateway_id (required, String) —

    The ID of the virtual private gateway.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



38975
38976
38977
38978
 
# File 'lib/aws-sdk-ec2/client.rb', line 38975

def detach_vpn_gateway(params = {}, options = {})
  req = build_request(:detach_vpn_gateway, params)
  req.send_request(options)
end

#disable_address_transfer(params = {}) ⇒ Types::DisableAddressTransferResult

Disables Elastic IP address transfer. For more information, see

Transfer Elastic IP addresses][1

in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro

Examples:

Request syntax with placeholder values


resp = client.disable_address_transfer({
  allocation_id: "AllocationId", # required
  dry_run: false,
})

Response structure


resp.address_transfer.public_ip #=> String
resp.address_transfer.allocation_id #=> String
resp.address_transfer. #=> String
resp.address_transfer.transfer_offer_expiration_timestamp #=> Time
resp.address_transfer.transfer_offer_accepted_timestamp #=> Time
resp.address_transfer.address_transfer_status #=> String, one of "pending", "disabled", "accepted"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_id (required, String) —

    The allocation ID of an Elastic IP address.

  • :dry_run (Boolean) —

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

Returns:

See Also:



39020
39021
39022
39023
 
# File 'lib/aws-sdk-ec2/client.rb', line 39020

def disable_address_transfer(params = {}, options = {})
  req = build_request(:disable_address_transfer, params)
  req.send_request(options)
end

#disable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::DisableAwsNetworkPerformanceMetricSubscriptionResult

Disables Infrastructure Performance metric subscriptions.

Examples:

Request syntax with placeholder values


resp = client.disable_aws_network_performance_metric_subscription({
  source: "String",
  destination: "String",
  metric: "aggregate-latency", # accepts aggregate-latency
  statistic: "p50", # accepts p50
  dry_run: false,
})

Response structure


resp.output #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source (String) —

    The source Region or Availability Zone that the metric subscription is disabled for. For example, ‘us-east-1`.

  • :destination (String) —

    The target Region or Availability Zone that the metric subscription is disabled for. For example, ‘eu-north-1`.

  • :metric (String) —

    The metric used for the disabled subscription.

  • :statistic (String) —

    The statistic used for the disabled subscription.

  • :dry_run (Boolean) —

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

Returns:

See Also:



39069
39070
39071
39072
 
# File 'lib/aws-sdk-ec2/client.rb', line 39069

def disable_aws_network_performance_metric_subscription(params = {}, options = {})
  req = build_request(:disable_aws_network_performance_metric_subscription, params)
  req.send_request(options)
end

#disable_ebs_encryption_by_default(params = {}) ⇒ Types::DisableEbsEncryptionByDefaultResult

Disables EBS encryption by default for your account in the current Region.

After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.

Disabling encryption by default does not change the encryption status of your existing volumes.

For more information, see [Amazon EBS encryption] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html

Examples:

Request syntax with placeholder values


resp = client.disable_ebs_encryption_by_default({
  dry_run: false,
})

Response structure


resp.ebs_encryption_by_default #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



39114
39115
39116
39117
 
# File 'lib/aws-sdk-ec2/client.rb', line 39114

def disable_ebs_encryption_by_default(params = {}, options = {})
  req = build_request(:disable_ebs_encryption_by_default, params)
  req.send_request(options)
end

#disable_fast_launch(params = {}) ⇒ Types::DisableFastLaunchResult

Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable Windows fast launch again.

<note markdown=“1”> You can only change these settings for Windows AMIs that you own or that have been shared with you.

</note>

Examples:

Request syntax with placeholder values


resp = client.disable_fast_launch({
  image_id: "ImageId", # required
  force: false,
  dry_run: false,
})

Response structure


resp.image_id #=> String
resp.resource_type #=> String, one of "snapshot"
resp.snapshot_configuration.target_resource_count #=> Integer
resp.launch_template.launch_template_id #=> String
resp.launch_template.launch_template_name #=> String
resp.launch_template.version #=> String
resp.max_parallel_launches #=> Integer
resp.owner_id #=> String
resp.state #=> String, one of "enabling", "enabling-failed", "enabled", "enabled-failed", "disabling", "disabling-failed"
resp.state_transition_reason #=> String
resp.state_transition_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    Specify the ID of the image for which to disable Windows fast launch.

  • :force (Boolean) —

    Forces the image settings to turn off Windows fast launch for your Windows AMI. This parameter overrides any errors that are encountered while cleaning up resources in your account.

  • :dry_run (Boolean) —

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

Returns:

See Also:



39182
39183
39184
39185
 
# File 'lib/aws-sdk-ec2/client.rb', line 39182

def disable_fast_launch(params = {}, options = {})
  req = build_request(:disable_fast_launch, params)
  req.send_request(options)
end

#disable_fast_snapshot_restores(params = {}) ⇒ Types::DisableFastSnapshotRestoresResult

Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.

Examples:

Request syntax with placeholder values


resp = client.disable_fast_snapshot_restores({
  availability_zones: ["String"], # required
  source_snapshot_ids: ["SnapshotId"], # required
  dry_run: false,
})

Response structure


resp.successful #=> Array
resp.successful[0].snapshot_id #=> String
resp.successful[0].availability_zone #=> String
resp.successful[0].state #=> String, one of "enabling", "optimizing", "enabled", "disabling", "disabled"
resp.successful[0].state_transition_reason #=> String
resp.successful[0].owner_id #=> String
resp.successful[0].owner_alias #=> String
resp.successful[0].enabling_time #=> Time
resp.successful[0].optimizing_time #=> Time
resp.successful[0].enabled_time #=> Time
resp.successful[0].disabling_time #=> Time
resp.successful[0].disabled_time #=> Time
resp.unsuccessful #=> Array
resp.unsuccessful[0].snapshot_id #=> String
resp.unsuccessful[0].fast_snapshot_restore_state_errors #=> Array
resp.unsuccessful[0].fast_snapshot_restore_state_errors[0].availability_zone #=> String
resp.unsuccessful[0].fast_snapshot_restore_state_errors[0].error.code #=> String
resp.unsuccessful[0].fast_snapshot_restore_state_errors[0].error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :availability_zones (required, Array<String>) —

    One or more Availability Zones. For example, ‘us-east-2a`.

  • :source_snapshot_ids (required, Array<String>) —

    The IDs of one or more snapshots. For example, ‘snap-1234567890abcdef0`.

  • :dry_run (Boolean) —

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

Returns:

See Also:



39241
39242
39243
39244
 
# File 'lib/aws-sdk-ec2/client.rb', line 39241

def disable_fast_snapshot_restores(params = {}, options = {})
  req = build_request(:disable_fast_snapshot_restores, params)
  req.send_request(options)
end

#disable_image(params = {}) ⇒ Types::DisableImageResult

Sets the AMI state to ‘disabled` and removes all launch permissions from the AMI. A disabled AMI can’t be used for instance launches.

A disabled AMI can’t be shared. If an AMI was public or previously shared, it is made private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit, they lose access to the disabled AMI.

A disabled AMI does not appear in [DescribeImages] API calls by default.

Only the AMI owner can disable an AMI.

You can re-enable a disabled AMI using [EnableImage].

For more information, see [Disable an AMI] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html [2]: amazonaws.com/AWSEC2/latest/APIReference/API_EnableImage.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html

Examples:

Request syntax with placeholder values


resp = client.disable_image({
  image_id: "ImageId", # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI.

  • :dry_run (Boolean) —

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

Returns:

See Also:



39298
39299
39300
39301
 
# File 'lib/aws-sdk-ec2/client.rb', line 39298

def disable_image(params = {}, options = {})
  req = build_request(:disable_image, params)
  req.send_request(options)
end

#disable_image_block_public_access(params = {}) ⇒ Types::DisableImageBlockPublicAccessResult

Disables *block public access for AMIs* at the account level in the specified Amazon Web Services Region. This removes the *block public access* restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified Amazon Web Services Region.

The API can take up to 10 minutes to configure this setting. During this time, if you run [GetImageBlockPublicAccessState], the response will be ‘block-new-sharing`. When the API has completed the configuration, the response will be `unblocked`.

For more information, see [Block public access to your AMIs] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetImageBlockPublicAccessState.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis

Examples:

Request syntax with placeholder values


resp = client.disable_image_block_public_access({
  dry_run: false,
})

Response structure


resp.image_block_public_access_state #=> String, one of "unblocked"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



39346
39347
39348
39349
 
# File 'lib/aws-sdk-ec2/client.rb', line 39346

def disable_image_block_public_access(params = {}, options = {})
  req = build_request(:disable_image_block_public_access, params)
  req.send_request(options)
end

#disable_image_deprecation(params = {}) ⇒ Types::DisableImageDeprecationResult

Cancels the deprecation of the specified AMI.

For more information, see [Deprecate an AMI] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html

Examples:

Request syntax with placeholder values


resp = client.disable_image_deprecation({
  image_id: "ImageId", # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI.

  • :dry_run (Boolean) —

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

Returns:

See Also:



39388
39389
39390
39391
 
# File 'lib/aws-sdk-ec2/client.rb', line 39388

def disable_image_deprecation(params = {}, options = {})
  req = build_request(:disable_image_deprecation, params)
  req.send_request(options)
end

#disable_image_deregistration_protection(params = {}) ⇒ Types::DisableImageDeregistrationProtectionResult

Disables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered.

If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you won’t immediately be able to deregister the AMI.

For more information, see [Protect an AMI from deregistration] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html#ami-deregistration-protection

Examples:

Request syntax with placeholder values


resp = client.disable_image_deregistration_protection({
  image_id: "ImageId", # required
  dry_run: false,
})

Response structure


resp.return #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI.

  • :dry_run (Boolean) —

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

Returns:

See Also:



39436
39437
39438
39439
 
# File 'lib/aws-sdk-ec2/client.rb', line 39436

def disable_image_deregistration_protection(params = {}, options = {})
  req = build_request(:disable_image_deregistration_protection, params)
  req.send_request(options)
end

#disable_ipam_organization_admin_account(params = {}) ⇒ Types::DisableIpamOrganizationAdminAccountResult

Disable the IPAM account. For more information, see [Enable integration with Organizations] in the *Amazon VPC IPAM User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html

Examples:

Request syntax with placeholder values


resp = client.({
  dry_run: false,
  delegated_admin_account_id: "String", # required
})

Response structure


resp.success #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :delegated_admin_account_id (required, String) —

    The Organizations member account ID that you want to disable as IPAM account.

Returns:

See Also:



39478
39479
39480
39481
 
# File 'lib/aws-sdk-ec2/client.rb', line 39478

def (params = {}, options = {})
  req = build_request(:disable_ipam_organization_admin_account, params)
  req.send_request(options)
end

#disable_serial_console_access(params = {}) ⇒ Types::DisableSerialConsoleAccessResult

Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see [Manage account access to the EC2 serial console] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access

Examples:

Request syntax with placeholder values


resp = client.disable_serial_console_access({
  dry_run: false,
})

Response structure


resp.serial_console_access_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



39516
39517
39518
39519
 
# File 'lib/aws-sdk-ec2/client.rb', line 39516

def disable_serial_console_access(params = {}, options = {})
  req = build_request(:disable_serial_console_access, params)
  req.send_request(options)
end

#disable_snapshot_block_public_access(params = {}) ⇒ Types::DisableSnapshotBlockPublicAccessResult

Disables the *block public access for snapshots* setting at the account level for the specified Amazon Web Services Region. After you disable block public access for snapshots in a Region, users can publicly share snapshots in that Region.

Enabling block public access for snapshots in block-all-sharing mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available.

If you disable block public access , these snapshots will become

publicly available again.

For more information, see [ Block public access for snapshots] in the *Amazon EBS User Guide* .

[1]: docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html

Examples:

Request syntax with placeholder values


resp = client.disable_snapshot_block_public_access({
  dry_run: false,
})

Response structure


resp.state #=> String, one of "block-all-sharing", "block-new-sharing", "unblocked"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



39569
39570
39571
39572
 
# File 'lib/aws-sdk-ec2/client.rb', line 39569

def disable_snapshot_block_public_access(params = {}, options = {})
  req = build_request(:disable_snapshot_block_public_access, params)
  req.send_request(options)
end

#disable_transit_gateway_route_table_propagation(params = {}) ⇒ Types::DisableTransitGatewayRouteTablePropagationResult

Disables the specified resource attachment from propagating routes to the specified propagation route table.

Examples:

Request syntax with placeholder values


resp = client.disable_transit_gateway_route_table_propagation({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId",
  dry_run: false,
  transit_gateway_route_table_announcement_id: "TransitGatewayRouteTableAnnouncementId",
})

Response structure


resp.propagation.transit_gateway_attachment_id #=> String
resp.propagation.resource_id #=> String
resp.propagation.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.propagation.transit_gateway_route_table_id #=> String
resp.propagation.state #=> String, one of "enabling", "enabled", "disabling", "disabled"
resp.propagation.transit_gateway_route_table_announcement_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the propagation route table.

  • :transit_gateway_attachment_id (String) —

    The ID of the attachment.

  • :dry_run (Boolean) —

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

  • :transit_gateway_route_table_announcement_id (String) —

    The ID of the route table announcement.

Returns:

See Also:



39618
39619
39620
39621
 
# File 'lib/aws-sdk-ec2/client.rb', line 39618

def disable_transit_gateway_route_table_propagation(params = {}, options = {})
  req = build_request(:disable_transit_gateway_route_table_propagation, params)
  req.send_request(options)
end

#disable_vgw_route_propagation(params = {}) ⇒ Struct

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

Examples:

Example: To disable route propagation


# This example disables the specified virtual private gateway from propagating static routes to the specified route table.

resp = client.disable_vgw_route_propagation({
  gateway_id: "vgw-9a4cacf3", 
  route_table_id: "rtb-22574640", 
})

Request syntax with placeholder values


resp = client.disable_vgw_route_propagation({
  gateway_id: "VpnGatewayId", # required
  route_table_id: "RouteTableId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The ID of the virtual private gateway.

  • :route_table_id (required, String) —

    The ID of the route table.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



39662
39663
39664
39665
 
# File 'lib/aws-sdk-ec2/client.rb', line 39662

def disable_vgw_route_propagation(params = {}, options = {})
  req = build_request(:disable_vgw_route_propagation, params)
  req.send_request(options)
end

#disable_vpc_classic_link(params = {}) ⇒ Types::DisableVpcClassicLinkResult

<note markdown=“1”> This action is deprecated.

</note>

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

Examples:

Request syntax with placeholder values


resp = client.disable_vpc_classic_link({
  dry_run: false,
  vpc_id: "VpcId", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_id (required, String) —

    The ID of the VPC.

Returns:

See Also:



39702
39703
39704
39705
 
# File 'lib/aws-sdk-ec2/client.rb', line 39702

def disable_vpc_classic_link(params = {}, options = {})
  req = build_request(:disable_vpc_classic_link, params)
  req.send_request(options)
end

#disable_vpc_classic_link_dns_support(params = {}) ⇒ Types::DisableVpcClassicLinkDnsSupportResult

<note markdown=“1”> This action is deprecated.

</note>

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it’s linked.

You must specify a VPC ID in the request.

Examples:

Request syntax with placeholder values


resp = client.disable_vpc_classic_link_dns_support({
  vpc_id: "VpcId",
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_id (String) —

    The ID of the VPC.

Returns:

See Also:



39738
39739
39740
39741
 
# File 'lib/aws-sdk-ec2/client.rb', line 39738

def disable_vpc_classic_link_dns_support(params = {}, options = {})
  req = build_request(:disable_vpc_classic_link_dns_support, params)
  req.send_request(options)
end

#disassociate_address(params = {}) ⇒ Struct

Disassociates an Elastic IP address from the instance or network interface it’s associated with.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn’t return an error.

Examples:

Example: To disassociate an Elastic IP address


# This example disassociates an Elastic IP address from an instance.

resp = client.disassociate_address({
  association_id: "eipassoc-2bebb745", 
})

Request syntax with placeholder values


resp = client.disassociate_address({
  association_id: "ElasticIpAssociationId",
  public_ip: "EipAllocationPublicIp",
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :association_id (String) —

    The association ID. This parameter is required.

  • :public_ip (String) —

    Deprecated.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



39784
39785
39786
39787
 
# File 'lib/aws-sdk-ec2/client.rb', line 39784

def disassociate_address(params = {}, options = {})
  req = build_request(:disassociate_address, params)
  req.send_request(options)
end

#disassociate_capacity_reservation_billing_owner(params = {}) ⇒ Types::DisassociateCapacityReservationBillingOwnerResult

Cancels a pending request to assign billing of the unused capacity of a Capacity Reservation to a consumer account, or revokes a request that has already been accepted. For more information, see [Billing assignment for shared Amazon EC2 Capacity Reservations].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html

Examples:

Request syntax with placeholder values


resp = client.disassociate_capacity_reservation_billing_owner({
  dry_run: false,
  capacity_reservation_id: "CapacityReservationId", # required
  unused_reservation_billing_owner_id: "AccountID", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation.

  • :unused_reservation_billing_owner_id (required, String) —

    The ID of the consumer account to which the request was sent.

Returns:

See Also:



39830
39831
39832
39833
 
# File 'lib/aws-sdk-ec2/client.rb', line 39830

def disassociate_capacity_reservation_billing_owner(params = {}, options = {})
  req = build_request(:disassociate_capacity_reservation_billing_owner, params)
  req.send_request(options)
end

#disassociate_client_vpn_target_network(params = {}) ⇒ Types::DisassociateClientVpnTargetNetworkResult

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:

  • The route that was automatically added for the VPC is deleted

  • All active client connections are terminated

  • New client connections are disallowed

  • The Client VPN endpoint’s status changes to ‘pending-associate`

Examples:

Request syntax with placeholder values


resp = client.disassociate_client_vpn_target_network({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  association_id: "String", # required
  dry_run: false,
})

Response structure


resp.association_id #=> String
resp.status.code #=> String, one of "associating", "associated", "association-failed", "disassociating", "disassociated"
resp.status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint from which to disassociate the target network.

  • :association_id (required, String) —

    The ID of the target network association.

  • :dry_run (Boolean) —

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

Returns:

See Also:



39883
39884
39885
39886
 
# File 'lib/aws-sdk-ec2/client.rb', line 39883

def disassociate_client_vpn_target_network(params = {}, options = {})
  req = build_request(:disassociate_client_vpn_target_network, params)
  req.send_request(options)
end

#disassociate_enclave_certificate_iam_role(params = {}) ⇒ Types::DisassociateEnclaveCertificateIamRoleResult

Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role’s permission to use the KMS key used to encrypt the private key. This effectively revokes the role’s permission to use the certificate.

Examples:

Request syntax with placeholder values


resp = client.disassociate_enclave_certificate_iam_role({
  certificate_arn: "CertificateId", # required
  role_arn: "RoleId", # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :certificate_arn (required, String) —

    The ARN of the ACM certificate from which to disassociate the IAM role.

  • :role_arn (required, String) —

    The ARN of the IAM role to disassociate.

  • :dry_run (Boolean) —

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

Returns:

See Also:



39929
39930
39931
39932
 
# File 'lib/aws-sdk-ec2/client.rb', line 39929

def disassociate_enclave_certificate_iam_role(params = {}, options = {})
  req = build_request(:disassociate_enclave_certificate_iam_role, params)
  req.send_request(options)
end

#disassociate_iam_instance_profile(params = {}) ⇒ Types::DisassociateIamInstanceProfileResult

Disassociates an IAM instance profile from a running or stopped instance.

Use DescribeIamInstanceProfileAssociations to get the association ID.

Examples:

Example: To disassociate an IAM instance profile


# This example disassociates the specified IAM instance profile from an instance.

resp = client.disassociate_iam_instance_profile({
  association_id: "iip-assoc-05020b59952902f5f", 
})

resp.to_h outputs the following:
{
  iam_instance_profile_association: {
    association_id: "iip-assoc-05020b59952902f5f", 
    iam_instance_profile: {
      arn: "arn:aws:iam::123456789012:instance-profile/admin-role", 
      id: "AIPAI5IVIHMFFYY2DKV5Y", 
    }, 
    instance_id: "i-123456789abcde123", 
    state: "disassociating", 
  }, 
}

Request syntax with placeholder values


resp = client.disassociate_iam_instance_profile({
  association_id: "IamInstanceProfileAssociationId", # required
})

Response structure


resp.iam_instance_profile_association.association_id #=> String
resp.iam_instance_profile_association.instance_id #=> String
resp.iam_instance_profile_association.iam_instance_profile.arn #=> String
resp.iam_instance_profile_association.iam_instance_profile.id #=> String
resp.iam_instance_profile_association.state #=> String, one of "associating", "associated", "disassociating", "disassociated"
resp.iam_instance_profile_association.timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :association_id (required, String) —

    The ID of the IAM instance profile association.

Returns:

See Also:



39987
39988
39989
39990
 
# File 'lib/aws-sdk-ec2/client.rb', line 39987

def disassociate_iam_instance_profile(params = {}, options = {})
  req = build_request(:disassociate_iam_instance_profile, params)
  req.send_request(options)
end

#disassociate_instance_event_window(params = {}) ⇒ Types::DisassociateInstanceEventWindowResult

Disassociates one or more targets from an event window.

For more information, see [Define event windows for scheduled events] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html

Examples:

Request syntax with placeholder values


resp = client.disassociate_instance_event_window({
  dry_run: false,
  instance_event_window_id: "InstanceEventWindowId", # required
  association_target: { # required
    instance_ids: ["InstanceId"],
    instance_tags: [
      {
        key: "String",
        value: "String",
      },
    ],
    dedicated_host_ids: ["DedicatedHostId"],
  },
})

Response structure


resp.instance_event_window.instance_event_window_id #=> String
resp.instance_event_window.time_ranges #=> Array
resp.instance_event_window.time_ranges[0].start_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_window.time_ranges[0].start_hour #=> Integer
resp.instance_event_window.time_ranges[0].end_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_window.time_ranges[0].end_hour #=> Integer
resp.instance_event_window.name #=> String
resp.instance_event_window.cron_expression #=> String
resp.instance_event_window.association_target.instance_ids #=> Array
resp.instance_event_window.association_target.instance_ids[0] #=> String
resp.instance_event_window.association_target.tags #=> Array
resp.instance_event_window.association_target.tags[0].key #=> String
resp.instance_event_window.association_target.tags[0].value #=> String
resp.instance_event_window.association_target.dedicated_host_ids #=> Array
resp.instance_event_window.association_target.dedicated_host_ids[0] #=> String
resp.instance_event_window.state #=> String, one of "creating", "deleting", "active", "deleted"
resp.instance_event_window.tags #=> Array
resp.instance_event_window.tags[0].key #=> String
resp.instance_event_window.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_event_window_id (required, String) —

    The ID of the event window.

  • :association_target (required, Types::InstanceEventWindowDisassociationRequest) —

    One or more targets to disassociate from the specified event window.

Returns:

See Also:



40060
40061
40062
40063
 
# File 'lib/aws-sdk-ec2/client.rb', line 40060

def disassociate_instance_event_window(params = {}, options = {})
  req = build_request(:disassociate_instance_event_window, params)
  req.send_request(options)
end

#disassociate_ipam_byoasn(params = {}) ⇒ Types::DisassociateIpamByoasnResult

Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. For more information, see

Tutorial: Bring your ASN to IPAM][1

in the *Amazon VPC IPAM guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html

Examples:

Request syntax with placeholder values


resp = client.disassociate_ipam_byoasn({
  dry_run: false,
  asn: "String", # required
  cidr: "String", # required
})

Response structure


resp.asn_association.asn #=> String
resp.asn_association.cidr #=> String
resp.asn_association.status_message #=> String
resp.asn_association.state #=> String, one of "disassociated", "failed-disassociation", "failed-association", "pending-disassociation", "pending-association", "associated"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    A public 2-byte or 4-byte ASN.

  • :cidr (required, String) —

    A BYOIP CIDR.

Returns:

See Also:



40109
40110
40111
40112
 
# File 'lib/aws-sdk-ec2/client.rb', line 40109

def disassociate_ipam_byoasn(params = {}, options = {})
  req = build_request(:disassociate_ipam_byoasn, params)
  req.send_request(options)
end

#disassociate_ipam_resource_discovery(params = {}) ⇒ Types::DisassociateIpamResourceDiscoveryResult

Disassociates a resource discovery from 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.

Examples:

Request syntax with placeholder values


resp = client.disassociate_ipam_resource_discovery({
  dry_run: false,
  ipam_resource_discovery_association_id: "IpamResourceDiscoveryAssociationId", # required
})

Response structure


resp.ipam_resource_discovery_association.owner_id #=> String
resp.ipam_resource_discovery_association.ipam_resource_discovery_association_id #=> String
resp.ipam_resource_discovery_association.ipam_resource_discovery_association_arn #=> String
resp.ipam_resource_discovery_association.ipam_resource_discovery_id #=> String
resp.ipam_resource_discovery_association.ipam_id #=> String
resp.ipam_resource_discovery_association.ipam_arn #=> String
resp.ipam_resource_discovery_association.ipam_region #=> String
resp.ipam_resource_discovery_association.is_default #=> Boolean
resp.ipam_resource_discovery_association.resource_discovery_status #=> String, one of "active", "not-found"
resp.ipam_resource_discovery_association.state #=> String, one of "associate-in-progress", "associate-complete", "associate-failed", "disassociate-in-progress", "disassociate-complete", "disassociate-failed", "isolate-in-progress", "isolate-complete", "restore-in-progress"
resp.ipam_resource_discovery_association.tags #=> Array
resp.ipam_resource_discovery_association.tags[0].key #=> String
resp.ipam_resource_discovery_association.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_resource_discovery_association_id (required, String) —

    A resource discovery association ID.

Returns:

See Also:



40158
40159
40160
40161
 
# File 'lib/aws-sdk-ec2/client.rb', line 40158

def disassociate_ipam_resource_discovery(params = {}, options = {})
  req = build_request(:disassociate_ipam_resource_discovery, params)
  req.send_request(options)
end

#disassociate_nat_gateway_address(params = {}) ⇒ Types::DisassociateNatGatewayAddressResult

Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see [Edit secondary IP address associations] in the *Amazon VPC User Guide*.

While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.

An EIP is released only at the end of MaxDrainDurationSeconds. It stays associated and supports the existing connections but does not support any new connections (new connections are distributed across the remaining associated EIPs). As the existing connections drain out, the EIPs (and the corresponding private IP addresses mapped to them) are released.

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-edit-secondary

Examples:

Request syntax with placeholder values


resp = client.disassociate_nat_gateway_address({
  nat_gateway_id: "NatGatewayId", # required
  association_ids: ["ElasticIpAssociationId"], # required
  max_drain_duration_seconds: 1,
  dry_run: false,
})

Response structure


resp.nat_gateway_id #=> String
resp.nat_gateway_addresses #=> Array
resp.nat_gateway_addresses[0].allocation_id #=> String
resp.nat_gateway_addresses[0].network_interface_id #=> String
resp.nat_gateway_addresses[0].private_ip #=> String
resp.nat_gateway_addresses[0].public_ip #=> String
resp.nat_gateway_addresses[0].association_id #=> String
resp.nat_gateway_addresses[0].is_primary #=> Boolean
resp.nat_gateway_addresses[0].failure_message #=> String
resp.nat_gateway_addresses[0].status #=> String, one of "assigning", "unassigning", "associating", "disassociating", "succeeded", "failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :nat_gateway_id (required, String) —

    The ID of the NAT gateway.

  • :association_ids (required, Array<String>) —

    The association IDs of EIPs that have been associated with the NAT gateway.

  • :max_drain_duration_seconds (Integer) —

    The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

  • :dry_run (Boolean) —

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

Returns:

See Also:



40232
40233
40234
40235
 
# File 'lib/aws-sdk-ec2/client.rb', line 40232

def disassociate_nat_gateway_address(params = {}, options = {})
  req = build_request(:disassociate_nat_gateway_address, params)
  req.send_request(options)
end

#disassociate_route_table(params = {}) ⇒ Struct

Disassociates a subnet or gateway from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC’s main route table. For more information about route tables, see [Route tables] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html

Examples:

Example: To disassociate a route table


# This example disassociates the specified route table from its associated subnet.

resp = client.disassociate_route_table({
  association_id: "rtbassoc-781d0d1a", 
})

Request syntax with placeholder values


resp = client.disassociate_route_table({
  dry_run: false,
  association_id: "RouteTableAssociationId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :association_id (required, String) —

    The association ID representing the current association between the route table and subnet or gateway.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



40280
40281
40282
40283
 
# File 'lib/aws-sdk-ec2/client.rb', line 40280

def disassociate_route_table(params = {}, options = {})
  req = build_request(:disassociate_route_table, params)
  req.send_request(options)
end

#disassociate_subnet_cidr_block(params = {}) ⇒ Types::DisassociateSubnetCidrBlockResult

Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

Examples:

Request syntax with placeholder values


resp = client.disassociate_subnet_cidr_block({
  association_id: "SubnetCidrAssociationId", # required
})

Response structure


resp.ipv_6_cidr_block_association.association_id #=> String
resp.ipv_6_cidr_block_association.ipv_6_cidr_block #=> String
resp.ipv_6_cidr_block_association.ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.ipv_6_cidr_block_association.ipv_6_cidr_block_state.status_message #=> String
resp.ipv_6_cidr_block_association.ipv_6_address_attribute #=> String, one of "public", "private"
resp.ipv_6_cidr_block_association.ip_source #=> String, one of "amazon", "byoip", "none"
resp.subnet_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :association_id (required, String) —

    The association ID for the CIDR block.

Returns:

See Also:



40318
40319
40320
40321
 
# File 'lib/aws-sdk-ec2/client.rb', line 40318

def disassociate_subnet_cidr_block(params = {}, options = {})
  req = build_request(:disassociate_subnet_cidr_block, params)
  req.send_request(options)
end

#disassociate_transit_gateway_multicast_domain(params = {}) ⇒ Types::DisassociateTransitGatewayMulticastDomainResult

Disassociates the specified subnets from the transit gateway multicast domain.

Examples:

Request syntax with placeholder values


resp = client.disassociate_transit_gateway_multicast_domain({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  subnet_ids: ["SubnetId"], # required
  dry_run: false,
})

Response structure


resp.associations.transit_gateway_multicast_domain_id #=> String
resp.associations.transit_gateway_attachment_id #=> String
resp.associations.resource_id #=> String
resp.associations.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.associations.resource_owner_id #=> String
resp.associations.subnets #=> Array
resp.associations.subnets[0].subnet_id #=> String
resp.associations.subnets[0].state #=> String, one of "pendingAcceptance", "associating", "associated", "disassociating", "disassociated", "rejected", "failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (required, String) —

    The ID of the transit gateway multicast domain.

  • :transit_gateway_attachment_id (required, String) —

    The ID of the attachment.

  • :subnet_ids (required, Array<String>) —

    The IDs of the subnets;

  • :dry_run (Boolean) —

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

Returns:

See Also:



40369
40370
40371
40372
 
# File 'lib/aws-sdk-ec2/client.rb', line 40369

def disassociate_transit_gateway_multicast_domain(params = {}, options = {})
  req = build_request(:disassociate_transit_gateway_multicast_domain, params)
  req.send_request(options)
end

#disassociate_transit_gateway_policy_table(params = {}) ⇒ Types::DisassociateTransitGatewayPolicyTableResult

Removes the association between an an attachment and a policy table.

Examples:

Request syntax with placeholder values


resp = client.disassociate_transit_gateway_policy_table({
  transit_gateway_policy_table_id: "TransitGatewayPolicyTableId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.association.transit_gateway_policy_table_id #=> String
resp.association.transit_gateway_attachment_id #=> String
resp.association.resource_id #=> String
resp.association.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.association.state #=> String, one of "associating", "associated", "disassociating", "disassociated"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_policy_table_id (required, String) —

    The ID of the disassociated policy table.

  • :transit_gateway_attachment_id (required, String) —

    The ID of the transit gateway attachment to disassociate from the policy table.

  • :dry_run (Boolean) —

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

Returns:

See Also:



40413
40414
40415
40416
 
# File 'lib/aws-sdk-ec2/client.rb', line 40413

def disassociate_transit_gateway_policy_table(params = {}, options = {})
  req = build_request(:disassociate_transit_gateway_policy_table, params)
  req.send_request(options)
end

#disassociate_transit_gateway_route_table(params = {}) ⇒ Types::DisassociateTransitGatewayRouteTableResult

Disassociates a resource attachment from a transit gateway route table.

Examples:

Request syntax with placeholder values


resp = client.disassociate_transit_gateway_route_table({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.association.transit_gateway_route_table_id #=> String
resp.association.transit_gateway_attachment_id #=> String
resp.association.resource_id #=> String
resp.association.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.association.state #=> String, one of "associating", "associated", "disassociating", "disassociated"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :transit_gateway_attachment_id (required, String) —

    The ID of the attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



40457
40458
40459
40460
 
# File 'lib/aws-sdk-ec2/client.rb', line 40457

def disassociate_transit_gateway_route_table(params = {}, options = {})
  req = build_request(:disassociate_transit_gateway_route_table, params)
  req.send_request(options)
end

#disassociate_trunk_interface(params = {}) ⇒ Types::DisassociateTrunkInterfaceResult

Removes an association between a branch network interface with a trunk network interface.

Examples:

Request syntax with placeholder values


resp = client.disassociate_trunk_interface({
  association_id: "TrunkInterfaceAssociationId", # required
  client_token: "String",
  dry_run: false,
})

Response structure


resp.return #=> Boolean
resp.client_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :association_id (required, String) —

    The ID of the association

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



40508
40509
40510
40511
 
# File 'lib/aws-sdk-ec2/client.rb', line 40508

def disassociate_trunk_interface(params = {}, options = {})
  req = build_request(:disassociate_trunk_interface, params)
  req.send_request(options)
end

#disassociate_vpc_cidr_block(params = {}) ⇒ Types::DisassociateVpcCidrBlockResult

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).

Examples:

Request syntax with placeholder values


resp = client.disassociate_vpc_cidr_block({
  association_id: "VpcCidrAssociationId", # required
})

Response structure


resp.ipv_6_cidr_block_association.association_id #=> String
resp.ipv_6_cidr_block_association.ipv_6_cidr_block #=> String
resp.ipv_6_cidr_block_association.ipv_6_cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.ipv_6_cidr_block_association.ipv_6_cidr_block_state.status_message #=> String
resp.ipv_6_cidr_block_association.network_border_group #=> String
resp.ipv_6_cidr_block_association.ipv_6_pool #=> String
resp.ipv_6_cidr_block_association.ipv_6_address_attribute #=> String, one of "public", "private"
resp.ipv_6_cidr_block_association.ip_source #=> String, one of "amazon", "byoip", "none"
resp.cidr_block_association.association_id #=> String
resp.cidr_block_association.cidr_block #=> String
resp.cidr_block_association.cidr_block_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failing", "failed"
resp.cidr_block_association.cidr_block_state.status_message #=> String
resp.vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :association_id (required, String) —

    The association ID for the CIDR block.

Returns:

See Also:



40557
40558
40559
40560
 
# File 'lib/aws-sdk-ec2/client.rb', line 40557

def disassociate_vpc_cidr_block(params = {}, options = {})
  req = build_request(:disassociate_vpc_cidr_block, params)
  req.send_request(options)
end

#enable_address_transfer(params = {}) ⇒ Types::EnableAddressTransferResult

Enables Elastic IP address transfer. For more information, see

Transfer Elastic IP addresses][1

in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro

Examples:

Request syntax with placeholder values


resp = client.enable_address_transfer({
  allocation_id: "AllocationId", # required
  transfer_account_id: "String", # required
  dry_run: false,
})

Response structure


resp.address_transfer.public_ip #=> String
resp.address_transfer.allocation_id #=> String
resp.address_transfer. #=> String
resp.address_transfer.transfer_offer_expiration_timestamp #=> Time
resp.address_transfer.transfer_offer_accepted_timestamp #=> Time
resp.address_transfer.address_transfer_status #=> String, one of "pending", "disabled", "accepted"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_id (required, String) —

    The allocation ID of an Elastic IP address.

  • :transfer_account_id (required, String) —

    The ID of the account that you want to transfer the Elastic IP address to.

  • :dry_run (Boolean) —

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

Returns:

See Also:



40607
40608
40609
40610
 
# File 'lib/aws-sdk-ec2/client.rb', line 40607

def enable_address_transfer(params = {}, options = {})
  req = build_request(:enable_address_transfer, params)
  req.send_request(options)
end

#enable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::EnableAwsNetworkPerformanceMetricSubscriptionResult

Enables Infrastructure Performance subscriptions.

Examples:

Request syntax with placeholder values


resp = client.enable_aws_network_performance_metric_subscription({
  source: "String",
  destination: "String",
  metric: "aggregate-latency", # accepts aggregate-latency
  statistic: "p50", # accepts p50
  dry_run: false,
})

Response structure


resp.output #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source (String) —

    The source Region (like ‘us-east-1`) or Availability Zone ID (like `use1-az1`) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region.

  • :destination (String) —

    The target Region (like ‘us-east-2`) or Availability Zone ID (like `use2-az2`) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region.

  • :metric (String) —

    The metric used for the enabled subscription.

  • :statistic (String) —

    The statistic used for the enabled subscription.

  • :dry_run (Boolean) —

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

Returns:

See Also:



40660
40661
40662
40663
 
# File 'lib/aws-sdk-ec2/client.rb', line 40660

def enable_aws_network_performance_metric_subscription(params = {}, options = {})
  req = build_request(:enable_aws_network_performance_metric_subscription, params)
  req.send_request(options)
end

#enable_ebs_encryption_by_default(params = {}) ⇒ Types::EnableEbsEncryptionByDefaultResult

Enables EBS encryption by default for your account in the current Region.

After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see [Amazon EBS encryption] in the *Amazon EBS User Guide*.

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

Enabling encryption by default has no effect on the encryption status of your existing volumes.

After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see [Supported instance types].

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html [2]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances

Examples:

Request syntax with placeholder values


resp = client.enable_ebs_encryption_by_default({
  dry_run: false,
})

Response structure


resp.ebs_encryption_by_default #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



40713
40714
40715
40716
 
# File 'lib/aws-sdk-ec2/client.rb', line 40713

def enable_ebs_encryption_by_default(params = {}, options = {})
  req = build_request(:enable_ebs_encryption_by_default, params)
  req.send_request(options)
end

#enable_fast_launch(params = {}) ⇒ Types::EnableFastLaunchResult

When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.

<note markdown=“1”> You can only change these settings for Windows AMIs that you own or that have been shared with you.

</note>

Examples:

Request syntax with placeholder values


resp = client.enable_fast_launch({
  image_id: "ImageId", # required
  resource_type: "String",
  snapshot_configuration: {
    target_resource_count: 1,
  },
  launch_template: {
    launch_template_id: "LaunchTemplateId",
    launch_template_name: "String",
    version: "String", # required
  },
  max_parallel_launches: 1,
  dry_run: false,
})

Response structure


resp.image_id #=> String
resp.resource_type #=> String, one of "snapshot"
resp.snapshot_configuration.target_resource_count #=> Integer
resp.launch_template.launch_template_id #=> String
resp.launch_template.launch_template_name #=> String
resp.launch_template.version #=> String
resp.max_parallel_launches #=> Integer
resp.owner_id #=> String
resp.state #=> String, one of "enabling", "enabling-failed", "enabled", "enabled-failed", "disabling", "disabling-failed"
resp.state_transition_reason #=> String
resp.state_transition_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    Specify the ID of the image for which to enable Windows fast launch.

  • :resource_type (String) —

    The type of resource to use for pre-provisioning the AMI for Windows fast launch. Supported values include: ‘snapshot`, which is the default value.

  • :snapshot_configuration (Types::FastLaunchSnapshotConfigurationRequest) —

    Configuration settings for creating and managing the snapshots that are used for pre-provisioning the AMI for Windows fast launch. The associated ‘ResourceType` must be `snapshot`.

  • :launch_template (Types::FastLaunchLaunchTemplateSpecificationRequest) —

    The launch template to use when launching Windows instances from pre-provisioned snapshots. Launch template parameters can include either the name or ID of the launch template, but not both.

  • :max_parallel_launches (Integer) —

    The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch. Value must be ‘6` or greater.

  • :dry_run (Boolean) —

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

Returns:

See Also:



40807
40808
40809
40810
 
# File 'lib/aws-sdk-ec2/client.rb', line 40807

def enable_fast_launch(params = {}, options = {})
  req = build_request(:enable_fast_launch, params)
  req.send_request(options)
end

#enable_fast_snapshot_restores(params = {}) ⇒ Types::EnableFastSnapshotRestoresResult

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

You get the full benefit of fast snapshot restores after they enter the ‘enabled` state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.

For more information, see [Amazon EBS fast snapshot restore] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-fast-snapshot-restore.html

Examples:

Request syntax with placeholder values


resp = client.enable_fast_snapshot_restores({
  availability_zones: ["String"], # required
  source_snapshot_ids: ["SnapshotId"], # required
  dry_run: false,
})

Response structure


resp.successful #=> Array
resp.successful[0].snapshot_id #=> String
resp.successful[0].availability_zone #=> String
resp.successful[0].state #=> String, one of "enabling", "optimizing", "enabled", "disabling", "disabled"
resp.successful[0].state_transition_reason #=> String
resp.successful[0].owner_id #=> String
resp.successful[0].owner_alias #=> String
resp.successful[0].enabling_time #=> Time
resp.successful[0].optimizing_time #=> Time
resp.successful[0].enabled_time #=> Time
resp.successful[0].disabling_time #=> Time
resp.successful[0].disabled_time #=> Time
resp.unsuccessful #=> Array
resp.unsuccessful[0].snapshot_id #=> String
resp.unsuccessful[0].fast_snapshot_restore_state_errors #=> Array
resp.unsuccessful[0].fast_snapshot_restore_state_errors[0].availability_zone #=> String
resp.unsuccessful[0].fast_snapshot_restore_state_errors[0].error.code #=> String
resp.unsuccessful[0].fast_snapshot_restore_state_errors[0].error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :availability_zones (required, Array<String>) —

    One or more Availability Zones. For example, ‘us-east-2a`.

  • :source_snapshot_ids (required, Array<String>) —

    The IDs of one or more snapshots. For example, ‘snap-1234567890abcdef0`. You can specify a snapshot that was shared with you from another Amazon Web Services account.

  • :dry_run (Boolean) —

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

Returns:

See Also:



40879
40880
40881
40882
 
# File 'lib/aws-sdk-ec2/client.rb', line 40879

def enable_fast_snapshot_restores(params = {}, options = {})
  req = build_request(:enable_fast_snapshot_restores, params)
  req.send_request(options)
end

#enable_image(params = {}) ⇒ Types::EnableImageResult

Re-enables a disabled AMI. The re-enabled AMI is marked as ‘available` and can be used for instance launches, appears in describe operations, and can be shared. Amazon Web Services accounts, organizations, and Organizational Units that lost access to the AMI when it was disabled do not regain access automatically. Once the AMI is available, it can be shared with them again.

Only the AMI owner can re-enable a disabled AMI.

For more information, see [Disable an AMI] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html

Examples:

Request syntax with placeholder values


resp = client.enable_image({
  image_id: "ImageId", # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI.

  • :dry_run (Boolean) —

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

Returns:

See Also:



40928
40929
40930
40931
 
# File 'lib/aws-sdk-ec2/client.rb', line 40928

def enable_image(params = {}, options = {})
  req = build_request(:enable_image, params)
  req.send_request(options)
end

#enable_image_block_public_access(params = {}) ⇒ Types::EnableImageBlockPublicAccessResult

Enables *block public access for AMIs* at the account level in the specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available.

The API can take up to 10 minutes to configure this setting. During this time, if you run [GetImageBlockPublicAccessState], the response will be ‘unblocked`. When the API has completed the configuration, the response will be `block-new-sharing`.

For more information, see [Block public access to your AMIs] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetImageBlockPublicAccessState.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis

Examples:

Request syntax with placeholder values


resp = client.enable_image_block_public_access({
  image_block_public_access_state: "block-new-sharing", # required, accepts block-new-sharing
  dry_run: false,
})

Response structure


resp.image_block_public_access_state #=> String, one of "block-new-sharing"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_block_public_access_state (required, String) —

    Specify ‘block-new-sharing` to enable block public access for AMIs at the account level in the specified Region. This will block any attempt to publicly share your AMIs in the specified Region.

  • :dry_run (Boolean) —

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

Returns:

See Also:



40981
40982
40983
40984
 
# File 'lib/aws-sdk-ec2/client.rb', line 40981

def enable_image_block_public_access(params = {}, options = {})
  req = build_request(:enable_image_block_public_access, params)
  req.send_request(options)
end

#enable_image_deprecation(params = {}) ⇒ Types::EnableImageDeprecationResult

Enables deprecation of the specified AMI at the specified date and time.

For more information, see [Deprecate an AMI] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html

Examples:

Request syntax with placeholder values


resp = client.enable_image_deprecation({
  image_id: "ImageId", # required
  deprecate_at: Time.now, # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI.

  • :deprecate_at (required, Time, DateTime, Date, Integer, String) —

    The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-*DD*T*HH*:MM:*SS*Z. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

    You can’t specify a date in the past. The upper limit for ‘DeprecateAt` is 10 years from now, except for public AMIs, where the upper limit is 2 years from the creation date.

  • :dry_run (Boolean) —

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

Returns:

See Also:



41034
41035
41036
41037
 
# File 'lib/aws-sdk-ec2/client.rb', line 41034

def enable_image_deprecation(params = {}, options = {})
  req = build_request(:enable_image_deprecation, params)
  req.send_request(options)
end

#enable_image_deregistration_protection(params = {}) ⇒ Types::EnableImageDeregistrationProtectionResult

Enables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can’t be deregistered.

To allow the AMI to be deregistered, you must first disable deregistration protection using DisableImageDeregistrationProtection.

For more information, see [Protect an AMI from deregistration] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html#ami-deregistration-protection

Examples:

Request syntax with placeholder values


resp = client.enable_image_deregistration_protection({
  image_id: "ImageId", # required
  with_cooldown: false,
  dry_run: false,
})

Response structure


resp.return #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI.

  • :with_cooldown (Boolean) —

    If ‘true`, enforces deregistration protection for 24 hours after deregistration protection is disabled.

  • :dry_run (Boolean) —

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

Returns:

See Also:



41085
41086
41087
41088
 
# File 'lib/aws-sdk-ec2/client.rb', line 41085

def enable_image_deregistration_protection(params = {}, options = {})
  req = build_request(:enable_image_deregistration_protection, params)
  req.send_request(options)
end

#enable_ipam_organization_admin_account(params = {}) ⇒ Types::EnableIpamOrganizationAdminAccountResult

Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see [Enable integration with Organizations] in the *Amazon VPC IPAM User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html

Examples:

Request syntax with placeholder values


resp = client.({
  dry_run: false,
  delegated_admin_account_id: "String", # required
})

Response structure


resp.success #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :delegated_admin_account_id (required, String) —

    The Organizations member account ID that you want to enable as the IPAM account.

Returns:

See Also:



41128
41129
41130
41131
 
# File 'lib/aws-sdk-ec2/client.rb', line 41128

def (params = {}, options = {})
  req = build_request(:enable_ipam_organization_admin_account, params)
  req.send_request(options)
end

#enable_reachability_analyzer_organization_sharing(params = {}) ⇒ Types::EnableReachabilityAnalyzerOrganizationSharingResult

Establishes a trust relationship between Reachability Analyzer and Organizations. This operation must be performed by the management account for the organization.

After you establish a trust relationship, a user in the management account or a delegated administrator account can run a cross-account analysis using resources from the member accounts.

Examples:

Request syntax with placeholder values


resp = client.enable_reachability_analyzer_organization_sharing({
  dry_run: false,
})

Response structure


resp.return_value #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



41165
41166
41167
41168
 
# File 'lib/aws-sdk-ec2/client.rb', line 41165

def enable_reachability_analyzer_organization_sharing(params = {}, options = {})
  req = build_request(:enable_reachability_analyzer_organization_sharing, params)
  req.send_request(options)
end

#enable_serial_console_access(params = {}) ⇒ Types::EnableSerialConsoleAccessResult

Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see [Manage account access to the EC2 serial console] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access

Examples:

Request syntax with placeholder values


resp = client.enable_serial_console_access({
  dry_run: false,
})

Response structure


resp.serial_console_access_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



41203
41204
41205
41206
 
# File 'lib/aws-sdk-ec2/client.rb', line 41203

def enable_serial_console_access(params = {}, options = {})
  req = build_request(:enable_serial_console_access, params)
  req.send_request(options)
end

#enable_snapshot_block_public_access(params = {}) ⇒ Types::EnableSnapshotBlockPublicAccessResult

Enables or modifies the *block public access for snapshots* setting at the account level for the specified Amazon Web Services Region. After you enable block public access for snapshots in a Region, users can no longer request public sharing for snapshots in that Region. Snapshots that are already publicly shared are either treated as private or they remain publicly shared, depending on the State that you specify.

Enabling block public access for snapshots in *block all sharing* mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available.

If you later disable block public access or change the mode to *block

new sharing*, these snapshots will become publicly available again.

For more information, see [ Block public access for snapshots] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html

Examples:

Request syntax with placeholder values


resp = client.enable_snapshot_block_public_access({
  state: "block-all-sharing", # required, accepts block-all-sharing, block-new-sharing, unblocked
  dry_run: false,
})

Response structure


resp.state #=> String, one of "block-all-sharing", "block-new-sharing", "unblocked"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :state (required, String) —

    The mode in which to enable block public access for snapshots for the Region. Specify one of the following values:

    • ‘block-all-sharing` - Prevents all public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. Additionally, snapshots that are already publicly shared are treated as private and they are no longer publicly available.

    • ‘block-new-sharing` - Prevents only new public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. However, snapshots that are already publicly shared, remain publicly available.

    ‘unblocked` is not a valid value for EnableSnapshotBlockPublicAccess.

  • :dry_run (Boolean) —

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

Returns:

See Also:



41275
41276
41277
41278
 
# File 'lib/aws-sdk-ec2/client.rb', line 41275

def enable_snapshot_block_public_access(params = {}, options = {})
  req = build_request(:enable_snapshot_block_public_access, params)
  req.send_request(options)
end

#enable_transit_gateway_route_table_propagation(params = {}) ⇒ Types::EnableTransitGatewayRouteTablePropagationResult

Enables the specified attachment to propagate routes to the specified propagation route table.

Examples:

Request syntax with placeholder values


resp = client.enable_transit_gateway_route_table_propagation({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId",
  dry_run: false,
  transit_gateway_route_table_announcement_id: "TransitGatewayRouteTableAnnouncementId",
})

Response structure


resp.propagation.transit_gateway_attachment_id #=> String
resp.propagation.resource_id #=> String
resp.propagation.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.propagation.transit_gateway_route_table_id #=> String
resp.propagation.state #=> String, one of "enabling", "enabled", "disabling", "disabled"
resp.propagation.transit_gateway_route_table_announcement_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the propagation route table.

  • :transit_gateway_attachment_id (String) —

    The ID of the attachment.

  • :dry_run (Boolean) —

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

  • :transit_gateway_route_table_announcement_id (String) —

    The ID of the transit gateway route table announcement.

Returns:

See Also:



41324
41325
41326
41327
 
# File 'lib/aws-sdk-ec2/client.rb', line 41324

def enable_transit_gateway_route_table_propagation(params = {}, options = {})
  req = build_request(:enable_transit_gateway_route_table_propagation, params)
  req.send_request(options)
end

#enable_vgw_route_propagation(params = {}) ⇒ Struct

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

Examples:

Example: To enable route propagation


# This example enables the specified virtual private gateway to propagate static routes to the specified route table.

resp = client.enable_vgw_route_propagation({
  gateway_id: "vgw-9a4cacf3", 
  route_table_id: "rtb-22574640", 
})

Request syntax with placeholder values


resp = client.enable_vgw_route_propagation({
  gateway_id: "VpnGatewayId", # required
  route_table_id: "RouteTableId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.

  • :route_table_id (required, String) —

    The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



41371
41372
41373
41374
 
# File 'lib/aws-sdk-ec2/client.rb', line 41371

def enable_vgw_route_propagation(params = {}, options = {})
  req = build_request(:enable_vgw_route_propagation, params)
  req.send_request(options)
end

#enable_volume_io(params = {}) ⇒ Struct

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

Examples:

Example: To enable I/O for a volume


# This example enables I/O on volume ``vol-1234567890abcdef0``.

resp = client.enable_volume_io({
  volume_id: "vol-1234567890abcdef0", 
})

Request syntax with placeholder values


resp = client.enable_volume_io({
  dry_run: false,
  volume_id: "VolumeId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :volume_id (required, String) —

    The ID of the volume.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



41410
41411
41412
41413
 
# File 'lib/aws-sdk-ec2/client.rb', line 41410

def enable_volume_io(params = {}, options = {})
  req = build_request(:enable_volume_io, params)
  req.send_request(options)
end

#enable_vpc_classic_link(params = {}) ⇒ Types::EnableVpcClassicLinkResult

<note markdown=“1”> This action is deprecated.

</note>

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the ‘10.0.0.0/8` IP address range, excluding local routes for VPCs in the `10.0.0.0/16` and `10.1.0.0/16` IP address ranges.

Examples:

Request syntax with placeholder values


resp = client.enable_vpc_classic_link({
  dry_run: false,
  vpc_id: "VpcId", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_id (required, String) —

    The ID of the VPC.

Returns:

See Also:



41454
41455
41456
41457
 
# File 'lib/aws-sdk-ec2/client.rb', line 41454

def enable_vpc_classic_link(params = {}, options = {})
  req = build_request(:enable_vpc_classic_link, params)
  req.send_request(options)
end

#enable_vpc_classic_link_dns_support(params = {}) ⇒ Types::EnableVpcClassicLinkDnsSupportResult

<note markdown=“1”> This action is deprecated.

</note>

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it’s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance.

You must specify a VPC ID in the request.

Examples:

Request syntax with placeholder values


resp = client.enable_vpc_classic_link_dns_support({
  vpc_id: "VpcId",
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_id (String) —

    The ID of the VPC.

Returns:

See Also:



41493
41494
41495
41496
 
# File 'lib/aws-sdk-ec2/client.rb', line 41493

def enable_vpc_classic_link_dns_support(params = {}, options = {})
  req = build_request(:enable_vpc_classic_link_dns_support, params)
  req.send_request(options)
end

#export_client_vpn_client_certificate_revocation_list(params = {}) ⇒ Types::ExportClientVpnClientCertificateRevocationListResult

Downloads the client certificate revocation list for the specified Client VPN endpoint.

Examples:

Request syntax with placeholder values


resp = client.export_client_vpn_client_certificate_revocation_list({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  dry_run: false,
})

Response structure


resp.certificate_revocation_list #=> String
resp.status.code #=> String, one of "pending", "active"
resp.status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint.

  • :dry_run (Boolean) —

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

Returns:

See Also:



41532
41533
41534
41535
 
# File 'lib/aws-sdk-ec2/client.rb', line 41532

def export_client_vpn_client_certificate_revocation_list(params = {}, options = {})
  req = build_request(:export_client_vpn_client_certificate_revocation_list, params)
  req.send_request(options)
end

#export_client_vpn_client_configuration(params = {}) ⇒ Types::ExportClientVpnClientConfigurationResult

Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.

Examples:

Request syntax with placeholder values


resp = client.export_client_vpn_client_configuration({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  dry_run: false,
})

Response structure


resp.client_configuration #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint.

  • :dry_run (Boolean) —

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

Returns:

See Also:



41571
41572
41573
41574
 
# File 'lib/aws-sdk-ec2/client.rb', line 41571

def export_client_vpn_client_configuration(params = {}, options = {})
  req = build_request(:export_client_vpn_client_configuration, params)
  req.send_request(options)
end

#export_image(params = {}) ⇒ Types::ExportImageResult

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see [Exporting a VM directly from an Amazon Machine Image (AMI)] in the *VM Import/Export User Guide*.

[1]: docs.aws.amazon.com/vm-import/latest/userguide/vmexport_image.html

Examples:

Request syntax with placeholder values


resp = client.export_image({
  client_token: "String",
  description: "String",
  disk_image_format: "VMDK", # required, accepts VMDK, RAW, VHD
  dry_run: false,
  image_id: "ImageId", # required
  s3_export_location: { # required
    s3_bucket: "String", # required
    s3_prefix: "String",
  },
  role_name: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.description #=> String
resp.disk_image_format #=> String, one of "VMDK", "RAW", "VHD"
resp.export_image_task_id #=> String
resp.image_id #=> String
resp.role_name #=> String
resp.progress #=> String
resp.s3_export_location.s3_bucket #=> String
resp.s3_export_location.s3_prefix #=> String
resp.status #=> String
resp.status_message #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Token to enable idempotency for export image requests.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :description (String) —

    A description of the image being exported. The maximum length is 255 characters.

  • :disk_image_format (required, String) —

    The disk image format.

  • :dry_run (Boolean) —

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

  • :image_id (required, String) —

    The ID of the image.

  • :s3_export_location (required, Types::ExportTaskS3LocationRequest) —

    The Amazon S3 bucket for the destination image. The destination bucket must exist.

  • :role_name (String) —

    The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named ‘vmimport’.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the export image task during creation.

Returns:

See Also:



41677
41678
41679
41680
 
# File 'lib/aws-sdk-ec2/client.rb', line 41677

def export_image(params = {}, options = {})
  req = build_request(:export_image, params)
  req.send_request(options)
end

#export_transit_gateway_routes(params = {}) ⇒ Types::ExportTransitGatewayRoutesResult

Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.

The routes are saved to the specified bucket in a JSON file. For more information, see [Export route tables to Amazon S3] in the *Amazon Web Services Transit Gateways Guide*.

[1]: docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#tgw-export-route-tables

Examples:

Request syntax with placeholder values


resp = client.export_transit_gateway_routes({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  s3_bucket: "String", # required
  dry_run: false,
})

Response structure


resp.s3_location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the route table.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘attachment.transit-gateway-attachment-id` - The id of the transit gateway attachment.

    • ‘attachment.resource-id` - The resource id of the transit gateway attachment.

    • ‘route-search.exact-match` - The exact match of the specified filter.

    • ‘route-search.longest-prefix-match` - The longest prefix that matches the route.

    • ‘route-search.subnet-of-match` - The routes with a subnet that match the specified CIDR filter.

    • ‘route-search.supernet-of-match` - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

    • ‘state` - The state of the route (`active` | `blackhole`).

    • ‘transit-gateway-route-destination-cidr-block` - The CIDR range.

    • ‘type` - The type of route (`propagated` | `static`).

  • :s3_bucket (required, String) —

    The name of the S3 bucket.

  • :dry_run (Boolean) —

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

Returns:

See Also:



41762
41763
41764
41765
 
# File 'lib/aws-sdk-ec2/client.rb', line 41762

def export_transit_gateway_routes(params = {}, options = {})
  req = build_request(:export_transit_gateway_routes, params)
  req.send_request(options)
end

#get_associated_enclave_certificate_iam_roles(params = {}) ⇒ Types::GetAssociatedEnclaveCertificateIamRolesResult

Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that’s used to encrypt the private key.

Examples:

Request syntax with placeholder values


resp = client.get_associated_enclave_certificate_iam_roles({
  certificate_arn: "CertificateId", # required
  dry_run: false,
})

Response structure


resp.associated_roles #=> Array
resp.associated_roles[0].associated_role_arn #=> String
resp.associated_roles[0].certificate_s3_bucket_name #=> String
resp.associated_roles[0].certificate_s3_object_key #=> String
resp.associated_roles[0].encryption_kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :certificate_arn (required, String) —

    The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information.

  • :dry_run (Boolean) —

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

Returns:

See Also:



41806
41807
41808
41809
 
# File 'lib/aws-sdk-ec2/client.rb', line 41806

def get_associated_enclave_certificate_iam_roles(params = {}, options = {})
  req = build_request(:get_associated_enclave_certificate_iam_roles, params)
  req.send_request(options)
end

#get_associated_ipv_6_pool_cidrs(params = {}) ⇒ Types::GetAssociatedIpv6PoolCidrsResult

Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_associated_ipv_6_pool_cidrs({
  pool_id: "Ipv6PoolEc2Id", # required
  next_token: "NextToken",
  max_results: 1,
  dry_run: false,
})

Response structure


resp.ipv_6_cidr_associations #=> Array
resp.ipv_6_cidr_associations[0].ipv_6_cidr #=> String
resp.ipv_6_cidr_associations[0].associated_resource #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_id (required, String) —

    The ID of the IPv6 address pool.

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (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.

  • :dry_run (Boolean) —

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

Returns:

See Also:



41858
41859
41860
41861
 
# File 'lib/aws-sdk-ec2/client.rb', line 41858

def get_associated_ipv_6_pool_cidrs(params = {}, options = {})
  req = build_request(:get_associated_ipv_6_pool_cidrs, params)
  req.send_request(options)
end

#get_aws_network_performance_data(params = {}) ⇒ Types::GetAwsNetworkPerformanceDataResult

Gets network performance data.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_aws_network_performance_data({
  data_queries: [
    {
      id: "String",
      source: "String",
      destination: "String",
      metric: "aggregate-latency", # accepts aggregate-latency
      statistic: "p50", # accepts p50
      period: "five-minutes", # accepts five-minutes, fifteen-minutes, one-hour, three-hours, one-day, one-week
    },
  ],
  start_time: Time.now,
  end_time: Time.now,
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.data_responses #=> Array
resp.data_responses[0].id #=> String
resp.data_responses[0].source #=> String
resp.data_responses[0].destination #=> String
resp.data_responses[0].metric #=> String, one of "aggregate-latency"
resp.data_responses[0].statistic #=> String, one of "p50"
resp.data_responses[0].period #=> String, one of "five-minutes", "fifteen-minutes", "one-hour", "three-hours", "one-day", "one-week"
resp.data_responses[0].metric_points #=> Array
resp.data_responses[0].metric_points[0].start_date #=> Time
resp.data_responses[0].metric_points[0].end_date #=> Time
resp.data_responses[0].metric_points[0].value #=> Float
resp.data_responses[0].metric_points[0].status #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_queries (Array<Types::DataQuery>) —

    A list of network performance data queries.

  • :start_time (Time, DateTime, Date, Integer, String) —

    The starting time for the performance data request. The starting time must be formatted as ‘yyyy-mm-ddThh:mm:ss`. For example, `2022-06-10T12:00:00.000Z`.

  • :end_time (Time, DateTime, Date, Integer, String) —

    The ending time for the performance data request. The end time must be formatted as ‘yyyy-mm-ddThh:mm:ss`. For example, `2022-06-12T12:00:00.000Z`.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



41939
41940
41941
41942
 
# File 'lib/aws-sdk-ec2/client.rb', line 41939

def get_aws_network_performance_data(params = {}, options = {})
  req = build_request(:get_aws_network_performance_data, params)
  req.send_request(options)
end

#get_capacity_reservation_usage(params = {}) ⇒ Types::GetCapacityReservationUsageResult

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner’s usage.

Examples:

Request syntax with placeholder values


resp = client.get_capacity_reservation_usage({
  capacity_reservation_id: "CapacityReservationId", # required
  next_token: "String",
  max_results: 1,
  dry_run: false,
})

Response structure


resp.next_token #=> String
resp.capacity_reservation_id #=> String
resp.instance_type #=> String
resp.total_instance_count #=> Integer
resp.available_instance_count #=> Integer
resp.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "scheduled", "payment-pending", "payment-failed"
resp.instance_usages #=> Array
resp.instance_usages[0]. #=> String
resp.instance_usages[0].used_instance_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

Returns:

See Also:



42006
42007
42008
42009
 
# File 'lib/aws-sdk-ec2/client.rb', line 42006

def get_capacity_reservation_usage(params = {}, options = {})
  req = build_request(:get_capacity_reservation_usage, params)
  req.send_request(options)
end

#get_coip_pool_usage(params = {}) ⇒ Types::GetCoipPoolUsageResult

Describes the allocations from the specified customer-owned address pool.

Examples:

Request syntax with placeholder values


resp = client.get_coip_pool_usage({
  pool_id: "Ipv4PoolCoipId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.coip_pool_id #=> String
resp.coip_address_usages #=> Array
resp.coip_address_usages[0].allocation_id #=> String
resp.coip_address_usages[0]. #=> String
resp.coip_address_usages[0].aws_service #=> String
resp.coip_address_usages[0].co_ip #=> String
resp.local_gateway_route_table_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_id (required, String) —

    The ID of the address pool.

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘coip-address-usage.allocation-id` - The allocation ID of the address.

    • ‘coip-address-usage.aws-account-id` - The ID of the Amazon Web Services account that is using the customer-owned IP address.

    • ‘coip-address-usage.aws-service` - The Amazon Web Services service that is using the customer-owned IP address.

    • ‘coip-address-usage.co-ip` - The customer-owned IP address.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



42082
42083
42084
42085
 
# File 'lib/aws-sdk-ec2/client.rb', line 42082

def get_coip_pool_usage(params = {}, options = {})
  req = build_request(:get_coip_pool_usage, params)
  req.send_request(options)
end

#get_console_output(params = {}) ⇒ Types::GetConsoleOutputResult

Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.

For more information, see [Instance console output] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output

Examples:

Example: To get the console output


# This example gets the console output for the specified instance.

resp = client.get_console_output({
  instance_id: "i-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
  instance_id: "i-1234567890abcdef0", 
  output: "...", 
  timestamp: Time.parse("2018-05-25T21:23:53.000Z"), 
}

Request syntax with placeholder values


resp = client.get_console_output({
  instance_id: "InstanceId", # required
  latest: false,
  dry_run: false,
})

Response structure


resp.instance_id #=> String
resp.timestamp #=> Time
resp.output #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance.

  • :latest (Boolean) —

    When enabled, retrieves the latest console output for the instance.

    Default: disabled (‘false`)

  • :dry_run (Boolean) —

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

Returns:

See Also:



42154
42155
42156
42157
 
# File 'lib/aws-sdk-ec2/client.rb', line 42154

def get_console_output(params = {}, options = {})
  req = build_request(:get_console_output, params)
  req.send_request(options)
end

#get_console_screenshot(params = {}) ⇒ Types::GetConsoleScreenshotResult

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

For more information, see [Instance console output] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/troubleshoot-unreachable-instance.html#instance-console-console-output

Examples:

Request syntax with placeholder values


resp = client.get_console_screenshot({
  dry_run: false,
  instance_id: "InstanceId", # required
  wake_up: false,
})

Response structure


resp.image_data #=> String
resp.instance_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the instance.

  • :wake_up (Boolean) —

    When set to ‘true`, acts as keystroke input and wakes up an instance that’s in standby or “sleep” mode.

Returns:

See Also:



42206
42207
42208
42209
 
# File 'lib/aws-sdk-ec2/client.rb', line 42206

def get_console_screenshot(params = {}, options = {})
  req = build_request(:get_console_screenshot, params)
  req.send_request(options)
end

#get_default_credit_specification(params = {}) ⇒ Types::GetDefaultCreditSpecificationResult

Describes the default credit option for CPU usage of a burstable performance instance family.

For more information, see [Burstable performance instances] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html

Examples:

Request syntax with placeholder values


resp = client.get_default_credit_specification({
  dry_run: false,
  instance_family: "t2", # required, accepts t2, t3, t3a, t4g
})

Response structure


resp.instance_family_credit_specification.instance_family #=> String, one of "t2", "t3", "t3a", "t4g"
resp.instance_family_credit_specification.cpu_credits #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_family (required, String) —

    The instance family.

Returns:

See Also:



42250
42251
42252
42253
 
# File 'lib/aws-sdk-ec2/client.rb', line 42250

def get_default_credit_specification(params = {}, options = {})
  req = build_request(:get_default_credit_specification, params)
  req.send_request(options)
end

#get_ebs_default_kms_key_id(params = {}) ⇒ Types::GetEbsDefaultKmsKeyIdResult

Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

For more information, see [Amazon EBS encryption] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html

Examples:

Request syntax with placeholder values


resp = client.get_ebs_default_kms_key_id({
  dry_run: false,
})

Response structure


resp.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



42291
42292
42293
42294
 
# File 'lib/aws-sdk-ec2/client.rb', line 42291

def get_ebs_default_kms_key_id(params = {}, options = {})
  req = build_request(:get_ebs_default_kms_key_id, params)
  req.send_request(options)
end

#get_ebs_encryption_by_default(params = {}) ⇒ Types::GetEbsEncryptionByDefaultResult

Describes whether EBS encryption by default is enabled for your account in the current Region.

For more information, see [Amazon EBS encryption] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html

Examples:

Request syntax with placeholder values


resp = client.get_ebs_encryption_by_default({
  dry_run: false,
})

Response structure


resp.ebs_encryption_by_default #=> Boolean
resp.sse_type #=> String, one of "sse-ebs", "sse-kms", "none"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



42332
42333
42334
42335
 
# File 'lib/aws-sdk-ec2/client.rb', line 42332

def get_ebs_encryption_by_default(params = {}, options = {})
  req = build_request(:get_ebs_encryption_by_default, params)
  req.send_request(options)
end

#get_flow_logs_integration_template(params = {}) ⇒ Types::GetFlowLogsIntegrationTemplateResult

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:

  • Create a table in Athena that maps fields to a custom log format

  • Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis

  • Create a table partitioned between two timestamps in the past

  • Create a set of named queries in Athena that you can use to get started quickly

<note markdown=“1”> ‘GetFlowLogsIntegrationTemplate` does not support integration between Amazon Web Services Transit Gateway Flow Logs and Amazon Athena.

</note>

Examples:

Request syntax with placeholder values


resp = client.get_flow_logs_integration_template({
  dry_run: false,
  flow_log_id: "VpcFlowLogId", # required
  config_delivery_s3_destination_arn: "String", # required
  integrate_services: { # required
    athena_integrations: [
      {
        integration_result_s3_destination_arn: "String", # required
        partition_load_frequency: "none", # required, accepts none, daily, weekly, monthly
        partition_start_date: Time.now,
        partition_end_date: Time.now,
      },
    ],
  },
})

Response structure


resp.result #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :flow_log_id (required, String) —

    The ID of the flow log.

  • :config_delivery_s3_destination_arn (required, String) —

    To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.

  • :integrate_services (required, Types::IntegrateServices) —

    Information about the service integration.

Returns:

See Also:



42404
42405
42406
42407
 
# File 'lib/aws-sdk-ec2/client.rb', line 42404

def get_flow_logs_integration_template(params = {}, options = {})
  req = build_request(:get_flow_logs_integration_template, params)
  req.send_request(options)
end

#get_groups_for_capacity_reservation(params = {}) ⇒ Types::GetGroupsForCapacityReservationResult

Lists the resource groups to which a Capacity Reservation has been added.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_groups_for_capacity_reservation({
  capacity_reservation_id: "CapacityReservationId", # required
  next_token: "String",
  max_results: 1,
  dry_run: false,
})

Response structure


resp.next_token #=> String
resp.capacity_reservation_groups #=> Array
resp.capacity_reservation_groups[0].group_arn #=> String
resp.capacity_reservation_groups[0].owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared with you, the operation returns only Capacity Reservation groups that you own.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

Returns:

See Also:



42462
42463
42464
42465
 
# File 'lib/aws-sdk-ec2/client.rb', line 42462

def get_groups_for_capacity_reservation(params = {}, options = {})
  req = build_request(:get_groups_for_capacity_reservation, params)
  req.send_request(options)
end

#get_host_reservation_purchase_preview(params = {}) ⇒ Types::GetHostReservationPurchasePreviewResult

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

Examples:

Request syntax with placeholder values


resp = client.get_host_reservation_purchase_preview({
  host_id_set: ["DedicatedHostId"], # required
  offering_id: "OfferingId", # required
})

Response structure


resp.currency_code #=> String, one of "USD"
resp.purchase #=> Array
resp.purchase[0].currency_code #=> String, one of "USD"
resp.purchase[0].duration #=> Integer
resp.purchase[0].host_id_set #=> Array
resp.purchase[0].host_id_set[0] #=> String
resp.purchase[0].host_reservation_id #=> String
resp.purchase[0].hourly_price #=> String
resp.purchase[0].instance_family #=> String
resp.purchase[0].payment_option #=> String, one of "AllUpfront", "PartialUpfront", "NoUpfront"
resp.purchase[0].upfront_price #=> String
resp.total_hourly_price #=> String
resp.total_upfront_price #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :host_id_set (required, Array<String>) —

    The IDs of the Dedicated Hosts with which the reservation is associated.

  • :offering_id (required, String) —

    The offering ID of the reservation.

Returns:

See Also:



42515
42516
42517
42518
 
# File 'lib/aws-sdk-ec2/client.rb', line 42515

def get_host_reservation_purchase_preview(params = {}, options = {})
  req = build_request(:get_host_reservation_purchase_preview, params)
  req.send_request(options)
end

#get_image_block_public_access_state(params = {}) ⇒ Types::GetImageBlockPublicAccessStateResult

Gets the current state of *block public access for AMIs* at the account level in the specified Amazon Web Services Region.

For more information, see [Block public access to your AMIs] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis

Examples:

Request syntax with placeholder values


resp = client.get_image_block_public_access_state({
  dry_run: false,
})

Response structure


resp.image_block_public_access_state #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



42554
42555
42556
42557
 
# File 'lib/aws-sdk-ec2/client.rb', line 42554

def get_image_block_public_access_state(params = {}, options = {})
  req = build_request(:get_image_block_public_access_state, params)
  req.send_request(options)
end

#get_instance_metadata_defaults(params = {}) ⇒ Types::GetInstanceMetadataDefaultsResult

Gets the default instance metadata service (IMDS) settings that are set at the account level in the specified Amazon Web Services
 Region.

For more information, see [Order of precedence for instance metadata options] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence

Examples:

Request syntax with placeholder values


resp = client.get_instance_metadata_defaults({
  dry_run: false,
})

Response structure


resp..http_tokens #=> String, one of "optional", "required"
resp..http_put_response_hop_limit #=> Integer
resp..http_endpoint #=> String, one of "disabled", "enabled"
resp..instance_metadata_tags #=> String, one of "disabled", "enabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



42596
42597
42598
42599
 
# File 'lib/aws-sdk-ec2/client.rb', line 42596

def get_instance_metadata_defaults(params = {}, options = {})
  req = build_request(:get_instance_metadata_defaults, params)
  req.send_request(options)
end

#get_instance_tpm_ek_pub(params = {}) ⇒ Types::GetInstanceTpmEkPubResult

Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.

Examples:

Request syntax with placeholder values


resp = client.get_instance_tpm_ek_pub({
  instance_id: "InstanceId", # required
  key_type: "rsa-2048", # required, accepts rsa-2048, ecc-sec-p384
  key_format: "der", # required, accepts der, tpmt
  dry_run: false,
})

Response structure


resp.instance_id #=> String
resp.key_type #=> String, one of "rsa-2048", "ecc-sec-p384"
resp.key_format #=> String, one of "der", "tpmt"
resp.key_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance for which to get the public endorsement key.

  • :key_type (required, String) —

    The required public endorsement key type.

  • :key_format (required, String) —

    The required public endorsement key format. Specify ‘der` for a DER-encoded public key that is compatible with OpenSSL. Specify `tpmt` for a TPM 2.0 format that is compatible with tpm2-tools. The returned key is base64 encoded.

  • :dry_run (Boolean) —

    Specify this parameter to verify whether the request will succeed, without actually making the request. If the request will succeed, the response is ‘DryRunOperation`. Otherwise, the response is `UnauthorizedOperation`.

Returns:

See Also:



42649
42650
42651
42652
 
# File 'lib/aws-sdk-ec2/client.rb', line 42649

def get_instance_tpm_ek_pub(params = {}, options = {})
  req = build_request(:get_instance_tpm_ek_pub, params)
  req.send_request(options)
end

#get_instance_types_from_instance_requirements(params = {}) ⇒ Types::GetInstanceTypesFromInstanceRequirementsResult

Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.

When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.

For more information, see [Preview instance types with specified attributes], [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*, and [Creating an Auto Scaling group using attribute-based instance type selection] in the *Amazon EC2 Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html#spotfleet-get-instance-types-from-instance-requirements [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html [4]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html [5]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_instance_types_from_instance_requirements({
  dry_run: false,
  architecture_types: ["i386"], # required, accepts i386, x86_64, arm64, x86_64_mac, arm64_mac
  virtualization_types: ["hvm"], # required, accepts hvm, paravirtual
  instance_requirements: { # required
    v_cpu_count: { # required
      min: 1, # required
      max: 1,
    },
    memory_mi_b: { # required
      min: 1, # required
      max: 1,
    },
    cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
    memory_gi_b_per_v_cpu: {
      min: 1.0,
      max: 1.0,
    },
    excluded_instance_types: ["ExcludedInstanceType"],
    instance_generations: ["current"], # accepts current, previous
    spot_max_price_percentage_over_lowest_price: 1,
    on_demand_max_price_percentage_over_lowest_price: 1,
    bare_metal: "included", # accepts included, required, excluded
    burstable_performance: "included", # accepts included, required, excluded
    require_hibernate_support: false,
    network_interface_count: {
      min: 1,
      max: 1,
    },
    local_storage: "included", # accepts included, required, excluded
    local_storage_types: ["hdd"], # accepts hdd, ssd
    total_local_storage_gb: {
      min: 1.0,
      max: 1.0,
    },
    baseline_ebs_bandwidth_mbps: {
      min: 1,
      max: 1,
    },
    accelerator_types: ["gpu"], # accepts gpu, fpga, inference
    accelerator_count: {
      min: 1,
      max: 1,
    },
    accelerator_manufacturers: ["amazon-web-services"], # accepts amazon-web-services, amd, nvidia, xilinx, habana
    accelerator_names: ["a100"], # accepts a100, inferentia, k520, k80, m60, radeon-pro-v520, t4, vu9p, v100, a10g, h100, t4g
    accelerator_total_memory_mi_b: {
      min: 1,
      max: 1,
    },
    network_bandwidth_gbps: {
      min: 1.0,
      max: 1.0,
    },
    allowed_instance_types: ["AllowedInstanceType"],
    max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
  },
  max_results: 1,
  next_token: "String",
})

Response structure


resp.instance_types #=> Array
resp.instance_types[0].instance_type #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :architecture_types (required, Array<String>) —

    The processor architecture type.

  • :virtualization_types (required, Array<String>) —

    The virtualization type.

  • :instance_requirements (required, Types::InstanceRequirementsRequest) —

    The attributes required for the instance types.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



42788
42789
42790
42791
 
# File 'lib/aws-sdk-ec2/client.rb', line 42788

def get_instance_types_from_instance_requirements(params = {}, options = {})
  req = build_request(:get_instance_types_from_instance_requirements, params)
  req.send_request(options)
end

#get_instance_uefi_data(params = {}) ⇒ Types::GetInstanceUefiDataResult

A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.

When you use [register-image] to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the ‘UefiData` parameter. You can modify the UEFI data by using the

python-uefivars tool][2

on GitHub. You can use the tool to convert

the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image.

For more information, see [UEFI Secure Boot] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/cli/latest/reference/ec2/register-image.html [2]: github.com/awslabs/python-uefivars [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html

Examples:

Request syntax with placeholder values


resp = client.get_instance_uefi_data({
  instance_id: "InstanceId", # required
  dry_run: false,
})

Response structure


resp.instance_id #=> String
resp.uefi_data #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance from which to retrieve the UEFI data.

  • :dry_run (Boolean) —

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

Returns:

See Also:



42844
42845
42846
42847
 
# File 'lib/aws-sdk-ec2/client.rb', line 42844

def get_instance_uefi_data(params = {}, options = {})
  req = build_request(:get_instance_uefi_data, params)
  req.send_request(options)
end

#get_ipam_address_history(params = {}) ⇒ Types::GetIpamAddressHistoryResult

Retrieve historical information about a CIDR within an IPAM scope. For more information, see [View the history of IP addresses] in the *Amazon VPC IPAM User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/view-history-cidr-ipam.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_ipam_address_history({
  dry_run: false,
  cidr: "String", # required
  ipam_scope_id: "IpamScopeId", # required
  vpc_id: "String",
  start_time: Time.now,
  end_time: Time.now,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.history_records #=> Array
resp.history_records[0].resource_owner_id #=> String
resp.history_records[0].resource_region #=> String
resp.history_records[0].resource_type #=> String, one of "eip", "vpc", "subnet", "network-interface", "instance"
resp.history_records[0].resource_id #=> String
resp.history_records[0].resource_cidr #=> String
resp.history_records[0].resource_name #=> String
resp.history_records[0].resource_compliance_status #=> String, one of "compliant", "noncompliant", "unmanaged", "ignored"
resp.history_records[0].resource_overlap_status #=> String, one of "overlapping", "nonoverlapping", "ignored"
resp.history_records[0].vpc_id #=> String
resp.history_records[0].sampled_start_time #=> Time
resp.history_records[0].sampled_end_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :cidr (required, String) —

    The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.

  • :ipam_scope_id (required, String) —

    The ID of the IPAM scope that the CIDR is in.

  • :vpc_id (String) —

    The ID of the VPC you want your history records filtered by.

  • :start_time (Time, DateTime, Date, Integer, String) —

    The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.

  • :end_time (Time, DateTime, Date, Integer, String) —

    The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.

  • :max_results (Integer) —

    The maximum number of historical results you would like returned per page. Defaults to 100.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



42930
42931
42932
42933
 
# File 'lib/aws-sdk-ec2/client.rb', line 42930

def get_ipam_address_history(params = {}, options = {})
  req = build_request(:get_ipam_address_history, params)
  req.send_request(options)
end

#get_ipam_discovered_accounts(params = {}) ⇒ Types::GetIpamDiscoveredAccountsResult

Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_ipam_discovered_accounts({
  dry_run: false,
  ipam_resource_discovery_id: "IpamResourceDiscoveryId", # required
  discovery_region: "String", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.ipam_discovered_accounts #=> Array
resp.ipam_discovered_accounts[0]. #=> String
resp.ipam_discovered_accounts[0].discovery_region #=> String
resp.ipam_discovered_accounts[0].failure_reason.code #=> String, one of "assume-role-failure", "throttling-failure", "unauthorized-failure"
resp.ipam_discovered_accounts[0].failure_reason.message #=> String
resp.ipam_discovered_accounts[0].last_attempted_discovery_time #=> Time
resp.ipam_discovered_accounts[0].last_successful_discovery_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_resource_discovery_id (required, String) —

    A resource discovery ID.

  • :discovery_region (required, String) —

    The Amazon Web Services Region that the account information is returned from.

  • :filters (Array<Types::Filter>) —

    Discovered account filters.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of discovered accounts to return in one page of results.

Returns:

See Also:



43003
43004
43005
43006
 
# File 'lib/aws-sdk-ec2/client.rb', line 43003

def get_ipam_discovered_accounts(params = {}, options = {})
  req = build_request(:get_ipam_discovered_accounts, params)
  req.send_request(options)
end

#get_ipam_discovered_public_addresses(params = {}) ⇒ Types::GetIpamDiscoveredPublicAddressesResult

Gets the public IP addresses that have been discovered by IPAM.

Examples:

Request syntax with placeholder values


resp = client.get_ipam_discovered_public_addresses({
  dry_run: false,
  ipam_resource_discovery_id: "IpamResourceDiscoveryId", # required
  address_region: "String", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.ipam_discovered_public_addresses #=> Array
resp.ipam_discovered_public_addresses[0].ipam_resource_discovery_id #=> String
resp.ipam_discovered_public_addresses[0].address_region #=> String
resp.ipam_discovered_public_addresses[0].address #=> String
resp.ipam_discovered_public_addresses[0].address_owner_id #=> String
resp.ipam_discovered_public_addresses[0].address_allocation_id #=> String
resp.ipam_discovered_public_addresses[0].association_status #=> String, one of "associated", "disassociated"
resp.ipam_discovered_public_addresses[0].address_type #=> String, one of "service-managed-ip", "service-managed-byoip", "amazon-owned-eip", "amazon-owned-contig", "byoip", "ec2-public-ip"
resp.ipam_discovered_public_addresses[0].service #=> String, one of "nat-gateway", "database-migration-service", "redshift", "elastic-container-service", "relational-database-service", "site-to-site-vpn", "load-balancer", "global-accelerator", "other"
resp.ipam_discovered_public_addresses[0].service_resource #=> String
resp.ipam_discovered_public_addresses[0].vpc_id #=> String
resp.ipam_discovered_public_addresses[0].subnet_id #=> String
resp.ipam_discovered_public_addresses[0].public_ipv_4_pool_id #=> String
resp.ipam_discovered_public_addresses[0].network_interface_id #=> String
resp.ipam_discovered_public_addresses[0].network_interface_description #=> String
resp.ipam_discovered_public_addresses[0].instance_id #=> String
resp.ipam_discovered_public_addresses[0].tags.eip_tags #=> Array
resp.ipam_discovered_public_addresses[0].tags.eip_tags[0].key #=> String
resp.ipam_discovered_public_addresses[0].tags.eip_tags[0].value #=> String
resp.ipam_discovered_public_addresses[0].network_border_group #=> String
resp.ipam_discovered_public_addresses[0].security_groups #=> Array
resp.ipam_discovered_public_addresses[0].security_groups[0].group_name #=> String
resp.ipam_discovered_public_addresses[0].security_groups[0].group_id #=> String
resp.ipam_discovered_public_addresses[0].sample_time #=> Time
resp.oldest_sample_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_resource_discovery_id (required, String) —

    An IPAM resource discovery ID.

  • :address_region (required, String) —

    The Amazon Web Services Region for the IP address.

  • :filters (Array<Types::Filter>) —

    Filters.

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (Integer) —

    The maximum number of IPAM discovered public addresses to return in one page of results.

Returns:

See Also:



43087
43088
43089
43090
 
# File 'lib/aws-sdk-ec2/client.rb', line 43087

def get_ipam_discovered_public_addresses(params = {}, options = {})
  req = build_request(:get_ipam_discovered_public_addresses, params)
  req.send_request(options)
end

#get_ipam_discovered_resource_cidrs(params = {}) ⇒ Types::GetIpamDiscoveredResourceCidrsResult

Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_ipam_discovered_resource_cidrs({
  dry_run: false,
  ipam_resource_discovery_id: "IpamResourceDiscoveryId", # required
  resource_region: "String", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.ipam_discovered_resource_cidrs #=> Array
resp.ipam_discovered_resource_cidrs[0].ipam_resource_discovery_id #=> String
resp.ipam_discovered_resource_cidrs[0].resource_region #=> String
resp.ipam_discovered_resource_cidrs[0].resource_id #=> String
resp.ipam_discovered_resource_cidrs[0].resource_owner_id #=> String
resp.ipam_discovered_resource_cidrs[0].resource_cidr #=> String
resp.ipam_discovered_resource_cidrs[0].ip_source #=> String, one of "amazon", "byoip", "none"
resp.ipam_discovered_resource_cidrs[0].resource_type #=> String, one of "vpc", "subnet", "eip", "public-ipv4-pool", "ipv6-pool", "eni"
resp.ipam_discovered_resource_cidrs[0].resource_tags #=> Array
resp.ipam_discovered_resource_cidrs[0].resource_tags[0].key #=> String
resp.ipam_discovered_resource_cidrs[0].resource_tags[0].value #=> String
resp.ipam_discovered_resource_cidrs[0].ip_usage #=> Float
resp.ipam_discovered_resource_cidrs[0].vpc_id #=> String
resp.ipam_discovered_resource_cidrs[0].subnet_id #=> String
resp.ipam_discovered_resource_cidrs[0].network_interface_attachment_status #=> String, one of "available", "in-use"
resp.ipam_discovered_resource_cidrs[0].sample_time #=> Time
resp.ipam_discovered_resource_cidrs[0].availability_zone_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_resource_discovery_id (required, String) —

    A resource discovery ID.

  • :resource_region (required, String) —

    A resource Region.

  • :filters (Array<Types::Filter>) —

    Filters.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of discovered resource CIDRs to return in one page of results.

Returns:

See Also:



43168
43169
43170
43171
 
# File 'lib/aws-sdk-ec2/client.rb', line 43168

def get_ipam_discovered_resource_cidrs(params = {}, options = {})
  req = build_request(:get_ipam_discovered_resource_cidrs, params)
  req.send_request(options)
end

#get_ipam_pool_allocations(params = {}) ⇒ Types::GetIpamPoolAllocationsResult

Get a list of all the CIDR allocations in 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.

<note markdown=“1”> If you use this action after [AllocateIpamPoolCidr] or [ReleaseIpamPoolAllocation], note that all EC2 API actions follow an [eventual consistency] model.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AllocateIpamPoolCidr.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html [3]: docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_ipam_pool_allocations({
  dry_run: false,
  ipam_pool_id: "IpamPoolId", # required
  ipam_pool_allocation_id: "IpamPoolAllocationId",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.ipam_pool_allocations #=> Array
resp.ipam_pool_allocations[0].cidr #=> String
resp.ipam_pool_allocations[0].ipam_pool_allocation_id #=> String
resp.ipam_pool_allocations[0].description #=> String
resp.ipam_pool_allocations[0].resource_id #=> String
resp.ipam_pool_allocations[0].resource_type #=> String, one of "ipam-pool", "vpc", "ec2-public-ipv4-pool", "custom", "subnet", "eip"
resp.ipam_pool_allocations[0].resource_region #=> String
resp.ipam_pool_allocations[0].resource_owner #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_pool_id (required, String) —

    The ID of the IPAM pool you want to see the allocations for.

  • :ipam_pool_allocation_id (String) —

    The ID of the allocation.

  • :filters (Array<Types::Filter>) —

    One or more filters for the request. For more information about filtering, see [Filtering CLI output].

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html

  • :max_results (Integer) —

    The maximum number of results you would like returned per page.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



43254
43255
43256
43257
 
# File 'lib/aws-sdk-ec2/client.rb', line 43254

def get_ipam_pool_allocations(params = {}, options = {})
  req = build_request(:get_ipam_pool_allocations, params)
  req.send_request(options)
end

#get_ipam_pool_cidrs(params = {}) ⇒ Types::GetIpamPoolCidrsResult

Get the CIDRs provisioned to an IPAM pool.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_ipam_pool_cidrs({
  dry_run: false,
  ipam_pool_id: "IpamPoolId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.ipam_pool_cidrs #=> Array
resp.ipam_pool_cidrs[0].cidr #=> String
resp.ipam_pool_cidrs[0].state #=> String, one of "pending-provision", "provisioned", "failed-provision", "pending-deprovision", "deprovisioned", "failed-deprovision", "pending-import", "failed-import"
resp.ipam_pool_cidrs[0].failure_reason.code #=> String, one of "cidr-not-available", "limit-exceeded"
resp.ipam_pool_cidrs[0].failure_reason.message #=> String
resp.ipam_pool_cidrs[0].ipam_pool_cidr_id #=> String
resp.ipam_pool_cidrs[0].netmask_length #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_pool_id (required, String) —

    The ID of the IPAM pool you want the CIDR for.

  • :filters (Array<Types::Filter>) —

    One or more filters for the request. For more information about filtering, see [Filtering CLI output].

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html

  • :max_results (Integer) —

    The maximum number of results to return in the request.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



43321
43322
43323
43324
 
# File 'lib/aws-sdk-ec2/client.rb', line 43321

def get_ipam_pool_cidrs(params = {}, options = {})
  req = build_request(:get_ipam_pool_cidrs, params)
  req.send_request(options)
end

#get_ipam_resource_cidrs(params = {}) ⇒ Types::GetIpamResourceCidrsResult

Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_ipam_resource_cidrs({
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  ipam_scope_id: "IpamScopeId", # required
  ipam_pool_id: "IpamPoolId",
  resource_id: "String",
  resource_type: "vpc", # accepts vpc, subnet, eip, public-ipv4-pool, ipv6-pool, eni
  resource_tag: {
    key: "String",
    value: "String",
  },
  resource_owner: "String",
})

Response structure


resp.next_token #=> String
resp.ipam_resource_cidrs #=> Array
resp.ipam_resource_cidrs[0].ipam_id #=> String
resp.ipam_resource_cidrs[0].ipam_scope_id #=> String
resp.ipam_resource_cidrs[0].ipam_pool_id #=> String
resp.ipam_resource_cidrs[0].resource_region #=> String
resp.ipam_resource_cidrs[0].resource_owner_id #=> String
resp.ipam_resource_cidrs[0].resource_id #=> String
resp.ipam_resource_cidrs[0].resource_name #=> String
resp.ipam_resource_cidrs[0].resource_cidr #=> String
resp.ipam_resource_cidrs[0].resource_type #=> String, one of "vpc", "subnet", "eip", "public-ipv4-pool", "ipv6-pool", "eni"
resp.ipam_resource_cidrs[0].resource_tags #=> Array
resp.ipam_resource_cidrs[0].resource_tags[0].key #=> String
resp.ipam_resource_cidrs[0].resource_tags[0].value #=> String
resp.ipam_resource_cidrs[0].ip_usage #=> Float
resp.ipam_resource_cidrs[0].compliance_status #=> String, one of "compliant", "noncompliant", "unmanaged", "ignored"
resp.ipam_resource_cidrs[0].management_state #=> String, one of "managed", "unmanaged", "ignored"
resp.ipam_resource_cidrs[0].overlap_status #=> String, one of "overlapping", "nonoverlapping", "ignored"
resp.ipam_resource_cidrs[0].vpc_id #=> String
resp.ipam_resource_cidrs[0].availability_zone_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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<Types::Filter>) —

    One or more filters for the request. For more information about filtering, see [Filtering CLI output].

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html

  • :max_results (Integer) —

    The maximum number of results to return in the request.

  • :next_token (String) —

    The token for the next page of results.

  • :ipam_scope_id (required, String) —

    The ID of the scope that the resource is in.

  • :ipam_pool_id (String) —

    The ID of the IPAM pool that the resource is in.

  • :resource_id (String) —

    The ID of the resource.

  • :resource_type (String) —

    The resource type.

  • :resource_tag (Types::RequestIpamResourceTag) —

    The resource tag.

  • :resource_owner (String) —

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

Returns:

See Also:



43427
43428
43429
43430
 
# File 'lib/aws-sdk-ec2/client.rb', line 43427

def get_ipam_resource_cidrs(params = {}, options = {})
  req = build_request(:get_ipam_resource_cidrs, params)
  req.send_request(options)
end

#get_launch_template_data(params = {}) ⇒ Types::GetLaunchTemplateDataResult

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: ‘DescribeSpotInstanceRequests`, `DescribeInstanceCreditSpecifications`, `DescribeVolumes`, and `DescribeInstanceAttribute`. Or, you can allow `describe*` depending on your instance requirements.

Examples:

Example: To get the launch template data for an instance


# This example gets the launch template data for the specified instance.

resp = client.get_launch_template_data({
  instance_id: "0123d646e8048babc", 
})

resp.to_h outputs the following:
{
  launch_template_data: {
    block_device_mappings: [
      {
        device_name: "/dev/xvda", 
        ebs: {
          delete_on_termination: true, 
          encrypted: false, 
          iops: 100, 
          snapshot_id: "snap-02594938353ef77d3", 
          volume_size: 8, 
          volume_type: "gp2", 
        }, 
      }, 
    ], 
    ebs_optimized: false, 
    image_id: "ami-32cf7b4a", 
    instance_type: "t2.medium", 
    key_name: "my-key-pair", 
    monitoring: {
      enabled: false, 
    }, 
    network_interfaces: [
      {
        associate_public_ip_address: false, 
        delete_on_termination: true, 
        description: "", 
        device_index: 0, 
        groups: [
          "sg-d14e1bb4", 
        ], 
        ipv_6_addresses: [
        ], 
        network_interface_id: "eni-4338b5a9", 
        private_ip_address: "10.0.3.233", 
        private_ip_addresses: [
          {
            primary: true, 
            private_ip_address: "10.0.3.233", 
          }, 
        ], 
        subnet_id: "subnet-5264e837", 
      }, 
    ], 
    placement: {
      availability_zone: "us-east-2b", 
      group_name: "", 
      tenancy: "default", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.get_launch_template_data({
  dry_run: false,
  instance_id: "InstanceId", # required
})

Response structure


resp.launch_template_data.kernel_id #=> String
resp.launch_template_data.ebs_optimized #=> Boolean
resp.launch_template_data.iam_instance_profile.arn #=> String
resp.launch_template_data.iam_instance_profile.name #=> String
resp.launch_template_data.block_device_mappings #=> Array
resp.launch_template_data.block_device_mappings[0].device_name #=> String
resp.launch_template_data.block_device_mappings[0].virtual_name #=> String
resp.launch_template_data.block_device_mappings[0].ebs.encrypted #=> Boolean
resp.launch_template_data.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.launch_template_data.block_device_mappings[0].ebs.iops #=> Integer
resp.launch_template_data.block_device_mappings[0].ebs.kms_key_id #=> String
resp.launch_template_data.block_device_mappings[0].ebs.snapshot_id #=> String
resp.launch_template_data.block_device_mappings[0].ebs.volume_size #=> Integer
resp.launch_template_data.block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.launch_template_data.block_device_mappings[0].ebs.throughput #=> Integer
resp.launch_template_data.block_device_mappings[0].no_device #=> String
resp.launch_template_data.network_interfaces #=> Array
resp.launch_template_data.network_interfaces[0].associate_carrier_ip_address #=> Boolean
resp.launch_template_data.network_interfaces[0].associate_public_ip_address #=> Boolean
resp.launch_template_data.network_interfaces[0].delete_on_termination #=> Boolean
resp.launch_template_data.network_interfaces[0].description #=> String
resp.launch_template_data.network_interfaces[0].device_index #=> Integer
resp.launch_template_data.network_interfaces[0].groups #=> Array
resp.launch_template_data.network_interfaces[0].groups[0] #=> String
resp.launch_template_data.network_interfaces[0].interface_type #=> String
resp.launch_template_data.network_interfaces[0].ipv_6_address_count #=> Integer
resp.launch_template_data.network_interfaces[0].ipv_6_addresses #=> Array
resp.launch_template_data.network_interfaces[0].ipv_6_addresses[0].ipv_6_address #=> String
resp.launch_template_data.network_interfaces[0].ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.launch_template_data.network_interfaces[0].network_interface_id #=> String
resp.launch_template_data.network_interfaces[0].private_ip_address #=> String
resp.launch_template_data.network_interfaces[0].private_ip_addresses #=> Array
resp.launch_template_data.network_interfaces[0].private_ip_addresses[0].primary #=> Boolean
resp.launch_template_data.network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String
resp.launch_template_data.network_interfaces[0].secondary_private_ip_address_count #=> Integer
resp.launch_template_data.network_interfaces[0].subnet_id #=> String
resp.launch_template_data.network_interfaces[0].network_card_index #=> Integer
resp.launch_template_data.network_interfaces[0].ipv_4_prefixes #=> Array
resp.launch_template_data.network_interfaces[0].ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.launch_template_data.network_interfaces[0].ipv_4_prefix_count #=> Integer
resp.launch_template_data.network_interfaces[0].ipv_6_prefixes #=> Array
resp.launch_template_data.network_interfaces[0].ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.launch_template_data.network_interfaces[0].ipv_6_prefix_count #=> Integer
resp.launch_template_data.network_interfaces[0].primary_ipv_6 #=> Boolean
resp.launch_template_data.network_interfaces[0].ena_srd_specification.ena_srd_enabled #=> Boolean
resp.launch_template_data.network_interfaces[0].ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.launch_template_data.network_interfaces[0].connection_tracking_specification.tcp_established_timeout #=> Integer
resp.launch_template_data.network_interfaces[0].connection_tracking_specification.udp_timeout #=> Integer
resp.launch_template_data.network_interfaces[0].connection_tracking_specification.udp_stream_timeout #=> Integer
resp.launch_template_data.image_id #=> String
resp.launch_template_data.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.launch_template_data.key_name #=> String
resp.launch_template_data.monitoring.enabled #=> Boolean
resp.launch_template_data.placement.availability_zone #=> String
resp.launch_template_data.placement.affinity #=> String
resp.launch_template_data.placement.group_name #=> String
resp.launch_template_data.placement.host_id #=> String
resp.launch_template_data.placement.tenancy #=> String, one of "default", "dedicated", "host"
resp.launch_template_data.placement.spread_domain #=> String
resp.launch_template_data.placement.host_resource_group_arn #=> String
resp.launch_template_data.placement.partition_number #=> Integer
resp.launch_template_data.placement.group_id #=> String
resp.launch_template_data.ram_disk_id #=> String
resp.launch_template_data.disable_api_termination #=> Boolean
resp.launch_template_data.instance_initiated_shutdown_behavior #=> String, one of "stop", "terminate"
resp.launch_template_data.user_data #=> String
resp.launch_template_data.tag_specifications #=> Array
resp.launch_template_data.tag_specifications[0].resource_type #=> String, one of "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"
resp.launch_template_data.tag_specifications[0].tags #=> Array
resp.launch_template_data.tag_specifications[0].tags[0].key #=> String
resp.launch_template_data.tag_specifications[0].tags[0].value #=> String
resp.launch_template_data.elastic_gpu_specifications #=> Array
resp.launch_template_data.elastic_gpu_specifications[0].type #=> String
resp.launch_template_data.elastic_inference_accelerators #=> Array
resp.launch_template_data.elastic_inference_accelerators[0].type #=> String
resp.launch_template_data.elastic_inference_accelerators[0].count #=> Integer
resp.launch_template_data.security_group_ids #=> Array
resp.launch_template_data.security_group_ids[0] #=> String
resp.launch_template_data.security_groups #=> Array
resp.launch_template_data.security_groups[0] #=> String
resp.launch_template_data.instance_market_options.market_type #=> String, one of "spot", "capacity-block"
resp.launch_template_data.instance_market_options.spot_options.max_price #=> String
resp.launch_template_data.instance_market_options.spot_options.spot_instance_type #=> String, one of "one-time", "persistent"
resp.launch_template_data.instance_market_options.spot_options.block_duration_minutes #=> Integer
resp.launch_template_data.instance_market_options.spot_options.valid_until #=> Time
resp.launch_template_data.instance_market_options.spot_options.instance_interruption_behavior #=> String, one of "hibernate", "stop", "terminate"
resp.launch_template_data.credit_specification.cpu_credits #=> String
resp.launch_template_data.cpu_options.core_count #=> Integer
resp.launch_template_data.cpu_options.threads_per_core #=> Integer
resp.launch_template_data.cpu_options.amd_sev_snp #=> String, one of "enabled", "disabled"
resp.launch_template_data.capacity_reservation_specification.capacity_reservation_preference #=> String, one of "open", "none"
resp.launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_id #=> String
resp.launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_resource_group_arn #=> String
resp.launch_template_data.license_specifications #=> Array
resp.launch_template_data.license_specifications[0].license_configuration_arn #=> String
resp.launch_template_data.hibernation_options.configured #=> Boolean
resp.launch_template_data.metadata_options.state #=> String, one of "pending", "applied"
resp.launch_template_data.metadata_options.http_tokens #=> String, one of "optional", "required"
resp.launch_template_data.metadata_options.http_put_response_hop_limit #=> Integer
resp.launch_template_data.metadata_options.http_endpoint #=> String, one of "disabled", "enabled"
resp.launch_template_data.metadata_options.http_protocol_ipv_6 #=> String, one of "disabled", "enabled"
resp.launch_template_data.metadata_options.instance_metadata_tags #=> String, one of "disabled", "enabled"
resp.launch_template_data.enclave_options.enabled #=> Boolean
resp.launch_template_data.instance_requirements.v_cpu_count.min #=> Integer
resp.launch_template_data.instance_requirements.v_cpu_count.max #=> Integer
resp.launch_template_data.instance_requirements.memory_mi_b.min #=> Integer
resp.launch_template_data.instance_requirements.memory_mi_b.max #=> Integer
resp.launch_template_data.instance_requirements.cpu_manufacturers #=> Array
resp.launch_template_data.instance_requirements.cpu_manufacturers[0] #=> String, one of "intel", "amd", "amazon-web-services"
resp.launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.min #=> Float
resp.launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.max #=> Float
resp.launch_template_data.instance_requirements.excluded_instance_types #=> Array
resp.launch_template_data.instance_requirements.excluded_instance_types[0] #=> String
resp.launch_template_data.instance_requirements.instance_generations #=> Array
resp.launch_template_data.instance_requirements.instance_generations[0] #=> String, one of "current", "previous"
resp.launch_template_data.instance_requirements.spot_max_price_percentage_over_lowest_price #=> Integer
resp.launch_template_data.instance_requirements.on_demand_max_price_percentage_over_lowest_price #=> Integer
resp.launch_template_data.instance_requirements.bare_metal #=> String, one of "included", "required", "excluded"
resp.launch_template_data.instance_requirements.burstable_performance #=> String, one of "included", "required", "excluded"
resp.launch_template_data.instance_requirements.require_hibernate_support #=> Boolean
resp.launch_template_data.instance_requirements.network_interface_count.min #=> Integer
resp.launch_template_data.instance_requirements.network_interface_count.max #=> Integer
resp.launch_template_data.instance_requirements.local_storage #=> String, one of "included", "required", "excluded"
resp.launch_template_data.instance_requirements.local_storage_types #=> Array
resp.launch_template_data.instance_requirements.local_storage_types[0] #=> String, one of "hdd", "ssd"
resp.launch_template_data.instance_requirements.total_local_storage_gb.min #=> Float
resp.launch_template_data.instance_requirements.total_local_storage_gb.max #=> Float
resp.launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.min #=> Integer
resp.launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.max #=> Integer
resp.launch_template_data.instance_requirements.accelerator_types #=> Array
resp.launch_template_data.instance_requirements.accelerator_types[0] #=> String, one of "gpu", "fpga", "inference"
resp.launch_template_data.instance_requirements.accelerator_count.min #=> Integer
resp.launch_template_data.instance_requirements.accelerator_count.max #=> Integer
resp.launch_template_data.instance_requirements.accelerator_manufacturers #=> Array
resp.launch_template_data.instance_requirements.accelerator_manufacturers[0] #=> String, one of "amazon-web-services", "amd", "nvidia", "xilinx", "habana"
resp.launch_template_data.instance_requirements.accelerator_names #=> Array
resp.launch_template_data.instance_requirements.accelerator_names[0] #=> String, one of "a100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "vu9p", "v100", "a10g", "h100", "t4g"
resp.launch_template_data.instance_requirements.accelerator_total_memory_mi_b.min #=> Integer
resp.launch_template_data.instance_requirements.accelerator_total_memory_mi_b.max #=> Integer
resp.launch_template_data.instance_requirements.network_bandwidth_gbps.min #=> Float
resp.launch_template_data.instance_requirements.network_bandwidth_gbps.max #=> Float
resp.launch_template_data.instance_requirements.allowed_instance_types #=> Array
resp.launch_template_data.instance_requirements.allowed_instance_types[0] #=> String
resp.launch_template_data.instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price #=> Integer
resp.launch_template_data.private_dns_name_options.hostname_type #=> String, one of "ip-name", "resource-name"
resp.launch_template_data.private_dns_name_options.enable_resource_name_dns_a_record #=> Boolean
resp.launch_template_data.private_dns_name_options.enable_resource_name_dns_aaaa_record #=> Boolean
resp.launch_template_data.maintenance_options.auto_recovery #=> String, one of "default", "disabled"
resp.launch_template_data.disable_api_stop #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the instance.

Returns:

See Also:



43681
43682
43683
43684
 
# File 'lib/aws-sdk-ec2/client.rb', line 43681

def get_launch_template_data(params = {}, options = {})
  req = build_request(:get_launch_template_data, params)
  req.send_request(options)
end

#get_managed_prefix_list_associations(params = {}) ⇒ Types::GetManagedPrefixListAssociationsResult

Gets information about the resources that are associated with the specified managed prefix list.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_managed_prefix_list_associations({
  dry_run: false,
  prefix_list_id: "PrefixListResourceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.prefix_list_associations #=> Array
resp.prefix_list_associations[0].resource_id #=> String
resp.prefix_list_associations[0].resource_owner #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The ID of the prefix list.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



43733
43734
43735
43736
 
# File 'lib/aws-sdk-ec2/client.rb', line 43733

def get_managed_prefix_list_associations(params = {}, options = {})
  req = build_request(:get_managed_prefix_list_associations, params)
  req.send_request(options)
end

#get_managed_prefix_list_entries(params = {}) ⇒ Types::GetManagedPrefixListEntriesResult

Gets information about the entries for a specified managed prefix list.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_managed_prefix_list_entries({
  dry_run: false,
  prefix_list_id: "PrefixListResourceId", # required
  target_version: 1,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.data.entries #=> Array
resp.data.entries[0].cidr #=> String
resp.data.entries[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The ID of the prefix list.

  • :target_version (Integer) —

    The version of the prefix list for which to return the entries. The default is the current version.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



43790
43791
43792
43793
 
# File 'lib/aws-sdk-ec2/client.rb', line 43790

def get_managed_prefix_list_entries(params = {}, options = {})
  req = build_request(:get_managed_prefix_list_entries, params)
  req.send_request(options)
end

#get_network_insights_access_scope_analysis_findings(params = {}) ⇒ Types::GetNetworkInsightsAccessScopeAnalysisFindingsResult

Gets the findings for the specified Network Access Scope analysis.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_network_insights_access_scope_analysis_findings({
  network_insights_access_scope_analysis_id: "NetworkInsightsAccessScopeAnalysisId", # required
  max_results: 1,
  next_token: "NextToken",
  dry_run: false,
})

Response structure


resp.network_insights_access_scope_analysis_id #=> String
resp.analysis_status #=> String, one of "running", "succeeded", "failed"
resp.analysis_findings #=> Array
resp.analysis_findings[0].network_insights_access_scope_analysis_id #=> String
resp.analysis_findings[0].network_insights_access_scope_id #=> String
resp.analysis_findings[0].finding_id #=> String
resp.analysis_findings[0].finding_components #=> Array
resp.analysis_findings[0].finding_components[0].sequence_number #=> Integer
resp.analysis_findings[0].finding_components[0].acl_rule.cidr #=> String
resp.analysis_findings[0].finding_components[0].acl_rule.egress #=> Boolean
resp.analysis_findings[0].finding_components[0].acl_rule.port_range.from #=> Integer
resp.analysis_findings[0].finding_components[0].acl_rule.port_range.to #=> Integer
resp.analysis_findings[0].finding_components[0].acl_rule.protocol #=> String
resp.analysis_findings[0].finding_components[0].acl_rule.rule_action #=> String
resp.analysis_findings[0].finding_components[0].acl_rule.rule_number #=> Integer
resp.analysis_findings[0].finding_components[0].attached_to.id #=> String
resp.analysis_findings[0].finding_components[0].attached_to.arn #=> String
resp.analysis_findings[0].finding_components[0].attached_to.name #=> String
resp.analysis_findings[0].finding_components[0].component.id #=> String
resp.analysis_findings[0].finding_components[0].component.arn #=> String
resp.analysis_findings[0].finding_components[0].component.name #=> String
resp.analysis_findings[0].finding_components[0].destination_vpc.id #=> String
resp.analysis_findings[0].finding_components[0].destination_vpc.arn #=> String
resp.analysis_findings[0].finding_components[0].destination_vpc.name #=> String
resp.analysis_findings[0].finding_components[0].outbound_header.destination_addresses #=> Array
resp.analysis_findings[0].finding_components[0].outbound_header.destination_addresses[0] #=> String
resp.analysis_findings[0].finding_components[0].outbound_header.destination_port_ranges #=> Array
resp.analysis_findings[0].finding_components[0].outbound_header.destination_port_ranges[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].outbound_header.destination_port_ranges[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].outbound_header.protocol #=> String
resp.analysis_findings[0].finding_components[0].outbound_header.source_addresses #=> Array
resp.analysis_findings[0].finding_components[0].outbound_header.source_addresses[0] #=> String
resp.analysis_findings[0].finding_components[0].outbound_header.source_port_ranges #=> Array
resp.analysis_findings[0].finding_components[0].outbound_header.source_port_ranges[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].outbound_header.source_port_ranges[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].inbound_header.destination_addresses #=> Array
resp.analysis_findings[0].finding_components[0].inbound_header.destination_addresses[0] #=> String
resp.analysis_findings[0].finding_components[0].inbound_header.destination_port_ranges #=> Array
resp.analysis_findings[0].finding_components[0].inbound_header.destination_port_ranges[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].inbound_header.destination_port_ranges[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].inbound_header.protocol #=> String
resp.analysis_findings[0].finding_components[0].inbound_header.source_addresses #=> Array
resp.analysis_findings[0].finding_components[0].inbound_header.source_addresses[0] #=> String
resp.analysis_findings[0].finding_components[0].inbound_header.source_port_ranges #=> Array
resp.analysis_findings[0].finding_components[0].inbound_header.source_port_ranges[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].inbound_header.source_port_ranges[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].route_table_route.destination_cidr #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.destination_prefix_list_id #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.gateway_id #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.instance_id #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.nat_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.network_interface_id #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.origin #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.transit_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.vpc_peering_connection_id #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.state #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.carrier_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.core_network_arn #=> String
resp.analysis_findings[0].finding_components[0].route_table_route.local_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].security_group_rule.cidr #=> String
resp.analysis_findings[0].finding_components[0].security_group_rule.direction #=> String
resp.analysis_findings[0].finding_components[0].security_group_rule.security_group_id #=> String
resp.analysis_findings[0].finding_components[0].security_group_rule.port_range.from #=> Integer
resp.analysis_findings[0].finding_components[0].security_group_rule.port_range.to #=> Integer
resp.analysis_findings[0].finding_components[0].security_group_rule.prefix_list_id #=> String
resp.analysis_findings[0].finding_components[0].security_group_rule.protocol #=> String
resp.analysis_findings[0].finding_components[0].source_vpc.id #=> String
resp.analysis_findings[0].finding_components[0].source_vpc.arn #=> String
resp.analysis_findings[0].finding_components[0].source_vpc.name #=> String
resp.analysis_findings[0].finding_components[0].subnet.id #=> String
resp.analysis_findings[0].finding_components[0].subnet.arn #=> String
resp.analysis_findings[0].finding_components[0].subnet.name #=> String
resp.analysis_findings[0].finding_components[0].vpc.id #=> String
resp.analysis_findings[0].finding_components[0].vpc.arn #=> String
resp.analysis_findings[0].finding_components[0].vpc.name #=> String
resp.analysis_findings[0].finding_components[0].additional_details #=> Array
resp.analysis_findings[0].finding_components[0].additional_details[0].additional_detail_type #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].component.id #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].component.arn #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].component.name #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].vpc_endpoint_service.id #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].vpc_endpoint_service.arn #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].vpc_endpoint_service.name #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_options #=> Array
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_options[0].keyword #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_options[0].settings #=> Array
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_options[0].settings[0] #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_group_type_pairs #=> Array
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_arn #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_type #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_group_rule_options_pairs #=> Array
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_group_arn #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options #=> Array
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].keyword #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings #=> Array
resp.analysis_findings[0].finding_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings[0] #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].service_name #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].load_balancers #=> Array
resp.analysis_findings[0].finding_components[0].additional_details[0].load_balancers[0].id #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].load_balancers[0].arn #=> String
resp.analysis_findings[0].finding_components[0].additional_details[0].load_balancers[0].name #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway.id #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway.arn #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway.name #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway_route_table_route.state #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway_route_table_route.route_origin #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway_route_table_route.attachment_id #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway_route_table_route.resource_id #=> String
resp.analysis_findings[0].finding_components[0].transit_gateway_route_table_route.resource_type #=> String
resp.analysis_findings[0].finding_components[0].explanations #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].acl.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].acl.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].acl.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].acl_rule.cidr #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].acl_rule.egress #=> Boolean
resp.analysis_findings[0].finding_components[0].explanations[0].acl_rule.port_range.from #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].acl_rule.port_range.to #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].acl_rule.protocol #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].acl_rule.rule_action #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].acl_rule.rule_number #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].address #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].addresses #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].addresses[0] #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].attached_to.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].attached_to.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].attached_to.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].availability_zones #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].availability_zones[0] #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].cidrs #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].cidrs[0] #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].component.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].component.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].component.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].customer_gateway.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].customer_gateway.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].customer_gateway.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].destination.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].destination.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].destination.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].destination_vpc.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].destination_vpc.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].destination_vpc.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].direction #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].explanation_code #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].ingress_route_table.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].ingress_route_table.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].ingress_route_table.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].internet_gateway.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].internet_gateway.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].internet_gateway.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].classic_load_balancer_listener.load_balancer_port #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].classic_load_balancer_listener.instance_port #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_listener_port #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target.address #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target.availability_zone #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target.instance.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target.instance.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target.instance.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target.port #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target_group.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target_group.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target_group.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target_groups #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target_groups[0].id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target_groups[0].arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target_groups[0].name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].load_balancer_target_port #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].elastic_load_balancer_listener.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].elastic_load_balancer_listener.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].elastic_load_balancer_listener.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].missing_component #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].nat_gateway.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].nat_gateway.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].nat_gateway.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].network_interface.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].network_interface.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].network_interface.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].packet_field #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpc_peering_connection.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpc_peering_connection.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpc_peering_connection.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].port #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].port_ranges #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].port_ranges[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].port_ranges[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].prefix_list.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].prefix_list.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].prefix_list.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].protocols #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].protocols[0] #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.destination_cidr #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.destination_prefix_list_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.gateway_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.instance_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.nat_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.network_interface_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.origin #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.transit_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.vpc_peering_connection_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.state #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.carrier_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.core_network_arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table_route.local_gateway_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].route_table.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_group.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_group.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_group.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_group_rule.cidr #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_group_rule.direction #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_group_rule.security_group_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_group_rule.port_range.from #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].security_group_rule.port_range.to #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].security_group_rule.prefix_list_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_group_rule.protocol #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_groups #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].security_groups[0].id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_groups[0].arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].security_groups[0].name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].source_vpc.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].source_vpc.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].source_vpc.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].state #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].subnet.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].subnet.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].subnet.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].subnet_route_table.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].subnet_route_table.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].subnet_route_table.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpc.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpc.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpc.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpc_endpoint.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpc_endpoint.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpc_endpoint.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpn_connection.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpn_connection.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpn_connection.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpn_gateway.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpn_gateway.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].vpn_gateway.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table_route.state #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table_route.route_origin #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table_route.attachment_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table_route.resource_id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_route_table_route.resource_type #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_attachment.id #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_attachment.arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].transit_gateway_attachment.name #=> String
resp.analysis_findings[0].finding_components[0].explanations[0]. #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].component_region #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.rule_group_arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.sources #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.sources[0] #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.destinations #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.destinations[0] #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.source_ports #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.destination_ports #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.protocols #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.rule_action #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateless_rule.priority #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.rule_group_arn #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.sources #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.sources[0] #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.destinations #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.destinations[0] #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.source_ports #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.destination_ports #=> Array
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.protocol #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.rule_action #=> String
resp.analysis_findings[0].finding_components[0].explanations[0].firewall_stateful_rule.direction #=> String
resp.analysis_findings[0].finding_components[0].elastic_load_balancer_listener.id #=> String
resp.analysis_findings[0].finding_components[0].elastic_load_balancer_listener.arn #=> String
resp.analysis_findings[0].finding_components[0].elastic_load_balancer_listener.name #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.rule_group_arn #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.sources #=> Array
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.sources[0] #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.destinations #=> Array
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.destinations[0] #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.source_ports #=> Array
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.destination_ports #=> Array
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.protocols #=> Array
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.rule_action #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateless_rule.priority #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.rule_group_arn #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.sources #=> Array
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.sources[0] #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.destinations #=> Array
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.destinations[0] #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.source_ports #=> Array
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.destination_ports #=> Array
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.protocol #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.rule_action #=> String
resp.analysis_findings[0].finding_components[0].firewall_stateful_rule.direction #=> String
resp.analysis_findings[0].finding_components[0].service_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_insights_access_scope_analysis_id (required, String) —

    The ID of the Network Access Scope analysis.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



44167
44168
44169
44170
 
# File 'lib/aws-sdk-ec2/client.rb', line 44167

def get_network_insights_access_scope_analysis_findings(params = {}, options = {})
  req = build_request(:get_network_insights_access_scope_analysis_findings, params)
  req.send_request(options)
end

#get_network_insights_access_scope_content(params = {}) ⇒ Types::GetNetworkInsightsAccessScopeContentResult

Gets the content for the specified Network Access Scope.

Examples:

Request syntax with placeholder values


resp = client.get_network_insights_access_scope_content({
  network_insights_access_scope_id: "NetworkInsightsAccessScopeId", # required
  dry_run: false,
})

Response structure


resp.network_insights_access_scope_content.network_insights_access_scope_id #=> String
resp.network_insights_access_scope_content.match_paths #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_addresses #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_addresses[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_addresses #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_addresses[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_ports #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_ports[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_ports #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_ports[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_prefix_lists #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.source_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_prefix_lists #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.destination_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.protocols #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.packet_header_statement.protocols[0] #=> String, one of "tcp", "udp"
resp.network_insights_access_scope_content.match_paths[0].source.resource_statement.resources #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].source.resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.match_paths[0].source.resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_addresses #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_addresses[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_addresses #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_addresses[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_ports #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_ports[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_ports #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_ports[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_prefix_lists #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.source_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_prefix_lists #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.destination_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.protocols #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.packet_header_statement.protocols[0] #=> String, one of "tcp", "udp"
resp.network_insights_access_scope_content.match_paths[0].destination.resource_statement.resources #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].destination.resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.match_paths[0].destination.resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].through_resources #=> Array
resp.network_insights_access_scope_content.match_paths[0].through_resources[0].resource_statement.resources #=> Array
resp.network_insights_access_scope_content.match_paths[0].through_resources[0].resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.match_paths[0].through_resources[0].resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.match_paths[0].through_resources[0].resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.exclude_paths #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_addresses #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_addresses[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_addresses #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_addresses[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_ports #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_ports[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_ports #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_ports[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_prefix_lists #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.source_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_prefix_lists #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.destination_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.protocols #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.packet_header_statement.protocols[0] #=> String, one of "tcp", "udp"
resp.network_insights_access_scope_content.exclude_paths[0].source.resource_statement.resources #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].source.resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].source.resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_addresses #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_addresses[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_addresses #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_addresses[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_ports #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_ports[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_ports #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_ports[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_prefix_lists #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.source_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_prefix_lists #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.destination_prefix_lists[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.protocols #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.packet_header_statement.protocols[0] #=> String, one of "tcp", "udp"
resp.network_insights_access_scope_content.exclude_paths[0].destination.resource_statement.resources #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].destination.resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].destination.resource_statement.resource_types[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].through_resources #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].through_resources[0].resource_statement.resources #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].through_resources[0].resource_statement.resources[0] #=> String
resp.network_insights_access_scope_content.exclude_paths[0].through_resources[0].resource_statement.resource_types #=> Array
resp.network_insights_access_scope_content.exclude_paths[0].through_resources[0].resource_statement.resource_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_insights_access_scope_id (required, String) —

    The ID of the Network Access Scope.

  • :dry_run (Boolean) —

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

Returns:

See Also:



44286
44287
44288
44289
 
# File 'lib/aws-sdk-ec2/client.rb', line 44286

def get_network_insights_access_scope_content(params = {}, options = {})
  req = build_request(:get_network_insights_access_scope_content, params)
  req.send_request(options)
end

#get_password_data(params = {}) ⇒ Types::GetPasswordDataResult

Retrieves the encrypted administrator password for a running Windows instance.

The Windows password is generated at boot by the ‘EC2Config` service or `EC2Launch` scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see [EC2Config] and [EC2Launch] in the *Amazon EC2 User Guide*.

For the ‘EC2Config` service, the password is not generated for rebundled AMIs unless `Ec2SetPassword` is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it’s available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UsingConfig_WinAMI.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2launch.html

The following waiters are defined for this operation (see #wait_until for detailed usage):

* password_data_available

Examples:

Request syntax with placeholder values


resp = client.get_password_data({
  instance_id: "InstanceId", # required
  dry_run: false,
})

Response structure


resp.instance_id #=> String
resp.timestamp #=> Time
resp.password_data #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the Windows instance.

  • :dry_run (Boolean) —

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

Returns:

See Also:



44355
44356
44357
44358
 
# File 'lib/aws-sdk-ec2/client.rb', line 44355

def get_password_data(params = {}, options = {})
  req = build_request(:get_password_data, params)
  req.send_request(options)
end

#get_reserved_instances_exchange_quote(params = {}) ⇒ Types::GetReservedInstancesExchangeQuoteResult

Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.

Examples:

Request syntax with placeholder values


resp = client.get_reserved_instances_exchange_quote({
  dry_run: false,
  reserved_instance_ids: ["ReservationId"], # required
  target_configurations: [
    {
      instance_count: 1,
      offering_id: "ReservedInstancesOfferingId", # required
    },
  ],
})

Response structure


resp.currency_code #=> String
resp.is_valid_exchange #=> Boolean
resp.output_reserved_instances_will_expire_at #=> Time
resp.payment_due #=> String
resp.reserved_instance_value_rollup.hourly_price #=> String
resp.reserved_instance_value_rollup.remaining_total_value #=> String
resp.reserved_instance_value_rollup.remaining_upfront_value #=> String
resp.reserved_instance_value_set #=> Array
resp.reserved_instance_value_set[0].reservation_value.hourly_price #=> String
resp.reserved_instance_value_set[0].reservation_value.remaining_total_value #=> String
resp.reserved_instance_value_set[0].reservation_value.remaining_upfront_value #=> String
resp.reserved_instance_value_set[0].reserved_instance_id #=> String
resp.target_configuration_value_rollup.hourly_price #=> String
resp.target_configuration_value_rollup.remaining_total_value #=> String
resp.target_configuration_value_rollup.remaining_upfront_value #=> String
resp.target_configuration_value_set #=> Array
resp.target_configuration_value_set[0].reservation_value.hourly_price #=> String
resp.target_configuration_value_set[0].reservation_value.remaining_total_value #=> String
resp.target_configuration_value_set[0].reservation_value.remaining_upfront_value #=> String
resp.target_configuration_value_set[0].target_configuration.instance_count #=> Integer
resp.target_configuration_value_set[0].target_configuration.offering_id #=> String
resp.validation_failure_reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :reserved_instance_ids (required, Array<String>) —

    The IDs of the Convertible Reserved Instances to exchange.

  • :target_configurations (Array<Types::TargetConfigurationRequest>) —

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

Returns:

See Also:



44433
44434
44435
44436
 
# File 'lib/aws-sdk-ec2/client.rb', line 44433

def get_reserved_instances_exchange_quote(params = {}, options = {})
  req = build_request(:get_reserved_instances_exchange_quote, params)
  req.send_request(options)
end

#get_security_groups_for_vpc(params = {}) ⇒ Types::GetSecurityGroupsForVpcResult

Gets security groups that can be associated by the Amazon Web Services account making the request with network interfaces in the specified VPC.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_security_groups_for_vpc({
  vpc_id: "VpcId", # required
  next_token: "String",
  max_results: 1,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
})

Response structure


resp.next_token #=> String
resp.security_group_for_vpcs #=> Array
resp.security_group_for_vpcs[0].description #=> String
resp.security_group_for_vpcs[0].group_name #=> String
resp.security_group_for_vpcs[0].owner_id #=> String
resp.security_group_for_vpcs[0].group_id #=> String
resp.security_group_for_vpcs[0].tags #=> Array
resp.security_group_for_vpcs[0].tags[0].key #=> String
resp.security_group_for_vpcs[0].tags[0].value #=> String
resp.security_group_for_vpcs[0].primary_vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    The VPC ID where the security group can be used.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :filters (Array<Types::Filter>) —

    The filters. If using multiple filters, the results include security groups which match all filters.

    • ‘group-id`: The security group ID.

    • ‘description`: The security group’s description.

    • ‘group-name`: The security group name.

    • ‘owner-id`: The security group owner ID.

    • ‘primary-vpc-id`: The VPC ID in which the security group was created.

  • :dry_run (Boolean) —

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

Returns:

See Also:



44518
44519
44520
44521
 
# File 'lib/aws-sdk-ec2/client.rb', line 44518

def get_security_groups_for_vpc(params = {}, options = {})
  req = build_request(:get_security_groups_for_vpc, params)
  req.send_request(options)
end

#get_serial_console_access_status(params = {}) ⇒ Types::GetSerialConsoleAccessStatusResult

Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see [Manage account access to the EC2 serial console] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access

Examples:

Request syntax with placeholder values


resp = client.get_serial_console_access_status({
  dry_run: false,
})

Response structure


resp.serial_console_access_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



44556
44557
44558
44559
 
# File 'lib/aws-sdk-ec2/client.rb', line 44556

def get_serial_console_access_status(params = {}, options = {})
  req = build_request(:get_serial_console_access_status, params)
  req.send_request(options)
end

#get_snapshot_block_public_access_state(params = {}) ⇒ Types::GetSnapshotBlockPublicAccessStateResult

Gets the current state of *block public access for snapshots* setting for the account and Region.

For more information, see [ Block public access for snapshots] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html

Examples:

Request syntax with placeholder values


resp = client.get_snapshot_block_public_access_state({
  dry_run: false,
})

Response structure


resp.state #=> String, one of "block-all-sharing", "block-new-sharing", "unblocked"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



44595
44596
44597
44598
 
# File 'lib/aws-sdk-ec2/client.rb', line 44595

def get_snapshot_block_public_access_state(params = {}, options = {})
  req = build_request(:get_snapshot_block_public_access_state, params)
  req.send_request(options)
end

#get_spot_placement_scores(params = {}) ⇒ Types::GetSpotPlacementScoresResult

Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.

You can specify your compute requirements either by using ‘InstanceRequirementsWithMetadata` and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using `InstanceTypes`.

For more information, see [Spot placement score] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_spot_placement_scores({
  instance_types: ["String"],
  target_capacity: 1, # required
  target_capacity_unit_type: "vcpu", # accepts vcpu, memory-mib, units
  single_availability_zone: false,
  region_names: ["String"],
  instance_requirements_with_metadata: {
    architecture_types: ["i386"], # accepts i386, x86_64, arm64, x86_64_mac, arm64_mac
    virtualization_types: ["hvm"], # accepts hvm, paravirtual
    instance_requirements: {
      v_cpu_count: { # required
        min: 1, # required
        max: 1,
      },
      memory_mi_b: { # required
        min: 1, # required
        max: 1,
      },
      cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
      memory_gi_b_per_v_cpu: {
        min: 1.0,
        max: 1.0,
      },
      excluded_instance_types: ["ExcludedInstanceType"],
      instance_generations: ["current"], # accepts current, previous
      spot_max_price_percentage_over_lowest_price: 1,
      on_demand_max_price_percentage_over_lowest_price: 1,
      bare_metal: "included", # accepts included, required, excluded
      burstable_performance: "included", # accepts included, required, excluded
      require_hibernate_support: false,
      network_interface_count: {
        min: 1,
        max: 1,
      },
      local_storage: "included", # accepts included, required, excluded
      local_storage_types: ["hdd"], # accepts hdd, ssd
      total_local_storage_gb: {
        min: 1.0,
        max: 1.0,
      },
      baseline_ebs_bandwidth_mbps: {
        min: 1,
        max: 1,
      },
      accelerator_types: ["gpu"], # accepts gpu, fpga, inference
      accelerator_count: {
        min: 1,
        max: 1,
      },
      accelerator_manufacturers: ["amazon-web-services"], # accepts amazon-web-services, amd, nvidia, xilinx, habana
      accelerator_names: ["a100"], # accepts a100, inferentia, k520, k80, m60, radeon-pro-v520, t4, vu9p, v100, a10g, h100, t4g
      accelerator_total_memory_mi_b: {
        min: 1,
        max: 1,
      },
      network_bandwidth_gbps: {
        min: 1.0,
        max: 1.0,
      },
      allowed_instance_types: ["AllowedInstanceType"],
      max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
    },
  },
  dry_run: false,
  max_results: 1,
  next_token: "String",
})

Response structure


resp.spot_placement_scores #=> Array
resp.spot_placement_scores[0].region #=> String
resp.spot_placement_scores[0].availability_zone_id #=> String
resp.spot_placement_scores[0].score #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_types (Array<String>) —

    The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an ‘m3.xlarge` with and without instance storage), the returned placement score will always be low.

    If you specify ‘InstanceTypes`, you can’t specify ‘InstanceRequirementsWithMetadata`.

  • :target_capacity (required, Integer) —

    The target capacity.

  • :target_capacity_unit_type (String) —

    The unit for the target capacity.

  • :single_availability_zone (Boolean) —

    Specify ‘true` so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.

    A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.

  • :region_names (Array<String>) —

    The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, ‘us-east-1`.

  • :instance_requirements_with_metadata (Types::InstanceRequirementsWithMetadataRequest) —

    The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

    If you specify ‘InstanceRequirementsWithMetadata`, you can’t specify ‘InstanceTypes`.

  • :dry_run (Boolean) —

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

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



44759
44760
44761
44762
 
# File 'lib/aws-sdk-ec2/client.rb', line 44759

def get_spot_placement_scores(params = {}, options = {})
  req = build_request(:get_spot_placement_scores, params)
  req.send_request(options)
end

#get_subnet_cidr_reservations(params = {}) ⇒ Types::GetSubnetCidrReservationsResult

Gets information about the subnet CIDR reservations.

Examples:

Request syntax with placeholder values


resp = client.get_subnet_cidr_reservations({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  subnet_id: "SubnetId", # required
  dry_run: false,
  next_token: "String",
  max_results: 1,
})

Response structure


resp.subnet_ipv_4_cidr_reservations #=> Array
resp.subnet_ipv_4_cidr_reservations[0].subnet_cidr_reservation_id #=> String
resp.subnet_ipv_4_cidr_reservations[0].subnet_id #=> String
resp.subnet_ipv_4_cidr_reservations[0].cidr #=> String
resp.subnet_ipv_4_cidr_reservations[0].reservation_type #=> String, one of "prefix", "explicit"
resp.subnet_ipv_4_cidr_reservations[0].owner_id #=> String
resp.subnet_ipv_4_cidr_reservations[0].description #=> String
resp.subnet_ipv_4_cidr_reservations[0].tags #=> Array
resp.subnet_ipv_4_cidr_reservations[0].tags[0].key #=> String
resp.subnet_ipv_4_cidr_reservations[0].tags[0].value #=> String
resp.subnet_ipv_6_cidr_reservations #=> Array
resp.subnet_ipv_6_cidr_reservations[0].subnet_cidr_reservation_id #=> String
resp.subnet_ipv_6_cidr_reservations[0].subnet_id #=> String
resp.subnet_ipv_6_cidr_reservations[0].cidr #=> String
resp.subnet_ipv_6_cidr_reservations[0].reservation_type #=> String, one of "prefix", "explicit"
resp.subnet_ipv_6_cidr_reservations[0].owner_id #=> String
resp.subnet_ipv_6_cidr_reservations[0].description #=> String
resp.subnet_ipv_6_cidr_reservations[0].tags #=> Array
resp.subnet_ipv_6_cidr_reservations[0].tags[0].key #=> String
resp.subnet_ipv_6_cidr_reservations[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘reservationType` - The type of reservation (`prefix` | `explicit`).

    • ‘subnet-id` - The ID of the subnet.

    • ‘tag`:&lt;key&gt; - 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.

  • :subnet_id (required, String) —

    The ID of the subnet.

  • :dry_run (Boolean) —

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

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (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.

Returns:

See Also:



44850
44851
44852
44853
 
# File 'lib/aws-sdk-ec2/client.rb', line 44850

def get_subnet_cidr_reservations(params = {}, options = {})
  req = build_request(:get_subnet_cidr_reservations, params)
  req.send_request(options)
end

#get_transit_gateway_attachment_propagations(params = {}) ⇒ Types::GetTransitGatewayAttachmentPropagationsResult

Lists the route tables to which the specified resource attachment propagates routes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_attachment_propagations({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_attachment_propagations #=> Array
resp.transit_gateway_attachment_propagations[0].transit_gateway_route_table_id #=> String
resp.transit_gateway_attachment_propagations[0].state #=> String, one of "enabling", "enabled", "disabling", "disabled"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the attachment.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘transit-gateway-route-table-id` - The ID of the transit gateway route table.

    ^

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



44916
44917
44918
44919
 
# File 'lib/aws-sdk-ec2/client.rb', line 44916

def get_transit_gateway_attachment_propagations(params = {}, options = {})
  req = build_request(:get_transit_gateway_attachment_propagations, params)
  req.send_request(options)
end

#get_transit_gateway_multicast_domain_associations(params = {}) ⇒ Types::GetTransitGatewayMulticastDomainAssociationsResult

Gets information about the associations for the transit gateway multicast domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_multicast_domain_associations({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.multicast_domain_associations #=> Array
resp.multicast_domain_associations[0].transit_gateway_attachment_id #=> String
resp.multicast_domain_associations[0].resource_id #=> String
resp.multicast_domain_associations[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.multicast_domain_associations[0].resource_owner_id #=> String
resp.multicast_domain_associations[0].subnet.subnet_id #=> String
resp.multicast_domain_associations[0].subnet.state #=> String, one of "pendingAcceptance", "associating", "associated", "disassociating", "disassociated", "rejected", "failed"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (required, String) —

    The ID of the transit gateway multicast domain.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘resource-id` - The ID of the resource.

    • ‘resource-type` - The type of resource. The valid value is: `vpc`.

    • ‘state` - The state of the subnet association. Valid values are `associated` | `associating` | `disassociated` | `disassociating`.

    • ‘subnet-id` - The ID of the subnet.

    • ‘transit-gateway-attachment-id` - The id of the transit gateway attachment.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



44994
44995
44996
44997
 
# File 'lib/aws-sdk-ec2/client.rb', line 44994

def get_transit_gateway_multicast_domain_associations(params = {}, options = {})
  req = build_request(:get_transit_gateway_multicast_domain_associations, params)
  req.send_request(options)
end

#get_transit_gateway_policy_table_associations(params = {}) ⇒ Types::GetTransitGatewayPolicyTableAssociationsResult

Gets a list of the transit gateway policy table associations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_policy_table_associations({
  transit_gateway_policy_table_id: "TransitGatewayPolicyTableId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.associations #=> Array
resp.associations[0].transit_gateway_policy_table_id #=> String
resp.associations[0].transit_gateway_attachment_id #=> String
resp.associations[0].resource_id #=> String
resp.associations[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.associations[0].state #=> String, one of "associating", "associated", "disassociating", "disassociated"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_policy_table_id (required, String) —

    The ID of the transit gateway policy table.

  • :filters (Array<Types::Filter>) —

    The filters associated with the transit gateway policy table.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45057
45058
45059
45060
 
# File 'lib/aws-sdk-ec2/client.rb', line 45057

def get_transit_gateway_policy_table_associations(params = {}, options = {})
  req = build_request(:get_transit_gateway_policy_table_associations, params)
  req.send_request(options)
end

#get_transit_gateway_policy_table_entries(params = {}) ⇒ Types::GetTransitGatewayPolicyTableEntriesResult

Returns a list of transit gateway policy table entries.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_policy_table_entries({
  transit_gateway_policy_table_id: "TransitGatewayPolicyTableId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_policy_table_entries #=> Array
resp.transit_gateway_policy_table_entries[0].policy_rule_number #=> String
resp.transit_gateway_policy_table_entries[0].policy_rule.source_cidr_block #=> String
resp.transit_gateway_policy_table_entries[0].policy_rule.source_port_range #=> String
resp.transit_gateway_policy_table_entries[0].policy_rule.destination_cidr_block #=> String
resp.transit_gateway_policy_table_entries[0].policy_rule.destination_port_range #=> String
resp.transit_gateway_policy_table_entries[0].policy_rule.protocol #=> String
resp.transit_gateway_policy_table_entries[0].policy_rule.meta_data.meta_data_key #=> String
resp.transit_gateway_policy_table_entries[0].policy_rule.meta_data.meta_data_value #=> String
resp.transit_gateway_policy_table_entries[0].target_route_table_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_policy_table_id (required, String) —

    The ID of the transit gateway policy table.

  • :filters (Array<Types::Filter>) —

    The filters associated with the transit gateway policy table.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45120
45121
45122
45123
 
# File 'lib/aws-sdk-ec2/client.rb', line 45120

def get_transit_gateway_policy_table_entries(params = {}, options = {})
  req = build_request(:get_transit_gateway_policy_table_entries, params)
  req.send_request(options)
end

#get_transit_gateway_prefix_list_references(params = {}) ⇒ Types::GetTransitGatewayPrefixListReferencesResult

Gets information about the prefix list references in a specified transit gateway route table.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_prefix_list_references({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_prefix_list_references #=> Array
resp.transit_gateway_prefix_list_references[0].transit_gateway_route_table_id #=> String
resp.transit_gateway_prefix_list_references[0].prefix_list_id #=> String
resp.transit_gateway_prefix_list_references[0].prefix_list_owner_id #=> String
resp.transit_gateway_prefix_list_references[0].state #=> String, one of "pending", "available", "modifying", "deleting"
resp.transit_gateway_prefix_list_references[0].blackhole #=> Boolean
resp.transit_gateway_prefix_list_references[0].transit_gateway_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_prefix_list_references[0].transit_gateway_attachment.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.transit_gateway_prefix_list_references[0].transit_gateway_attachment.resource_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘attachment.resource-id` - The ID of the resource for the attachment.

    • ‘attachment.resource-type` - The type of resource for the attachment. Valid values are `vpc` | `vpn` | `direct-connect-gateway` | `peering`.

    • ‘attachment.transit-gateway-attachment-id` - The ID of the attachment.

    • ‘is-blackhole` - Whether traffic matching the route is blocked (`true` | `false`).

    • ‘prefix-list-id` - The ID of the prefix list.

    • ‘prefix-list-owner-id` - The ID of the owner of the prefix list.

    • ‘state` - The state of the prefix list reference (`pending` | `available` | `modifying` | `deleting`).

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45207
45208
45209
45210
 
# File 'lib/aws-sdk-ec2/client.rb', line 45207

def get_transit_gateway_prefix_list_references(params = {}, options = {})
  req = build_request(:get_transit_gateway_prefix_list_references, params)
  req.send_request(options)
end

#get_transit_gateway_route_table_associations(params = {}) ⇒ Types::GetTransitGatewayRouteTableAssociationsResult

Gets information about the associations for the specified transit gateway route table.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_route_table_associations({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.associations #=> Array
resp.associations[0].transit_gateway_attachment_id #=> String
resp.associations[0].resource_id #=> String
resp.associations[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.associations[0].state #=> String, one of "associating", "associated", "disassociating", "disassociated"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘resource-id` - The ID of the resource.

    • ‘resource-type` - The resource type. Valid values are `vpc` | `vpn` | `direct-connect-gateway` | `peering` | `connect`.

    • ‘transit-gateway-attachment-id` - The ID of the attachment.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45277
45278
45279
45280
 
# File 'lib/aws-sdk-ec2/client.rb', line 45277

def get_transit_gateway_route_table_associations(params = {}, options = {})
  req = build_request(:get_transit_gateway_route_table_associations, params)
  req.send_request(options)
end

#get_transit_gateway_route_table_propagations(params = {}) ⇒ Types::GetTransitGatewayRouteTablePropagationsResult

Gets information about the route table propagations for the specified transit gateway route table.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_route_table_propagations({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.transit_gateway_route_table_propagations #=> Array
resp.transit_gateway_route_table_propagations[0].transit_gateway_attachment_id #=> String
resp.transit_gateway_route_table_propagations[0].resource_id #=> String
resp.transit_gateway_route_table_propagations[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.transit_gateway_route_table_propagations[0].state #=> String, one of "enabling", "enabled", "disabling", "disabled"
resp.transit_gateway_route_table_propagations[0].transit_gateway_route_table_announcement_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘resource-id` - The ID of the resource.

    • ‘resource-type` - The resource type. Valid values are `vpc` | `vpn` | `direct-connect-gateway` | `peering` | `connect`.

    • ‘transit-gateway-attachment-id` - The ID of the attachment.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45348
45349
45350
45351
 
# File 'lib/aws-sdk-ec2/client.rb', line 45348

def get_transit_gateway_route_table_propagations(params = {}, options = {})
  req = build_request(:get_transit_gateway_route_table_propagations, params)
  req.send_request(options)
end

#get_verified_access_endpoint_policy(params = {}) ⇒ Types::GetVerifiedAccessEndpointPolicyResult

Get the Verified Access policy associated with the endpoint.

Examples:

Request syntax with placeholder values


resp = client.get_verified_access_endpoint_policy({
  verified_access_endpoint_id: "VerifiedAccessEndpointId", # required
  dry_run: false,
})

Response structure


resp.policy_enabled #=> Boolean
resp.policy_document #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_endpoint_id (required, String) —

    The ID of the Verified Access endpoint.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45385
45386
45387
45388
 
# File 'lib/aws-sdk-ec2/client.rb', line 45385

def get_verified_access_endpoint_policy(params = {}, options = {})
  req = build_request(:get_verified_access_endpoint_policy, params)
  req.send_request(options)
end

#get_verified_access_group_policy(params = {}) ⇒ Types::GetVerifiedAccessGroupPolicyResult

Shows the contents of the Verified Access policy associated with the group.

Examples:

Request syntax with placeholder values


resp = client.get_verified_access_group_policy({
  verified_access_group_id: "VerifiedAccessGroupId", # required
  dry_run: false,
})

Response structure


resp.policy_enabled #=> Boolean
resp.policy_document #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_group_id (required, String) —

    The ID of the Verified Access group.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45423
45424
45425
45426
 
# File 'lib/aws-sdk-ec2/client.rb', line 45423

def get_verified_access_group_policy(params = {}, options = {})
  req = build_request(:get_verified_access_group_policy, params)
  req.send_request(options)
end

#get_vpn_connection_device_sample_configuration(params = {}) ⇒ Types::GetVpnConnectionDeviceSampleConfigurationResult

Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.

Examples:

Request syntax with placeholder values


resp = client.get_vpn_connection_device_sample_configuration({
  vpn_connection_id: "VpnConnectionId", # required
  vpn_connection_device_type_id: "VpnConnectionDeviceTypeId", # required
  internet_key_exchange_version: "String",
  dry_run: false,
})

Response structure


resp.vpn_connection_device_sample_configuration #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpn_connection_id (required, String) —

    The ‘VpnConnectionId` specifies the Site-to-Site VPN connection used for the sample configuration.

  • :vpn_connection_device_type_id (required, String) —

    Device identifier provided by the ‘GetVpnConnectionDeviceTypes` API.

  • :internet_key_exchange_version (String) —

    The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ‘ikev1` or `ikev2`.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45471
45472
45473
45474
 
# File 'lib/aws-sdk-ec2/client.rb', line 45471

def get_vpn_connection_device_sample_configuration(params = {}, options = {})
  req = build_request(:get_vpn_connection_device_sample_configuration, params)
  req.send_request(options)
end

#get_vpn_connection_device_types(params = {}) ⇒ Types::GetVpnConnectionDeviceTypesResult

Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under [Your customer gateway device] in the *Amazon Web Services Site-to-Site VPN User Guide*.

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_vpn_connection_device_types({
  max_results: 1,
  next_token: "NextToken",
  dry_run: false,
})

Response structure


resp.vpn_connection_device_types #=> Array
resp.vpn_connection_device_types[0].vpn_connection_device_type_id #=> String
resp.vpn_connection_device_types[0].vendor #=> String
resp.vpn_connection_device_types[0].platform #=> String
resp.vpn_connection_device_types[0].software #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results returned by ‘GetVpnConnectionDeviceTypes` in paginated output. When this parameter is used, `GetVpnConnectionDeviceTypes` only returns `MaxResults` results in a single page along with a `NextToken` response element. The remaining results of the initial request can be seen by sending another `GetVpnConnectionDeviceTypes` request with the returned `NextToken` value. This value can be between 200 and 1000. If this parameter is not used, then `GetVpnConnectionDeviceTypes` returns all results.

  • :next_token (String) —

    The ‘NextToken` value returned from a previous paginated `GetVpnConnectionDeviceTypes` request where `MaxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `NextToken` value. This value is null when there are no more results to return.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45538
45539
45540
45541
 
# File 'lib/aws-sdk-ec2/client.rb', line 45538

def get_vpn_connection_device_types(params = {}, options = {})
  req = build_request(:get_vpn_connection_device_types, params)
  req.send_request(options)
end

#get_vpn_tunnel_replacement_status(params = {}) ⇒ Types::GetVpnTunnelReplacementStatusResult

Get details of available tunnel endpoint maintenance.

Examples:

Request syntax with placeholder values


resp = client.get_vpn_tunnel_replacement_status({
  vpn_connection_id: "VpnConnectionId", # required
  vpn_tunnel_outside_ip_address: "String", # required
  dry_run: false,
})

Response structure


resp.vpn_connection_id #=> String
resp.transit_gateway_id #=> String
resp.customer_gateway_id #=> String
resp.vpn_gateway_id #=> String
resp.vpn_tunnel_outside_ip_address #=> String
resp.maintenance_details.pending_maintenance #=> String
resp.maintenance_details.maintenance_auto_applied_after #=> Time
resp.maintenance_details.last_maintenance_applied #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpn_connection_id (required, String) —

    The ID of the Site-to-Site VPN connection.

  • :vpn_tunnel_outside_ip_address (required, String) —

    The external IP address of the VPN tunnel.

  • :dry_run (Boolean) —

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

Returns:

See Also:



45589
45590
45591
45592
 
# File 'lib/aws-sdk-ec2/client.rb', line 45589

def get_vpn_tunnel_replacement_status(params = {}, options = {})
  req = build_request(:get_vpn_tunnel_replacement_status, params)
  req.send_request(options)
end

#import_client_vpn_client_certificate_revocation_list(params = {}) ⇒ Types::ImportClientVpnClientCertificateRevocationListResult

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.

Uploading a client certificate revocation list resets existing client connections.

Examples:

Request syntax with placeholder values


resp = client.import_client_vpn_client_certificate_revocation_list({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  certificate_revocation_list: "String", # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint to which the client certificate revocation list applies.

  • :certificate_revocation_list (required, String) —

    The client certificate revocation list file. For more information, see

    Generate a Client Certificate Revocation List][1

    in the *Client VPN

    Administrator Guide*.

    [1]: docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html#cvpn-working-certificates-generate

  • :dry_run (Boolean) —

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

Returns:

See Also:



45640
45641
45642
45643
 
# File 'lib/aws-sdk-ec2/client.rb', line 45640

def import_client_vpn_client_certificate_revocation_list(params = {}, options = {})
  req = build_request(:import_client_vpn_client_certificate_revocation_list, params)
  req.send_request(options)
end

#import_image(params = {}) ⇒ Types::ImportImageResult

<note markdown=“1”> To import your virtual machines (VMs) with a console-based experience, you can use the *Import virtual machine images to Amazon Web Services* template in the [Migration Hub Orchestrator console]. For more information, see the [ *Migration Hub Orchestrator User Guide* ][2].

</note>

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

Amazon Web Services VM Import/Export strongly recommends specifying a value for either the ‘–license-type` or `–usage-operation` parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.

For more information, see [Importing a VM as an image using VM Import/Export] in the *VM Import/Export User Guide*.

[1]: console.aws.amazon.com/migrationhub/orchestrator [2]: docs.aws.amazon.com/migrationhub-orchestrator/latest/userguide/import-vm-images.html [3]: docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html

Examples:

Request syntax with placeholder values


resp = client.import_image({
  architecture: "String",
  client_data: {
    comment: "String",
    upload_end: Time.now,
    upload_size: 1.0,
    upload_start: Time.now,
  },
  client_token: "String",
  description: "String",
  disk_containers: [
    {
      description: "String",
      device_name: "String",
      format: "String",
      snapshot_id: "SnapshotId",
      url: "SensitiveUrl",
      user_bucket: {
        s3_bucket: "String",
        s3_key: "String",
      },
    },
  ],
  dry_run: false,
  encrypted: false,
  hypervisor: "String",
  kms_key_id: "KmsKeyId",
  license_type: "String",
  platform: "String",
  role_name: "String",
  license_specifications: [
    {
      license_configuration_arn: "String",
    },
  ],
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  usage_operation: "String",
  boot_mode: "legacy-bios", # accepts legacy-bios, uefi, uefi-preferred
})

Response structure


resp.architecture #=> String
resp.description #=> String
resp.encrypted #=> Boolean
resp.hypervisor #=> String
resp.image_id #=> String
resp.import_task_id #=> String
resp.kms_key_id #=> String
resp.license_type #=> String
resp.platform #=> String
resp.progress #=> String
resp.snapshot_details #=> Array
resp.snapshot_details[0].description #=> String
resp.snapshot_details[0].device_name #=> String
resp.snapshot_details[0].disk_image_size #=> Float
resp.snapshot_details[0].format #=> String
resp.snapshot_details[0].progress #=> String
resp.snapshot_details[0].snapshot_id #=> String
resp.snapshot_details[0].status #=> String
resp.snapshot_details[0].status_message #=> String
resp.snapshot_details[0].url #=> String
resp.snapshot_details[0].user_bucket.s3_bucket #=> String
resp.snapshot_details[0].user_bucket.s3_key #=> String
resp.status #=> String
resp.status_message #=> String
resp.license_specifications #=> Array
resp.license_specifications[0].license_configuration_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.usage_operation #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :architecture (String) —

    The architecture of the virtual machine.

    Valid values: ‘i386` | `x86_64`

  • :client_data (Types::ClientData) —

    The client-specific data.

  • :client_token (String) —

    The token to enable idempotency for VM import requests.

  • :description (String) —

    A description string for the import image task.

  • :disk_containers (Array<Types::ImageDiskContainer>) —

    Information about the disk containers.

  • :dry_run (Boolean) —

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

  • :encrypted (Boolean) —

    Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using ‘KmsKeyId`. For more information, see

    Amazon EBS Encryption][1

    in the *Amazon Elastic Compute Cloud User

    Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html

  • :hypervisor (String) —

    The target hypervisor platform.

    Valid values: ‘xen`

  • :kms_key_id (String) —

    An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a ‘KmsKeyId` is specified, the `Encrypted` flag must also be set.

    The KMS key identifier may be provided in any of the following formats:

    • Key ID

    • Key alias

    • ARN using key ID. The ID ARN contains the ‘arn:aws:kms` namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the `key` namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

    • ARN using key alias. The alias ARN contains the ‘arn:aws:kms` namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the `alias` namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

    Amazon Web Services parses ‘KmsKeyId` asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

    The specified KMS key must exist in the Region that the AMI is being copied to.

    Amazon EBS does not support asymmetric KMS keys.

  • :license_type (String) —

    The license type to be used for the Amazon Machine Image (AMI) after importing.

    Specify ‘AWS` to replace the source-system license with an Amazon Web Services license or `BYOL` to retain the source-system license. Leaving this parameter undefined is the same as choosing `AWS` when importing a Windows Server operating system, and the same as choosing `BYOL` when importing a Windows client operating system (such as Windows 10) or a Linux operating system.

    To use ‘BYOL`, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see [Prerequisites] in the VM Import/Export User Guide.

    [1]: docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image

  • :platform (String) —

    The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.

    Valid values: ‘Windows` | `Linux`

  • :role_name (String) —

    The name of the role to use when not using the default role, ‘vmimport’.

  • :license_specifications (Array<Types::ImportImageLicenseConfigurationRequest>) —

    The ARNs of the license configurations.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the import image task during creation.

  • :usage_operation (String) —

    The usage operation value. For more information, see [Licensing options] in the *VM Import/Export User Guide*.

    [1]: docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#prerequisites

  • :boot_mode (String) —

    The boot mode of the virtual machine.

    <note markdown=“1”> The ‘uefi-preferred` boot mode isn’t supported for importing images. For more information, see [Boot modes] in the *VM Import/Export User Guide*.

    </note>

    [1]: docs.aws.amazon.com/vm-import/latest/userguide/prerequisites.html#vmimport-boot-modes

Returns:

See Also:



45909
45910
45911
45912
 
# File 'lib/aws-sdk-ec2/client.rb', line 45909

def import_image(params = {}, options = {})
  req = build_request(:import_image, params)
  req.send_request(options)
end

#import_instance(params = {}) ⇒ Types::ImportInstanceResult

<note markdown=“1”> We recommend that you use the [ ‘ImportImage` ][1] API instead. For more information, see [Importing a VM as an image using VM Import/Export] in the *VM Import/Export User Guide*.

</note>

Creates an import instance task using metadata from the specified disk image.

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.

For information about the import manifest referenced by this API action, see [VM Import Manifest].

This API action is not supported by the Command Line Interface (CLI).

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html [2]: docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html [3]: docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html

Examples:

Request syntax with placeholder values


resp = client.import_instance({
  dry_run: false,
  description: "String",
  launch_specification: {
    architecture: "i386", # accepts i386, x86_64, arm64, x86_64_mac, arm64_mac
    group_names: ["SecurityGroupName"],
    group_ids: ["SecurityGroupId"],
    additional_info: "String",
    user_data: {
      data: "String",
    },
    instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
    placement: {
      affinity: "String",
      group_name: "PlacementGroupName",
      partition_number: 1,
      host_id: "String",
      tenancy: "default", # accepts default, dedicated, host
      spread_domain: "String",
      host_resource_group_arn: "String",
      group_id: "PlacementGroupId",
      availability_zone: "String",
    },
    monitoring: false,
    subnet_id: "SubnetId",
    instance_initiated_shutdown_behavior: "stop", # accepts stop, terminate
    private_ip_address: "String",
  },
  disk_images: [
    {
      description: "String",
      image: {
        format: "VMDK", # required, accepts VMDK, RAW, VHD
        bytes: 1, # required
        import_manifest_url: "ImportManifestUrl", # required
      },
      volume: {
        size: 1, # required
      },
    },
  ],
  platform: "Windows", # required, accepts Windows
})

Response structure


resp.conversion_task.conversion_task_id #=> String
resp.conversion_task.expiration_time #=> String
resp.conversion_task.import_instance.description #=> String
resp.conversion_task.import_instance.instance_id #=> String
resp.conversion_task.import_instance.platform #=> String, one of "Windows"
resp.conversion_task.import_instance.volumes #=> Array
resp.conversion_task.import_instance.volumes[0].availability_zone #=> String
resp.conversion_task.import_instance.volumes[0].bytes_converted #=> Integer
resp.conversion_task.import_instance.volumes[0].description #=> String
resp.conversion_task.import_instance.volumes[0].image.checksum #=> String
resp.conversion_task.import_instance.volumes[0].image.format #=> String, one of "VMDK", "RAW", "VHD"
resp.conversion_task.import_instance.volumes[0].image.import_manifest_url #=> String
resp.conversion_task.import_instance.volumes[0].image.size #=> Integer
resp.conversion_task.import_instance.volumes[0].status #=> String
resp.conversion_task.import_instance.volumes[0].status_message #=> String
resp.conversion_task.import_instance.volumes[0].volume.id #=> String
resp.conversion_task.import_instance.volumes[0].volume.size #=> Integer
resp.conversion_task.import_volume.availability_zone #=> String
resp.conversion_task.import_volume.bytes_converted #=> Integer
resp.conversion_task.import_volume.description #=> String
resp.conversion_task.import_volume.image.checksum #=> String
resp.conversion_task.import_volume.image.format #=> String, one of "VMDK", "RAW", "VHD"
resp.conversion_task.import_volume.image.import_manifest_url #=> String
resp.conversion_task.import_volume.image.size #=> Integer
resp.conversion_task.import_volume.volume.id #=> String
resp.conversion_task.import_volume.volume.size #=> Integer
resp.conversion_task.state #=> String, one of "active", "cancelling", "cancelled", "completed"
resp.conversion_task.status_message #=> String
resp.conversion_task.tags #=> Array
resp.conversion_task.tags[0].key #=> String
resp.conversion_task.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :launch_specification (Types::ImportInstanceLaunchSpecification) —

    The launch specification.

  • :disk_images (Array<Types::DiskImage>) —

    The disk image.

  • :platform (required, String) —

    The instance operating system.

Returns:

See Also:



46043
46044
46045
46046
 
# File 'lib/aws-sdk-ec2/client.rb', line 46043

def import_instance(params = {}, options = {})
  req = build_request(:import_instance, params)
  req.send_request(options)
end

#import_key_pair(params = {}) ⇒ Types::ImportKeyPairResult

Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.

For more information about key pairs, see [Amazon EC2 key pairs] in the *Amazon Elastic Compute Cloud User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html

Examples:

Request syntax with placeholder values


resp = client.import_key_pair({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  key_name: "String", # required
  public_key_material: "data", # required
})

Response structure


resp.key_fingerprint #=> String
resp.key_name #=> String
resp.key_pair_id #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the imported key pair.

  • :dry_run (Boolean) —

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

  • :key_name (required, String) —

    A unique name for the key pair.

  • :public_key_material (required, String, StringIO, File) —

    The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

Returns:

See Also:



46118
46119
46120
46121
 
# File 'lib/aws-sdk-ec2/client.rb', line 46118

def import_key_pair(params = {}, options = {})
  req = build_request(:import_key_pair, params)
  req.send_request(options)
end

#import_snapshot(params = {}) ⇒ Types::ImportSnapshotResult

Imports a disk into an EBS snapshot.

For more information, see [Importing a disk as a snapshot using VM Import/Export] in the *VM Import/Export User Guide*.

[1]: docs.aws.amazon.com/vm-import/latest/userguide/vmimport-import-snapshot.html

Examples:

Request syntax with placeholder values


resp = client.import_snapshot({
  client_data: {
    comment: "String",
    upload_end: Time.now,
    upload_size: 1.0,
    upload_start: Time.now,
  },
  client_token: "String",
  description: "String",
  disk_container: {
    description: "String",
    format: "String",
    url: "SensitiveUrl",
    user_bucket: {
      s3_bucket: "String",
      s3_key: "String",
    },
  },
  dry_run: false,
  encrypted: false,
  kms_key_id: "KmsKeyId",
  role_name: "String",
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.description #=> String
resp.import_task_id #=> String
resp.snapshot_task_detail.description #=> String
resp.snapshot_task_detail.disk_image_size #=> Float
resp.snapshot_task_detail.encrypted #=> Boolean
resp.snapshot_task_detail.format #=> String
resp.snapshot_task_detail.kms_key_id #=> String
resp.snapshot_task_detail.progress #=> String
resp.snapshot_task_detail.snapshot_id #=> String
resp.snapshot_task_detail.status #=> String
resp.snapshot_task_detail.status_message #=> String
resp.snapshot_task_detail.url #=> String
resp.snapshot_task_detail.user_bucket.s3_bucket #=> String
resp.snapshot_task_detail.user_bucket.s3_key #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_data (Types::ClientData) —

    The client-specific data.

  • :client_token (String) —

    Token to enable idempotency for VM import requests.

  • :description (String) —

    The description string for the import snapshot task.

  • :disk_container (Types::SnapshotDiskContainer) —

    Information about the disk container.

  • :dry_run (Boolean) —

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

  • :encrypted (Boolean) —

    Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using ‘KmsKeyId`. For more information, see [Amazon EBS Encryption] in the *Amazon Elastic Compute Cloud User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html

  • :kms_key_id (String) —

    An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a ‘KmsKeyId` is specified, the `Encrypted` flag must also be set.

    The KMS key identifier may be provided in any of the following formats:

    • Key ID

    • Key alias

    • ARN using key ID. The ID ARN contains the ‘arn:aws:kms` namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the `key` namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

    • ARN using key alias. The alias ARN contains the ‘arn:aws:kms` namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the `alias` namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

    Amazon Web Services parses ‘KmsKeyId` asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

    The specified KMS key must exist in the Region that the snapshot is being copied to.

    Amazon EBS does not support asymmetric KMS keys.

  • :role_name (String) —

    The name of the role to use when not using the default role, ‘vmimport’.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the import snapshot task during creation.

Returns:

See Also:



46271
46272
46273
46274
 
# File 'lib/aws-sdk-ec2/client.rb', line 46271

def import_snapshot(params = {}, options = {})
  req = build_request(:import_snapshot, params)
  req.send_request(options)
end

#import_volume(params = {}) ⇒ Types::ImportVolumeResult

<note markdown=“1”> This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.

</note>

Creates an import volume task using metadata from the specified disk image.

For information about the import manifest referenced by this API action, see [VM Import Manifest].

This API action is not supported by the Command Line Interface (CLI).

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html

Examples:

Request syntax with placeholder values


resp = client.import_volume({
  dry_run: false,
  availability_zone: "String", # required
  image: { # required
    format: "VMDK", # required, accepts VMDK, RAW, VHD
    bytes: 1, # required
    import_manifest_url: "ImportManifestUrl", # required
  },
  description: "String",
  volume: { # required
    size: 1, # required
  },
})

Response structure


resp.conversion_task.conversion_task_id #=> String
resp.conversion_task.expiration_time #=> String
resp.conversion_task.import_instance.description #=> String
resp.conversion_task.import_instance.instance_id #=> String
resp.conversion_task.import_instance.platform #=> String, one of "Windows"
resp.conversion_task.import_instance.volumes #=> Array
resp.conversion_task.import_instance.volumes[0].availability_zone #=> String
resp.conversion_task.import_instance.volumes[0].bytes_converted #=> Integer
resp.conversion_task.import_instance.volumes[0].description #=> String
resp.conversion_task.import_instance.volumes[0].image.checksum #=> String
resp.conversion_task.import_instance.volumes[0].image.format #=> String, one of "VMDK", "RAW", "VHD"
resp.conversion_task.import_instance.volumes[0].image.import_manifest_url #=> String
resp.conversion_task.import_instance.volumes[0].image.size #=> Integer
resp.conversion_task.import_instance.volumes[0].status #=> String
resp.conversion_task.import_instance.volumes[0].status_message #=> String
resp.conversion_task.import_instance.volumes[0].volume.id #=> String
resp.conversion_task.import_instance.volumes[0].volume.size #=> Integer
resp.conversion_task.import_volume.availability_zone #=> String
resp.conversion_task.import_volume.bytes_converted #=> Integer
resp.conversion_task.import_volume.description #=> String
resp.conversion_task.import_volume.image.checksum #=> String
resp.conversion_task.import_volume.image.format #=> String, one of "VMDK", "RAW", "VHD"
resp.conversion_task.import_volume.image.import_manifest_url #=> String
resp.conversion_task.import_volume.image.size #=> Integer
resp.conversion_task.import_volume.volume.id #=> String
resp.conversion_task.import_volume.volume.size #=> Integer
resp.conversion_task.state #=> String, one of "active", "cancelling", "cancelled", "completed"
resp.conversion_task.status_message #=> String
resp.conversion_task.tags #=> Array
resp.conversion_task.tags[0].key #=> String
resp.conversion_task.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :availability_zone (required, String) —

    The Availability Zone for the resulting EBS volume.

  • :image (required, Types::DiskImageDetail) —

    The disk image.

  • :description (String) —

    A description of the volume.

  • :volume (required, Types::VolumeDetail) —

    The volume size.

Returns:

See Also:



46370
46371
46372
46373
 
# File 'lib/aws-sdk-ec2/client.rb', line 46370

def import_volume(params = {}, options = {})
  req = build_request(:import_volume, params)
  req.send_request(options)
end

#list_images_in_recycle_bin(params = {}) ⇒ Types::ListImagesInRecycleBinResult

Lists one or more AMIs that are currently in the Recycle Bin. For more information, see [Recycle Bin] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_images_in_recycle_bin({
  image_ids: ["ImageId"],
  next_token: "String",
  max_results: 1,
  dry_run: false,
})

Response structure


resp.images #=> Array
resp.images[0].image_id #=> String
resp.images[0].name #=> String
resp.images[0].description #=> String
resp.images[0].recycle_bin_enter_time #=> Time
resp.images[0].recycle_bin_exit_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_ids (Array<String>) —

    The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :dry_run (Boolean) —

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

Returns:

See Also:



46436
46437
46438
46439
 
# File 'lib/aws-sdk-ec2/client.rb', line 46436

def list_images_in_recycle_bin(params = {}, options = {})
  req = build_request(:list_images_in_recycle_bin, params)
  req.send_request(options)
end

#list_snapshots_in_recycle_bin(params = {}) ⇒ Types::ListSnapshotsInRecycleBinResult

Lists one or more snapshots that are currently in the Recycle Bin.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_snapshots_in_recycle_bin({
  max_results: 1,
  next_token: "String",
  snapshot_ids: ["SnapshotId"],
  dry_run: false,
})

Response structure


resp.snapshots #=> Array
resp.snapshots[0].snapshot_id #=> String
resp.snapshots[0].recycle_bin_enter_time #=> Time
resp.snapshots[0].recycle_bin_exit_time #=> Time
resp.snapshots[0].description #=> String
resp.snapshots[0].volume_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :snapshot_ids (Array<String>) —

    The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.

  • :dry_run (Boolean) —

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

Returns:

See Also:



46496
46497
46498
46499
 
# File 'lib/aws-sdk-ec2/client.rb', line 46496

def list_snapshots_in_recycle_bin(params = {}, options = {})
  req = build_request(:list_snapshots_in_recycle_bin, params)
  req.send_request(options)
end

#lock_snapshot(params = {}) ⇒ Types::LockSnapshotResult

Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot can’t be deleted.

You can also use this action to modify the lock settings for a snapshot that is already locked. The allowed modifications depend on the lock mode and lock state:

  • If the snapshot is locked in governance mode, you can modify the lock mode and the lock duration or lock expiration date.

  • If the snapshot is locked in compliance mode and it is in the cooling-off period, you can modify the lock mode and the lock duration or lock expiration date.

  • If the snapshot is locked in compliance mode and the cooling-off period has lapsed, you can only increase the lock duration or extend the lock expiration date.

Examples:

Request syntax with placeholder values


resp = client.lock_snapshot({
  snapshot_id: "SnapshotId", # required
  dry_run: false,
  lock_mode: "compliance", # required, accepts compliance, governance
  cool_off_period: 1,
  lock_duration: 1,
  expiration_date: Time.now,
})

Response structure


resp.snapshot_id #=> String
resp.lock_state #=> String, one of "compliance", "governance", "compliance-cooloff", "expired"
resp.lock_duration #=> Integer
resp.cool_off_period #=> Integer
resp.cool_off_period_expires_on #=> Time
resp.lock_created_on #=> Time
resp.lock_expires_on #=> Time
resp.lock_duration_start_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The ID of the snapshot to lock.

  • :dry_run (Boolean) —

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

  • :lock_mode (required, String) —

    The mode in which to lock the snapshot. Specify one of the following:

    • ‘governance` - Locks the snapshot in governance mode. Snapshots locked in governance mode can’t be deleted until one of the following conditions are met:

      • The lock duration expires.

      • The snapshot is unlocked by a user with the appropriate permissions.

      Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to ‘compliance` at any time.

      If you lock a snapshot in ‘governance` mode, omit CoolOffPeriod.

    • ‘compliance` - Locks the snapshot in compliance mode. Snapshots locked in compliance mode can’t be unlocked by any user. They can be deleted only after the lock duration expires. Users can’t decrease the lock duration or change the lock mode to ‘governance`. However, users with appropriate IAM permissions can increase the lock duration at any time.

      If you lock a snapshot in ‘compliance` mode, you can optionally specify CoolOffPeriod.

  • :cool_off_period (Integer) —

    The cooling-off period during which you can unlock the snapshot or modify the lock settings after locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can’t unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase the lock duration after the cooling-off period expires.

    The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking the snapshot in governance mode, omit this parameter.

    To lock the snapshot in compliance mode immediately without a cooling-off period, omit this parameter.

    If you are extending the lock duration for a snapshot that is locked in compliance mode after the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such a request, the request fails.

    Allowed values: Min 1, max 72.

  • :lock_duration (Integer) —

    The period of time for which to lock the snapshot, in days. The snapshot lock will automatically expire after this period lapses.

    You must specify either this parameter or ExpirationDate, but not both.

    Allowed values: Min: 1, max 36500

  • :expiration_date (Time, DateTime, Date, Integer, String) —

    The date and time at which the snapshot lock is to automatically expire, in the UTC time zone (‘YYYY-MM-DDThh:mm:ss.sssZ`).

    You must specify either this parameter or LockDuration, but not both.

Returns:

See Also:



46633
46634
46635
46636
 
# File 'lib/aws-sdk-ec2/client.rb', line 46633

def lock_snapshot(params = {}, options = {})
  req = build_request(:lock_snapshot, params)
  req.send_request(options)
end

#modify_address_attribute(params = {}) ⇒ Types::ModifyAddressAttributeResult

Modifies an attribute of the specified Elastic IP address. For requirements, see [Using reverse DNS for email applications].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS

Examples:

Request syntax with placeholder values


resp = client.modify_address_attribute({
  allocation_id: "AllocationId", # required
  domain_name: "String",
  dry_run: false,
})

Response structure


resp.address.public_ip #=> String
resp.address.allocation_id #=> String
resp.address.ptr_record #=> String
resp.address.ptr_record_update.value #=> String
resp.address.ptr_record_update.status #=> String
resp.address.ptr_record_update.reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_id (required, String) —

    [EC2-VPC] The allocation ID.

  • :domain_name (String) —

    The domain name to modify for the IP address.

  • :dry_run (Boolean) —

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

Returns:

See Also:



46682
46683
46684
46685
 
# File 'lib/aws-sdk-ec2/client.rb', line 46682

def modify_address_attribute(params = {}, options = {})
  req = build_request(:modify_address_attribute, params)
  req.send_request(options)
end

#modify_availability_zone_group(params = {}) ⇒ Types::ModifyAvailabilityZoneGroupResult

Changes the opt-in status of the specified zone group for your account.

Examples:

Request syntax with placeholder values


resp = client.modify_availability_zone_group({
  group_name: "String", # required
  opt_in_status: "opted-in", # required, accepts opted-in, not-opted-in
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    The name of the Availability Zone group, Local Zone group, or Wavelength Zone group.

  • :opt_in_status (required, String) —

    Indicates whether to opt in to the zone group. The only valid value is ‘opted-in`. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.

  • :dry_run (Boolean) —

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

Returns:

See Also:



46725
46726
46727
46728
 
# File 'lib/aws-sdk-ec2/client.rb', line 46725

def modify_availability_zone_group(params = {}, options = {})
  req = build_request(:modify_availability_zone_group, params)
  req.send_request(options)
end

#modify_capacity_reservation(params = {}) ⇒ Types::ModifyCapacityReservationResult

Modifies a Capacity Reservation’s capacity, instance eligibility, and the conditions under which it is to be released. You can’t modify a Capacity Reservation’s instance type, EBS optimization, platform, instance store settings, Availability Zone, or tenancy. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. For more information, see [Modify an active Capacity Reservation].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify.html

Examples:

Request syntax with placeholder values


resp = client.modify_capacity_reservation({
  capacity_reservation_id: "CapacityReservationId", # required
  instance_count: 1,
  end_date: Time.now,
  end_date_type: "unlimited", # accepts unlimited, limited
  accept: false,
  dry_run: false,
  additional_info: "String",
  instance_match_criteria: "open", # accepts open, targeted
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation.

  • :instance_count (Integer) —

    The number of instances for which to reserve capacity. The number of instances can’t be increased or decreased by more than ‘1000` in a single request.

  • :end_date (Time, DateTime, Date, Integer, String) —

    The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation’s state changes to ‘expired` when it reaches its end date and time.

    The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

    You must provide an ‘EndDate` value if `EndDateType` is `limited`. Omit `EndDate` if `EndDateType` is `unlimited`.

  • :end_date_type (String) —

    Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • ‘unlimited` - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an `EndDate` value if `EndDateType` is `unlimited`.

    • ‘limited` - The Capacity Reservation expires automatically at a specified date and time. You must provide an `EndDate` value if `EndDateType` is `limited`.

  • :accept (Boolean) —

    Reserved. Capacity Reservations you have created are accepted by default.

  • :dry_run (Boolean) —

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

  • :additional_info (String) —

    Reserved for future use.

  • :instance_match_criteria (String) —

    The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from ‘targeted` to `open`, any running instances that match the attributes of the Capacity Reservation, have the `CapacityReservationPreference` set to `open`, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation.

    To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).

Returns:

See Also:



46828
46829
46830
46831
 
# File 'lib/aws-sdk-ec2/client.rb', line 46828

def modify_capacity_reservation(params = {}, options = {})
  req = build_request(:modify_capacity_reservation, params)
  req.send_request(options)
end

#modify_capacity_reservation_fleet(params = {}) ⇒ Types::ModifyCapacityReservationFleetResult

Modifies a Capacity Reservation Fleet.

When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.

Examples:

Request syntax with placeholder values


resp = client.modify_capacity_reservation_fleet({
  capacity_reservation_fleet_id: "CapacityReservationFleetId", # required
  total_target_capacity: 1,
  end_date: Time.now,
  dry_run: false,
  remove_end_date: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_reservation_fleet_id (required, String) —

    The ID of the Capacity Reservation Fleet to modify.

  • :total_target_capacity (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity

  • :end_date (Time, DateTime, Date, Integer, String) —

    The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to ‘expired` and all of the Capacity Reservations in the Fleet expire.

    The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify ‘5/31/2019`, `13:30:55`, the Capacity Reservation Fleet is guaranteed to expire between `13:30:55` and `14:30:55` on `5/31/2019`.

    You can’t specify EndDate and RemoveEndDate in the same request.

  • :dry_run (Boolean) —

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

  • :remove_end_date (Boolean) —

    Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.

    You can’t specify RemoveEndDate and EndDate in the same request.

Returns:

See Also:



46908
46909
46910
46911
 
# File 'lib/aws-sdk-ec2/client.rb', line 46908

def modify_capacity_reservation_fleet(params = {}, options = {})
  req = build_request(:modify_capacity_reservation_fleet, params)
  req.send_request(options)
end

#modify_client_vpn_endpoint(params = {}) ⇒ Types::ModifyClientVpnEndpointResult

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

Examples:

Request syntax with placeholder values


resp = client.modify_client_vpn_endpoint({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  server_certificate_arn: "String",
  connection_log_options: {
    enabled: false,
    cloudwatch_log_group: "String",
    cloudwatch_log_stream: "String",
  },
  dns_servers: {
    custom_dns_servers: ["String"],
    enabled: false,
  },
  vpn_port: 1,
  description: "String",
  split_tunnel: false,
  dry_run: false,
  security_group_ids: ["SecurityGroupId"],
  vpc_id: "VpcId",
  self_service_portal: "enabled", # accepts enabled, disabled
  client_connect_options: {
    enabled: false,
    lambda_function_arn: "String",
  },
  session_timeout_hours: 1,
  client_login_banner_options: {
    enabled: false,
    banner_text: "String",
  },
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint to modify.

  • :server_certificate_arn (String) —

    The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).

  • :connection_log_options (Types::ConnectionLogOptions) —

    Information about the client connection logging options.

    If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

    • Client connection requests

    • Client connection results (successful and unsuccessful)

    • Reasons for unsuccessful client connection requests

    • Client connection termination time

  • :dns_servers (Types::DnsServersOptionsModifyStructure) —

    Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

  • :vpn_port (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.

  • :split_tunnel (Boolean) —

    Indicates whether the VPN is split-tunnel.

    For information about split-tunnel VPN endpoints, see [Split-tunnel Client VPN endpoint] in the *Client VPN Administrator Guide*.

    [1]: docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html

  • :dry_run (Boolean) —

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

  • :security_group_ids (Array<String>) —

    The IDs of one or more security groups to apply to the target network.

  • :vpc_id (String) —

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

  • :self_service_portal (String) —

    Specify whether to enable the self-service portal for the Client VPN endpoint.

  • :client_connect_options (Types::ClientConnectOptions) —

    The options for managing connection authorization for new client connections.

  • :session_timeout_hours (Integer) —

    The maximum VPN session duration time in hours.

    Valid values: ‘8 | 10 | 12 | 24`

    Default value: ‘24`

  • :client_login_banner_options (Types::ClientLoginBannerOptions) —

    Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

Returns:

See Also:



47039
47040
47041
47042
 
# File 'lib/aws-sdk-ec2/client.rb', line 47039

def modify_client_vpn_endpoint(params = {}, options = {})
  req = build_request(:modify_client_vpn_endpoint, params)
  req.send_request(options)
end

#modify_default_credit_specification(params = {}) ⇒ Types::ModifyDefaultCreditSpecificationResult

Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.

‘ModifyDefaultCreditSpecification` is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call `GetDefaultCreditSpecification` and check `DefaultCreditSpecification` for updates.

For more information, see [Burstable performance instances] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html

Examples:

Request syntax with placeholder values


resp = client.modify_default_credit_specification({
  dry_run: false,
  instance_family: "t2", # required, accepts t2, t3, t3a, t4g
  cpu_credits: "String", # required
})

Response structure


resp.instance_family_credit_specification.instance_family #=> String, one of "t2", "t3", "t3a", "t4g"
resp.instance_family_credit_specification.cpu_credits #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_family (required, String) —

    The instance family.

  • :cpu_credits (required, String) —

    The credit option for CPU usage of the instance family.

    Valid Values: ‘standard` | `unlimited`

Returns:

See Also:



47101
47102
47103
47104
 
# File 'lib/aws-sdk-ec2/client.rb', line 47101

def modify_default_credit_specification(params = {}, options = {})
  req = build_request(:modify_default_credit_specification, params)
  req.send_request(options)
end

#modify_ebs_default_kms_key_id(params = {}) ⇒ Types::ModifyEbsDefaultKmsKeyIdResult

Changes the default KMS key for EBS encryption by default for your account in this Region.

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.

For more information, see [Amazon EBS encryption] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html

Examples:

Request syntax with placeholder values


resp = client.modify_ebs_default_kms_key_id({
  kms_key_id: "KmsKeyId", # required
  dry_run: false,
})

Response structure


resp.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :kms_key_id (required, 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.

    Amazon EBS does not support asymmetric KMS keys.

  • :dry_run (Boolean) —

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

Returns:

See Also:



47176
47177
47178
47179
 
# File 'lib/aws-sdk-ec2/client.rb', line 47176

def modify_ebs_default_kms_key_id(params = {}, options = {})
  req = build_request(:modify_ebs_default_kms_key_id, params)
  req.send_request(options)
end

#modify_fleet(params = {}) ⇒ Types::ModifyFleetResult

Modifies the specified EC2 Fleet.

You can only modify an EC2 Fleet request of type ‘maintain`.

While the EC2 Fleet is being modified, it is in the ‘modifying` state.

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is ‘lowest-price`, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is `diversified`, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is `capacity-optimized`, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is ‘lowest-price`, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is `capacity-optimized`, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is `diversified`, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.

Examples:

Request syntax with placeholder values


resp = client.modify_fleet({
  dry_run: false,
  excess_capacity_termination_policy: "no-termination", # accepts no-termination, termination
  launch_template_configs: [
    {
      launch_template_specification: {
        launch_template_id: "LaunchTemplateId",
        launch_template_name: "LaunchTemplateName",
        version: "String",
      },
      overrides: [
        {
          instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
          max_price: "String",
          subnet_id: "SubnetId",
          availability_zone: "String",
          weighted_capacity: 1.0,
          priority: 1.0,
          placement: {
            affinity: "String",
            group_name: "PlacementGroupName",
            partition_number: 1,
            host_id: "String",
            tenancy: "default", # accepts default, dedicated, host
            spread_domain: "String",
            host_resource_group_arn: "String",
            group_id: "PlacementGroupId",
            availability_zone: "String",
          },
          instance_requirements: {
            v_cpu_count: { # required
              min: 1, # required
              max: 1,
            },
            memory_mi_b: { # required
              min: 1, # required
              max: 1,
            },
            cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
            memory_gi_b_per_v_cpu: {
              min: 1.0,
              max: 1.0,
            },
            excluded_instance_types: ["ExcludedInstanceType"],
            instance_generations: ["current"], # accepts current, previous
            spot_max_price_percentage_over_lowest_price: 1,
            on_demand_max_price_percentage_over_lowest_price: 1,
            bare_metal: "included", # accepts included, required, excluded
            burstable_performance: "included", # accepts included, required, excluded
            require_hibernate_support: false,
            network_interface_count: {
              min: 1,
              max: 1,
            },
            local_storage: "included", # accepts included, required, excluded
            local_storage_types: ["hdd"], # accepts hdd, ssd
            total_local_storage_gb: {
              min: 1.0,
              max: 1.0,
            },
            baseline_ebs_bandwidth_mbps: {
              min: 1,
              max: 1,
            },
            accelerator_types: ["gpu"], # accepts gpu, fpga, inference
            accelerator_count: {
              min: 1,
              max: 1,
            },
            accelerator_manufacturers: ["amazon-web-services"], # accepts amazon-web-services, amd, nvidia, xilinx, habana
            accelerator_names: ["a100"], # accepts a100, inferentia, k520, k80, m60, radeon-pro-v520, t4, vu9p, v100, a10g, h100, t4g
            accelerator_total_memory_mi_b: {
              min: 1,
              max: 1,
            },
            network_bandwidth_gbps: {
              min: 1.0,
              max: 1.0,
            },
            allowed_instance_types: ["AllowedInstanceType"],
            max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
          },
          image_id: "ImageId",
        },
      ],
    },
  ],
  fleet_id: "FleetId", # required
  target_capacity_specification: {
    total_target_capacity: 1, # required
    on_demand_target_capacity: 1,
    spot_target_capacity: 1,
    default_target_capacity_type: "spot", # accepts spot, on-demand, capacity-block
    target_capacity_unit_type: "vcpu", # accepts vcpu, memory-mib, units
  },
  context: "String",
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :excess_capacity_termination_policy (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`.

  • :launch_template_configs (Array<Types::FleetLaunchTemplateConfigRequest>) —

    The launch template and overrides.

  • :fleet_id (required, String) —

    The ID of the EC2 Fleet.

  • :target_capacity_specification (Types::TargetCapacitySpecificationRequest) —

    The size of the EC2 Fleet.

  • :context (String) —

    Reserved.

Returns:

See Also:



47352
47353
47354
47355
 
# File 'lib/aws-sdk-ec2/client.rb', line 47352

def modify_fleet(params = {}, options = {})
  req = build_request(:modify_fleet, params)
  req.send_request(options)
end

#modify_fpga_image_attribute(params = {}) ⇒ Types::ModifyFpgaImageAttributeResult

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

Examples:

Request syntax with placeholder values


resp = client.modify_fpga_image_attribute({
  dry_run: false,
  fpga_image_id: "FpgaImageId", # required
  attribute: "description", # accepts description, name, loadPermission, productCodes
  operation_type: "add", # accepts add, remove
  user_ids: ["String"],
  user_groups: ["String"],
  product_codes: ["String"],
  load_permission: {
    add: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
    remove: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
  },
  description: "String",
  name: "String",
})

Response structure


resp.fpga_image_attribute.fpga_image_id #=> String
resp.fpga_image_attribute.name #=> String
resp.fpga_image_attribute.description #=> String
resp.fpga_image_attribute.load_permissions #=> Array
resp.fpga_image_attribute.load_permissions[0].user_id #=> String
resp.fpga_image_attribute.load_permissions[0].group #=> String, one of "all"
resp.fpga_image_attribute.product_codes #=> Array
resp.fpga_image_attribute.product_codes[0].product_code_id #=> String
resp.fpga_image_attribute.product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :fpga_image_id (required, String) —

    The ID of the AFI.

  • :attribute (String) —

    The name of the attribute.

  • :operation_type (String) —

    The operation type.

  • :user_ids (Array<String>) —

    The Amazon Web Services account IDs. This parameter is valid only when modifying the ‘loadPermission` attribute.

  • :user_groups (Array<String>) —

    The user groups. This parameter is valid only when modifying the ‘loadPermission` attribute.

  • :product_codes (Array<String>) —

    The product codes. After you add a product code to an AFI, it can’t be removed. This parameter is valid only when modifying the ‘productCodes` attribute.

  • :load_permission (Types::LoadPermissionModifications) —

    The load permission for the AFI.

  • :description (String) —

    A description for the AFI.

  • :name (String) —

    A name for the AFI.

Returns:

See Also:



47445
47446
47447
47448
 
# File 'lib/aws-sdk-ec2/client.rb', line 47445

def modify_fpga_image_attribute(params = {}, options = {})
  req = build_request(:modify_fpga_image_attribute, params)
  req.send_request(options)
end

#modify_hosts(params = {}) ⇒ Types::ModifyHostsResult

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of ‘host` but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.

You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.

Examples:

Request syntax with placeholder values


resp = client.modify_hosts({
  host_recovery: "on", # accepts on, off
  instance_type: "String",
  instance_family: "String",
  host_maintenance: "on", # accepts on, off
  host_ids: ["DedicatedHostId"], # required
  auto_placement: "on", # accepts on, off
})

Response structure


resp.successful #=> Array
resp.successful[0] #=> String
resp.unsuccessful #=> Array
resp.unsuccessful[0].error.code #=> String
resp.unsuccessful[0].error.message #=> String
resp.unsuccessful[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :host_recovery (String) —

    Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see [Host recovery] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html

  • :instance_type (String) —

    Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.

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

  • :instance_family (String) —

    Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.

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

  • :host_maintenance (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html

  • :host_ids (required, Array<String>) —

    The IDs of the Dedicated Hosts to modify.

  • :auto_placement (String) —

    Specify whether to enable or disable auto-placement.

Returns:

See Also:



47536
47537
47538
47539
 
# File 'lib/aws-sdk-ec2/client.rb', line 47536

def modify_hosts(params = {}, options = {})
  req = build_request(:modify_hosts, params)
  req.send_request(options)
end

#modify_id_format(params = {}) ⇒ Struct

Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: ‘bundle` | `conversion-task` | `customer-gateway` | `dhcp-options` | `elastic-ip-allocation` | `elastic-ip-association` | `export-task` | `flow-log` | `image` | `import-task` | `internet-gateway` | `network-acl` | `network-acl-association` | `network-interface` | `network-interface-attachment` | `prefix-list` | `route-table` | `route-table-association` | `security-group` | `subnet` | `subnet-cidr-block-association` | `vpc` | `vpc-cidr-block-association` | `vpc-endpoint` | `vpc-peering-connection` | `vpn-connection` | `vpn-gateway`.

This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you’re using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see [Resource IDs] in the *Amazon Elastic Compute Cloud User Guide*.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant ‘Describe` command for the resource type.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html

Examples:

Request syntax with placeholder values


resp = client.modify_id_format({
  resource: "String", # required
  use_long_ids: false, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource (required, 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` | `internet-gateway` | `network-acl` | `network-acl-association` | `network-interface` | `network-interface-attachment` | `prefix-list` | `route-table` | `route-table-association` | `security-group` | `subnet` | `subnet-cidr-block-association` | `vpc` | `vpc-cidr-block-association` | `vpc-endpoint` | `vpc-peering-connection` | `vpn-connection` | `vpn-gateway`.

    Alternatively, use the ‘all-current` option to include all resource types that are currently within their opt-in period for longer IDs.

  • :use_long_ids (required, Boolean) —

    Indicate whether the resource should use longer IDs (17-character IDs).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



47607
47608
47609
47610
 
# File 'lib/aws-sdk-ec2/client.rb', line 47607

def modify_id_format(params = {}, options = {})
  req = build_request(:modify_id_format, params)
  req.send_request(options)
end

#modify_identity_id_format(params = {}) ⇒ Struct

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: ‘bundle` | `conversion-task` | `customer-gateway` | `dhcp-options` | `elastic-ip-allocation` | `elastic-ip-association` | `export-task` | `flow-log` | `image` | `import-task` | `internet-gateway` | `network-acl` | `network-acl-association` | `network-interface` | `network-interface-attachment` | `prefix-list` | `route-table` | `route-table-association` | `security-group` | `subnet` | `subnet-cidr-block-association` | `vpc` | `vpc-cidr-block-association` | `vpc-endpoint` | `vpc-peering-connection` | `vpn-connection` | `vpn-gateway`.

For more information, see [Resource IDs] in the *Amazon Elastic Compute Cloud User Guide*.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant ‘Describe` command for the resource type.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html

Examples:

Request syntax with placeholder values


resp = client.modify_identity_id_format({
  resource: "String", # required
  use_long_ids: false, # required
  principal_arn: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource (required, 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` | `internet-gateway` | `network-acl` | `network-acl-association` | `network-interface` | `network-interface-attachment` | `prefix-list` | `route-table` | `route-table-association` | `security-group` | `subnet` | `subnet-cidr-block-association` | `vpc` | `vpc-cidr-block-association` | `vpc-endpoint` | `vpc-peering-connection` | `vpn-connection` | `vpn-gateway`.

    Alternatively, use the ‘all-current` option to include all resource types that are currently within their opt-in period for longer IDs.

  • :use_long_ids (required, Boolean) —

    Indicates whether the resource should use longer IDs (17-character IDs)

  • :principal_arn (required, String) —

    The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify ‘all` to modify the ID format for all IAM users, IAM roles, and the root user of the account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



47683
47684
47685
47686
 
# File 'lib/aws-sdk-ec2/client.rb', line 47683

def modify_identity_id_format(params = {}, options = {})
  req = build_request(:modify_identity_id_format, params)
  req.send_request(options)
end

#modify_image_attribute(params = {}) ⇒ Struct

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

To specify the attribute, you can use the ‘Attribute` parameter, or one of the following parameters: `Description`, `ImdsSupport`, or `LaunchPermission`.

Images with an Amazon Web Services Marketplace product code cannot be made public.

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.

Examples:

Example: To make an AMI public


# This example makes the specified AMI public.

resp = client.modify_image_attribute({
  image_id: "ami-5731123e", 
  launch_permission: {
    add: [
      {
        group: "all", 
      }, 
    ], 
  }, 
})

resp.to_h outputs the following:
{
}

Example: To grant launch permissions


# This example grants launch permissions for the specified AMI to the specified AWS account.

resp = client.modify_image_attribute({
  image_id: "ami-5731123e", 
  launch_permission: {
    add: [
      {
        user_id: "123456789012", 
      }, 
    ], 
  }, 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.modify_image_attribute({
  attribute: "String",
  description: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  image_id: "ImageId", # required
  launch_permission: {
    add: [
      {
        organization_arn: "String",
        organizational_unit_arn: "String",
        user_id: "String",
        group: "all", # accepts all
      },
    ],
    remove: [
      {
        organization_arn: "String",
        organizational_unit_arn: "String",
        user_id: "String",
        group: "all", # accepts all
      },
    ],
  },
  operation_type: "add", # accepts add, remove
  product_codes: ["String"],
  user_groups: ["String"],
  user_ids: ["String"],
  value: "String",
  organization_arns: ["String"],
  organizational_unit_arns: ["String"],
  imds_support: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute (String) —

    The name of the attribute to modify.

    Valid values: ‘description` | `imdsSupport` | `launchPermission`

  • :description (Types::AttributeValue) —

    A new description for the AMI.

  • :image_id (required, String) —

    The ID of the AMI.

  • :launch_permission (Types::LaunchPermissionModifications) —

    A new launch permission for the AMI.

  • :operation_type (String) —

    The operation type. This parameter can be used only when the ‘Attribute` parameter is `launchPermission`.

  • :product_codes (Array<String>) —

    Not supported.

  • :user_groups (Array<String>) —

    The user groups. This parameter can be used only when the ‘Attribute` parameter is `launchPermission`.

  • :user_ids (Array<String>) —

    The Amazon Web Services account IDs. This parameter can be used only when the ‘Attribute` parameter is `launchPermission`.

  • :value (String) —

    The value of the attribute being modified. This parameter can be used only when the ‘Attribute` parameter is `description` or `imdsSupport`.

  • :organization_arns (Array<String>) —

    The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the ‘Attribute` parameter is `launchPermission`.

  • :organizational_unit_arns (Array<String>) —

    The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the ‘Attribute` parameter is `launchPermission`.

  • :imds_support (Types::AttributeValue) —

    Set to ‘v2.0` to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have `HttpTokens` automatically set to `required` so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, `HttpPutResponseHopLimit` is set to `2`. For more information, see

    Configure the AMI][1

    in the *Amazon EC2 User Guide*.

    Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to ‘v2.0`, you can’t undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



47846
47847
47848
47849
 
# File 'lib/aws-sdk-ec2/client.rb', line 47846

def modify_image_attribute(params = {}, options = {})
  req = build_request(:modify_image_attribute, params)
  req.send_request(options)
end

#modify_instance_attribute(params = {}) ⇒ Struct

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.

To modify some attributes, the instance must be stopped. For more information, see [Modify a stopped instance] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html

Examples:

Example: To modify the instance type


# This example modifies the instance type of the specified stopped instance.

resp = client.modify_instance_attribute({
  instance_id: "i-1234567890abcdef0", 
  instance_type: {
    value: "m5.large", 
  }, 
})

resp.to_h outputs the following:
{
}

Example: To enable enhanced networking


# This example enables enhanced networking for the specified stopped instance.

resp = client.modify_instance_attribute({
  ena_support: {
    value: true, 
  }, 
  instance_id: "i-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.modify_instance_attribute({
  source_dest_check: {
    value: false,
  },
  disable_api_stop: {
    value: false,
  },
  dry_run: false,
  instance_id: "InstanceId", # required
  attribute: "instanceType", # accepts instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport, enaSupport, enclaveOptions, disableApiStop
  value: "String",
  block_device_mappings: [
    {
      device_name: "String",
      ebs: {
        volume_id: "VolumeId",
        delete_on_termination: false,
      },
      virtual_name: "String",
      no_device: "String",
    },
  ],
  disable_api_termination: {
    value: false,
  },
  instance_type: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  kernel: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  ramdisk: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  user_data: {
    value: "data",
  },
  instance_initiated_shutdown_behavior: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  groups: ["SecurityGroupId"],
  ebs_optimized: {
    value: false,
  },
  sriov_net_support: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  ena_support: {
    value: false,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_dest_check (Types::AttributeBooleanValue) —

    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.

  • :disable_api_stop (Types::AttributeBooleanValue) —

    Indicates whether an instance is enabled for stop protection. For more information, see [Enable stop protection for your instance].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the instance.

  • :attribute (String) —

    The name of the attribute to modify.

    You can modify the following attributes only: ‘disableApiTermination` | `instanceType` | `kernel` | `ramdisk` | `instanceInitiatedShutdownBehavior` | `blockDeviceMapping` | `userData` | `sourceDestCheck` | `groupSet` | `ebsOptimized` | `sriovNetSupport` | `enaSupport` | `nvmeSupport` | `disableApiStop` | `enclaveOptions`

  • :value (String) —

    A new value for the attribute. Use only with the ‘kernel`, `ramdisk`, `userData`, `disableApiTermination`, or `instanceInitiatedShutdownBehavior` attribute.

  • :block_device_mappings (Array<Types::InstanceBlockDeviceMappingSpecification>) —

    Modifies the ‘DeleteOnTermination` attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for `DeleteOnTermination`, the default is `true` and the volume is deleted when the instance is terminated. You can’t modify the ‘DeleteOnTermination` attribute for volumes that are attached to Fargate tasks.

    To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see

    Update the block device mapping when launching an instance][1

    in the

    *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM

  • :disable_api_termination (Types::AttributeBooleanValue) —

    If the value is ‘true`, you can’t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.

  • :instance_type (Types::AttributeValue) —

    Changes the instance type to the specified value. For more information, see [Instance types] in the *Amazon EC2 User Guide*. If the instance type is not valid, the error returned is ‘InvalidInstanceAttributeValue`.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

  • :kernel (Types::AttributeValue) —

    Changes the instance’s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html

  • :ramdisk (Types::AttributeValue) —

    Changes the instance’s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html

  • :user_data (Types::BlobAttributeValue) —

    Changes the instance’s user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you’re using, the base64-encoding might be performed for you. For more information, see [Work with instance user data].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html

  • :instance_initiated_shutdown_behavior (Types::AttributeValue) —

    Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

  • :groups (Array<String>) —

    Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it’s just the default security group for the VPC.

  • :ebs_optimized (Types::AttributeBooleanValue) —

    Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

  • :sriov_net_support (Types::AttributeValue) —

    Set to ‘simple` to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

    There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

    This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

  • :ena_support (Types::AttributeBooleanValue) —

    Set to ‘true` to enable enhanced networking with ENA for the instance.

    This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



48085
48086
48087
48088
 
# File 'lib/aws-sdk-ec2/client.rb', line 48085

def modify_instance_attribute(params = {}, options = {})
  req = build_request(:modify_instance_attribute, params)
  req.send_request(options)
end

#modify_instance_capacity_reservation_attributes(params = {}) ⇒ Types::ModifyInstanceCapacityReservationAttributesResult

Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any ‘open` Capacity Reservation with matching attributes, or run On-Demand Instance capacity.

Examples:

Request syntax with placeholder values


resp = client.modify_instance_capacity_reservation_attributes({
  instance_id: "InstanceId", # required
  capacity_reservation_specification: { # required
    capacity_reservation_preference: "open", # accepts open, none
    capacity_reservation_target: {
      capacity_reservation_id: "CapacityReservationId",
      capacity_reservation_resource_group_arn: "String",
    },
  },
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance to be modified.

  • :capacity_reservation_specification (required, Types::CapacityReservationSpecification) —

    Information about the Capacity Reservation targeting option.

  • :dry_run (Boolean) —

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

Returns:

See Also:



48133
48134
48135
48136
 
# File 'lib/aws-sdk-ec2/client.rb', line 48133

def modify_instance_capacity_reservation_attributes(params = {}, options = {})
  req = build_request(:modify_instance_capacity_reservation_attributes, params)
  req.send_request(options)
end

#modify_instance_cpu_options(params = {}) ⇒ Types::ModifyInstanceCpuOptionsResult

By default, all vCPUs for the instance type are active when you launch an instance. When you configure the number of active vCPUs for the instance, it can help you save on licensing costs and optimize performance. The base cost of the instance remains unchanged.

The number of active vCPUs equals the number of threads per CPU core multiplied by the number of cores. The instance must be in a ‘Stopped` state before you make changes.

<note markdown=“1”> Some instance type options do not support this capability. For more information, see [Supported CPU options] in the *Amazon EC2 User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/cpu-options-supported-instances-values.html

Examples:

Request syntax with placeholder values


resp = client.modify_instance_cpu_options({
  instance_id: "InstanceId", # required
  core_count: 1, # required
  threads_per_core: 1, # required
  dry_run: false,
})

Response structure


resp.instance_id #=> String
resp.core_count #=> Integer
resp.threads_per_core #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance to update.

  • :core_count (required, Integer) —

    The number of CPU cores to activate for the specified instance.

  • :threads_per_core (required, Integer) —

    The number of threads to run for each CPU core.

  • :dry_run (Boolean) —

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

Returns:

See Also:



48197
48198
48199
48200
 
# File 'lib/aws-sdk-ec2/client.rb', line 48197

def modify_instance_cpu_options(params = {}, options = {})
  req = build_request(:modify_instance_cpu_options, params)
  req.send_request(options)
end

#modify_instance_credit_specification(params = {}) ⇒ Types::ModifyInstanceCreditSpecificationResult

Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are ‘standard` and `unlimited`.

For more information, see [Burstable performance instances] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html

Examples:

Request syntax with placeholder values


resp = client.modify_instance_credit_specification({
  dry_run: false,
  client_token: "String",
  instance_credit_specifications: [ # required
    {
      instance_id: "InstanceId", # required
      cpu_credits: "String",
    },
  ],
})

Response structure


resp.successful_instance_credit_specifications #=> Array
resp.successful_instance_credit_specifications[0].instance_id #=> String
resp.unsuccessful_instance_credit_specifications #=> Array
resp.unsuccessful_instance_credit_specifications[0].instance_id #=> String
resp.unsuccessful_instance_credit_specifications[0].error.code #=> String, one of "InvalidInstanceID.Malformed", "InvalidInstanceID.NotFound", "IncorrectInstanceState", "InstanceCreditSpecification.NotSupported"
resp.unsuccessful_instance_credit_specifications[0].error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring Idempotency].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :instance_credit_specifications (required, Array<Types::InstanceCreditSpecificationRequest>) —

    Information about the credit option for CPU usage.

Returns:

See Also:



48262
48263
48264
48265
 
# File 'lib/aws-sdk-ec2/client.rb', line 48262

def modify_instance_credit_specification(params = {}, options = {})
  req = build_request(:modify_instance_credit_specification, params)
  req.send_request(options)
end

#modify_instance_event_start_time(params = {}) ⇒ Types::ModifyInstanceEventStartTimeResult

Modifies the start time for a scheduled Amazon EC2 instance event.

Examples:

Request syntax with placeholder values


resp = client.modify_instance_event_start_time({
  dry_run: false,
  instance_id: "InstanceId", # required
  instance_event_id: "String", # required
  not_before: Time.now, # required
})

Response structure


resp.event.instance_event_id #=> String
resp.event.code #=> String, one of "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop"
resp.event.description #=> String
resp.event.not_after #=> Time
resp.event.not_before #=> Time
resp.event.not_before_deadline #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the instance with the scheduled event.

  • :instance_event_id (required, String) —

    The ID of the event whose date and time you are modifying.

  • :not_before (required, Time, DateTime, Date, Integer, String) —

    The new date and time when the event will take place.

Returns:

See Also:



48310
48311
48312
48313
 
# File 'lib/aws-sdk-ec2/client.rb', line 48310

def modify_instance_event_start_time(params = {}, options = {})
  req = build_request(:modify_instance_event_start_time, params)
  req.send_request(options)
end

#modify_instance_event_window(params = {}) ⇒ Types::ModifyInstanceEventWindowResult

Modifies the specified event window.

You can define either a set of time ranges or a cron expression when modifying the event window, but not both.

To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.

If Amazon Web Services has already scheduled an event, modifying an event window won’t change the time of the scheduled event.

For more information, see [Define event windows for scheduled events] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html

Examples:

Request syntax with placeholder values


resp = client.modify_instance_event_window({
  dry_run: false,
  name: "String",
  instance_event_window_id: "InstanceEventWindowId", # required
  time_ranges: [
    {
      start_week_day: "sunday", # accepts sunday, monday, tuesday, wednesday, thursday, friday, saturday
      start_hour: 1,
      end_week_day: "sunday", # accepts sunday, monday, tuesday, wednesday, thursday, friday, saturday
      end_hour: 1,
    },
  ],
  cron_expression: "InstanceEventWindowCronExpression",
})

Response structure


resp.instance_event_window.instance_event_window_id #=> String
resp.instance_event_window.time_ranges #=> Array
resp.instance_event_window.time_ranges[0].start_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_window.time_ranges[0].start_hour #=> Integer
resp.instance_event_window.time_ranges[0].end_week_day #=> String, one of "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
resp.instance_event_window.time_ranges[0].end_hour #=> Integer
resp.instance_event_window.name #=> String
resp.instance_event_window.cron_expression #=> String
resp.instance_event_window.association_target.instance_ids #=> Array
resp.instance_event_window.association_target.instance_ids[0] #=> String
resp.instance_event_window.association_target.tags #=> Array
resp.instance_event_window.association_target.tags[0].key #=> String
resp.instance_event_window.association_target.tags[0].value #=> String
resp.instance_event_window.association_target.dedicated_host_ids #=> Array
resp.instance_event_window.association_target.dedicated_host_ids[0] #=> String
resp.instance_event_window.state #=> String, one of "creating", "deleting", "active", "deleted"
resp.instance_event_window.tags #=> Array
resp.instance_event_window.tags[0].key #=> String
resp.instance_event_window.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_event_window_id (required, String) —

    The ID of the event window.

  • :time_ranges (Array<Types::InstanceEventWindowTimeRangeRequest>) —

    The time ranges of the event window.

  • :cron_expression (String) —

    The cron expression of the event window, for example, ‘* 0-4,20-23 * * 1,5`.

    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 &gt;= 2 hours, for example, ‘0-2` or `20-23`.

    • The event window must be &gt;= 4 hours. The combined total time ranges in the event window must be &gt;= 4 hours.

    For more information about cron expressions, see [cron] on the *Wikipedia website*.

    [1]: en.wikipedia.org/wiki/Cron

Returns:

See Also:



48424
48425
48426
48427
 
# File 'lib/aws-sdk-ec2/client.rb', line 48424

def modify_instance_event_window(params = {}, options = {})
  req = build_request(:modify_instance_event_window, params)
  req.send_request(options)
end

#modify_instance_maintenance_options(params = {}) ⇒ Types::ModifyInstanceMaintenanceOptionsResult

Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see [Simplified automatic recovery].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery

Examples:

Request syntax with placeholder values


resp = client.modify_instance_maintenance_options({
  instance_id: "InstanceId", # required
  auto_recovery: "disabled", # accepts disabled, default
  dry_run: false,
})

Response structure


resp.instance_id #=> String
resp.auto_recovery #=> String, one of "disabled", "default"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance.

  • :auto_recovery (String) —

    Disables the automatic recovery behavior of your instance or sets it to default.

  • :dry_run (Boolean) —

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

Returns:

See Also:



48474
48475
48476
48477
 
# File 'lib/aws-sdk-ec2/client.rb', line 48474

def modify_instance_maintenance_options(params = {}, options = {})
  req = build_request(:modify_instance_maintenance_options, params)
  req.send_request(options)
end

#modify_instance_metadata_defaults(params = {}) ⇒ Types::ModifyInstanceMetadataDefaultsResult

Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services
 Region.

<note markdown=“1”> To remove a parameter’s account-level default setting, specify ‘no-preference`. If an account-level setting is cleared with `no-preference`, then the instance launch considers the other instance metadata settings. For more information, see [Order of precedence for instance metadata options] in the *Amazon EC2 User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence

Examples:

Request syntax with placeholder values


resp = client.modify_instance_metadata_defaults({
  http_tokens: "optional", # accepts optional, required, no-preference
  http_put_response_hop_limit: 1,
  http_endpoint: "disabled", # accepts disabled, enabled, no-preference
  instance_metadata_tags: "disabled", # accepts disabled, enabled, no-preference
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :http_tokens (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.

  • :http_put_response_hop_limit (Integer) —

    The maximum number of hops that the metadata token can travel. To indicate no preference, specify ‘-1`.

    Possible values: Integers from ‘1` to `64`, and `-1` to indicate no preference

  • :http_endpoint (String) —

    Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can’t be accessed.

  • :instance_metadata_tags (String) —

    Enables or disables access to an instance’s tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS

  • :dry_run (Boolean) —

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

Returns:

See Also:



48551
48552
48553
48554
 
# File 'lib/aws-sdk-ec2/client.rb', line 48551

def modify_instance_metadata_defaults(params = {}, options = {})
  req = build_request(:modify_instance_metadata_defaults, params)
  req.send_request(options)
end

#modify_instance_metadata_options(params = {}) ⇒ Types::ModifyInstanceMetadataOptionsResult

Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending”to “applied” in subsequent describe-instances API calls. For more information, see [Instance metadata and user data] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html

Examples:

Request syntax with placeholder values


resp = client.modify_instance_metadata_options({
  instance_id: "InstanceId", # required
  http_tokens: "optional", # accepts optional, required
  http_put_response_hop_limit: 1,
  http_endpoint: "disabled", # accepts disabled, enabled
  dry_run: false,
  http_protocol_ipv_6: "disabled", # accepts disabled, enabled
  instance_metadata_tags: "disabled", # accepts disabled, enabled
})

Response structure


resp.instance_id #=> String
resp.instance_metadata_options.state #=> String, one of "pending", "applied"
resp.instance_metadata_options.http_tokens #=> String, one of "optional", "required"
resp.instance_metadata_options.http_put_response_hop_limit #=> Integer
resp.instance_metadata_options.http_endpoint #=> String, one of "disabled", "enabled"
resp.instance_metadata_options.http_protocol_ipv_6 #=> String, one of "disabled", "enabled"
resp.instance_metadata_options.instance_metadata_tags #=> String, one of "disabled", "enabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance.

  • :http_tokens (String) —

    Indicates whether IMDSv2 is required.

    • ‘optional` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

    • ‘required` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

    Default:

    • If the value of ‘ImdsSupport` for the Amazon Machine Image (AMI) for your instance is `v2.0` and the account level default is set to `no-preference`, the default is `required`.

    • If the value of ‘ImdsSupport` for the Amazon Machine Image (AMI) for your instance is `v2.0`, but the account level default is set to `V1 or V2`, the default is `optional`.

    The default value can also be affected by other combinations of parameters. For more information, see [Order of precedence for instance metadata options] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence

  • :http_put_response_hop_limit (Integer) —

    The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.

    Possible values: Integers from 1 to 64

  • :http_endpoint (String) —

    Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

    If you specify a value of ‘disabled`, you cannot access your instance metadata.

  • :dry_run (Boolean) —

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

  • :http_protocol_ipv_6 (String) —

    Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

  • :instance_metadata_tags (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].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS

Returns:

See Also:



48672
48673
48674
48675
 
# File 'lib/aws-sdk-ec2/client.rb', line 48672

def modify_instance_metadata_options(params = {}, options = {})
  req = build_request(:modify_instance_metadata_options, params)
  req.send_request(options)
end

#modify_instance_placement(params = {}) ⇒ Types::ModifyInstancePlacementResult

Modifies the placement attributes for a specified instance. You can do the following:

  • Modify the affinity between an instance and a [Dedicated Host]. When affinity is set to ‘host` and the instance is not associated with a specific Dedicated Host, the next time the instance is started, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.

  • Change the Dedicated Host with which an instance is associated.

  • Change the instance tenancy of an instance.

  • Move an instance to or from a [placement group].

At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.

To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the ‘stopped` state.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html

Examples:

Request syntax with placeholder values


resp = client.modify_instance_placement({
  group_name: "PlacementGroupName",
  partition_number: 1,
  host_resource_group_arn: "String",
  group_id: "PlacementGroupId",
  instance_id: "InstanceId", # required
  tenancy: "default", # accepts default, dedicated, host
  affinity: "default", # accepts default, host
  host_id: "DedicatedHostId",
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (String) —

    The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of ‘default`. For cluster and partition placement groups, the instance must have a tenancy of `default` or `dedicated`.

    To remove an instance from a placement group, specify an empty string (“”).

  • :partition_number (Integer) —

    The number of the partition in which to place the instance. Valid only if the placement group strategy is set to ‘partition`.

  • :host_resource_group_arn (String) —

    The ARN of the host resource group in which to place the instance. The instance must have a tenancy of ‘host` to specify this parameter.

  • :group_id (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.

  • :instance_id (required, String) —

    The ID of the instance that you are modifying.

  • :tenancy (String) —

    The tenancy for the instance.

    <note markdown=“1”> For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of ‘host`. You can’t change the tenancy from ‘host` to `dedicated` or `default`. Attempting to make one of these unsupported tenancy changes results in an `InvalidRequest` error code.

    </note>
  • :affinity (String) —

    The affinity setting for the instance. For more information, see [Host affinity] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-affinity

  • :host_id (String) —

    The ID of the Dedicated Host with which to associate the instance.

Returns:

See Also:



48775
48776
48777
48778
 
# File 'lib/aws-sdk-ec2/client.rb', line 48775

def modify_instance_placement(params = {}, options = {})
  req = build_request(:modify_instance_placement, params)
  req.send_request(options)
end

#modify_ipam(params = {}) ⇒ Types::ModifyIpamResult

Modify the configurations of an IPAM.

Examples:

Request syntax with placeholder values


resp = client.modify_ipam({
  dry_run: false,
  ipam_id: "IpamId", # required
  description: "String",
  add_operating_regions: [
    {
      region_name: "String",
    },
  ],
  remove_operating_regions: [
    {
      region_name: "String",
    },
  ],
  tier: "free", # accepts free, advanced
  enable_private_gua: false,
})

Response structure


resp.ipam.owner_id #=> String
resp.ipam.ipam_id #=> String
resp.ipam.ipam_arn #=> String
resp.ipam.ipam_region #=> String
resp.ipam.public_default_scope_id #=> String
resp.ipam.private_default_scope_id #=> String
resp.ipam.scope_count #=> Integer
resp.ipam.description #=> String
resp.ipam.operating_regions #=> Array
resp.ipam.operating_regions[0].region_name #=> String
resp.ipam.state #=> String, one of "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"
resp.ipam.tags #=> Array
resp.ipam.tags[0].key #=> String
resp.ipam.tags[0].value #=> String
resp.ipam.default_resource_discovery_id #=> String
resp.ipam.default_resource_discovery_association_id #=> String
resp.ipam.resource_discovery_association_count #=> Integer
resp.ipam.state_message #=> String
resp.ipam.tier #=> String, one of "free", "advanced"
resp.ipam.enable_private_gua #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_id (required, String) —

    The ID of the IPAM you want to modify.

  • :description (String) —

    The description of the IPAM you want to modify.

  • :add_operating_regions (Array<Types::AddIpamOperatingRegion>) —

    Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

    For more information about operating Regions, see [Create an IPAM] in the *Amazon VPC IPAM User Guide*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html

  • :remove_operating_regions (Array<Types::RemoveIpamOperatingRegion>) —

    The operating Regions to remove.

  • :tier (String) —

    IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see [Amazon VPC pricing &gt; IPAM tab].

    [1]: aws.amazon.com/vpc/pricing/

  • :enable_private_gua (Boolean) —

    Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Returns:

See Also:



48874
48875
48876
48877
 
# File 'lib/aws-sdk-ec2/client.rb', line 48874

def modify_ipam(params = {}, options = {})
  req = build_request(:modify_ipam, params)
  req.send_request(options)
end

#modify_ipam_pool(params = {}) ⇒ Types::ModifyIpamPoolResult

Modify the configurations of an IPAM pool.

For more information, see [Modify a pool] in the *Amazon VPC IPAM User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/mod-pool-ipam.html

Examples:

Request syntax with placeholder values


resp = client.modify_ipam_pool({
  dry_run: false,
  ipam_pool_id: "IpamPoolId", # required
  description: "String",
  auto_import: false,
  allocation_min_netmask_length: 1,
  allocation_max_netmask_length: 1,
  allocation_default_netmask_length: 1,
  clear_allocation_default_netmask_length: false,
  add_allocation_resource_tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  remove_allocation_resource_tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.ipam_pool.owner_id #=> String
resp.ipam_pool.ipam_pool_id #=> String
resp.ipam_pool.source_ipam_pool_id #=> String
resp.ipam_pool.ipam_pool_arn #=> String
resp.ipam_pool.ipam_scope_arn #=> String
resp.ipam_pool.ipam_scope_type #=> String, one of "public", "private"
resp.ipam_pool.ipam_arn #=> String
resp.ipam_pool.ipam_region #=> String
resp.ipam_pool.locale #=> String
resp.ipam_pool.pool_depth #=> Integer
resp.ipam_pool.state #=> String, one of "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"
resp.ipam_pool.state_message #=> String
resp.ipam_pool.description #=> String
resp.ipam_pool.auto_import #=> Boolean
resp.ipam_pool.publicly_advertisable #=> Boolean
resp.ipam_pool.address_family #=> String, one of "ipv4", "ipv6"
resp.ipam_pool.allocation_min_netmask_length #=> Integer
resp.ipam_pool.allocation_max_netmask_length #=> Integer
resp.ipam_pool.allocation_default_netmask_length #=> Integer
resp.ipam_pool.allocation_resource_tags #=> Array
resp.ipam_pool.allocation_resource_tags[0].key #=> String
resp.ipam_pool.allocation_resource_tags[0].value #=> String
resp.ipam_pool.tags #=> Array
resp.ipam_pool.tags[0].key #=> String
resp.ipam_pool.tags[0].value #=> String
resp.ipam_pool.aws_service #=> String, one of "ec2"
resp.ipam_pool.public_ip_source #=> String, one of "amazon", "byoip"
resp.ipam_pool.source_resource.resource_id #=> String
resp.ipam_pool.source_resource.resource_type #=> String, one of "vpc"
resp.ipam_pool.source_resource.resource_region #=> String
resp.ipam_pool.source_resource.resource_owner #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_pool_id (required, String) —

    The ID of the IPAM pool you want to modify.

  • :description (String) —

    The description of the IPAM pool you want to modify.

  • :auto_import (Boolean) —

    If true, 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.

  • :allocation_min_netmask_length (Integer) —

    The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

  • :allocation_max_netmask_length (Integer) —

    The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

  • :allocation_default_netmask_length (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.

  • :clear_allocation_default_netmask_length (Boolean) —

    Clear the default netmask length allocation rule for this pool.

  • :add_allocation_resource_tags (Array<Types::RequestIpamResourceTag>) —

    Add tag allocation rules to a pool. For more information about allocation rules, see [Create a top-level pool] in the *Amazon VPC IPAM User Guide*.

    [1]: docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html

  • :remove_allocation_resource_tags (Array<Types::RequestIpamResourceTag>) —

    Remove tag allocation rules from a pool.

Returns:

See Also:



49014
49015
49016
49017
 
# File 'lib/aws-sdk-ec2/client.rb', line 49014

def modify_ipam_pool(params = {}, options = {})
  req = build_request(:modify_ipam_pool, params)
  req.send_request(options)
end

#modify_ipam_resource_cidr(params = {}) ⇒ Types::ModifyIpamResourceCidrResult

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

For more information, see [Move resource CIDRs between scopes] and

Change the monitoring state of resource CIDRs][2

in the *Amazon VPC

IPAM User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/move-resource-ipam.html [2]: docs.aws.amazon.com/vpc/latest/ipam/change-monitoring-state-ipam.html

Examples:

Request syntax with placeholder values


resp = client.modify_ipam_resource_cidr({
  dry_run: false,
  resource_id: "String", # required
  resource_cidr: "String", # required
  resource_region: "String", # required
  current_ipam_scope_id: "IpamScopeId", # required
  destination_ipam_scope_id: "IpamScopeId",
  monitored: false, # required
})

Response structure


resp.ipam_resource_cidr.ipam_id #=> String
resp.ipam_resource_cidr.ipam_scope_id #=> String
resp.ipam_resource_cidr.ipam_pool_id #=> String
resp.ipam_resource_cidr.resource_region #=> String
resp.ipam_resource_cidr.resource_owner_id #=> String
resp.ipam_resource_cidr.resource_id #=> String
resp.ipam_resource_cidr.resource_name #=> String
resp.ipam_resource_cidr.resource_cidr #=> String
resp.ipam_resource_cidr.resource_type #=> String, one of "vpc", "subnet", "eip", "public-ipv4-pool", "ipv6-pool", "eni"
resp.ipam_resource_cidr.resource_tags #=> Array
resp.ipam_resource_cidr.resource_tags[0].key #=> String
resp.ipam_resource_cidr.resource_tags[0].value #=> String
resp.ipam_resource_cidr.ip_usage #=> Float
resp.ipam_resource_cidr.compliance_status #=> String, one of "compliant", "noncompliant", "unmanaged", "ignored"
resp.ipam_resource_cidr.management_state #=> String, one of "managed", "unmanaged", "ignored"
resp.ipam_resource_cidr.overlap_status #=> String, one of "overlapping", "nonoverlapping", "ignored"
resp.ipam_resource_cidr.vpc_id #=> String
resp.ipam_resource_cidr.availability_zone_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :resource_id (required, String) —

    The ID of the resource you want to modify.

  • :resource_cidr (required, String) —

    The CIDR of the resource you want to modify.

  • :resource_region (required, String) —

    The Amazon Web Services Region of the resource you want to modify.

  • :current_ipam_scope_id (required, String) —

    The ID of the current scope that the resource CIDR is in.

  • :destination_ipam_scope_id (String) —

    The ID of the scope you want to transfer the resource CIDR to.

  • :monitored (required, Boolean) —

    Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.

Returns:

See Also:



49101
49102
49103
49104
 
# File 'lib/aws-sdk-ec2/client.rb', line 49101

def modify_ipam_resource_cidr(params = {}, options = {})
  req = build_request(:modify_ipam_resource_cidr, params)
  req.send_request(options)
end

#modify_ipam_resource_discovery(params = {}) ⇒ Types::ModifyIpamResourceDiscoveryResult

Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Examples:

Request syntax with placeholder values


resp = client.modify_ipam_resource_discovery({
  dry_run: false,
  ipam_resource_discovery_id: "IpamResourceDiscoveryId", # required
  description: "String",
  add_operating_regions: [
    {
      region_name: "String",
    },
  ],
  remove_operating_regions: [
    {
      region_name: "String",
    },
  ],
})

Response structure


resp.ipam_resource_discovery.owner_id #=> String
resp.ipam_resource_discovery.ipam_resource_discovery_id #=> String
resp.ipam_resource_discovery.ipam_resource_discovery_arn #=> String
resp.ipam_resource_discovery.ipam_resource_discovery_region #=> String
resp.ipam_resource_discovery.description #=> String
resp.ipam_resource_discovery.operating_regions #=> Array
resp.ipam_resource_discovery.operating_regions[0].region_name #=> String
resp.ipam_resource_discovery.is_default #=> Boolean
resp.ipam_resource_discovery.state #=> String, one of "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"
resp.ipam_resource_discovery.tags #=> Array
resp.ipam_resource_discovery.tags[0].key #=> String
resp.ipam_resource_discovery.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_resource_discovery_id (required, String) —

    A resource discovery ID.

  • :description (String) —

    A resource discovery description.

  • :add_operating_regions (Array<Types::AddIpamOperatingRegion>) —

    Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

  • :remove_operating_regions (Array<Types::RemoveIpamOperatingRegion>) —

    Remove operating Regions.

Returns:

See Also:



49172
49173
49174
49175
 
# File 'lib/aws-sdk-ec2/client.rb', line 49172

def modify_ipam_resource_discovery(params = {}, options = {})
  req = build_request(:modify_ipam_resource_discovery, params)
  req.send_request(options)
end

#modify_ipam_scope(params = {}) ⇒ Types::ModifyIpamScopeResult

Modify an IPAM scope.

Examples:

Request syntax with placeholder values


resp = client.modify_ipam_scope({
  dry_run: false,
  ipam_scope_id: "IpamScopeId", # required
  description: "String",
})

Response structure


resp.ipam_scope.owner_id #=> String
resp.ipam_scope.ipam_scope_id #=> String
resp.ipam_scope.ipam_scope_arn #=> String
resp.ipam_scope.ipam_arn #=> String
resp.ipam_scope.ipam_region #=> String
resp.ipam_scope.ipam_scope_type #=> String, one of "public", "private"
resp.ipam_scope.is_default #=> Boolean
resp.ipam_scope.description #=> String
resp.ipam_scope.pool_count #=> Integer
resp.ipam_scope.state #=> String, one of "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"
resp.ipam_scope.tags #=> Array
resp.ipam_scope.tags[0].key #=> String
resp.ipam_scope.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_scope_id (required, String) —

    The ID of the scope you want to modify.

  • :description (String) —

    The description of the scope you want to modify.

Returns:

See Also:



49223
49224
49225
49226
 
# File 'lib/aws-sdk-ec2/client.rb', line 49223

def modify_ipam_scope(params = {}, options = {})
  req = build_request(:modify_ipam_scope, params)
  req.send_request(options)
end

#modify_launch_template(params = {}) ⇒ Types::ModifyLaunchTemplateResult

Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.

Examples:

Example: To change the default version of a launch template


# This example specifies version 2 as the default version of the specified launch template.

resp = client.modify_launch_template({
  default_version: "2", 
  launch_template_id: "lt-0abcd290751193123", 
})

resp.to_h outputs the following:
{
  launch_template: {
    create_time: Time.parse("2017-12-01T13:35:46.000Z"), 
    created_by: "arn:aws:iam::123456789012:root", 
    default_version_number: 2, 
    latest_version_number: 2, 
    launch_template_id: "lt-0abcd290751193123", 
    launch_template_name: "WebServers", 
  }, 
}

Request syntax with placeholder values


resp = client.modify_launch_template({
  dry_run: false,
  client_token: "String",
  launch_template_id: "LaunchTemplateId",
  launch_template_name: "LaunchTemplateName",
  default_version: "String",
})

Response structure


resp.launch_template.launch_template_id #=> String
resp.launch_template.launch_template_name #=> String
resp.launch_template.create_time #=> Time
resp.launch_template.created_by #=> String
resp.launch_template.default_version_number #=> Integer
resp.launch_template.latest_version_number #=> Integer
resp.launch_template.tags #=> Array
resp.launch_template.tags[0].key #=> String
resp.launch_template.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :client_token (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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :launch_template_id (String) —

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name, but not both.

  • :launch_template_name (String) —

    The name of the launch template.

    You must specify either the launch template ID or the launch template name, but not both.

  • :default_version (String) —

    The version number of the launch template to set as the default version.

Returns:

See Also:



49318
49319
49320
49321
 
# File 'lib/aws-sdk-ec2/client.rb', line 49318

def modify_launch_template(params = {}, options = {})
  req = build_request(:modify_launch_template, params)
  req.send_request(options)
end

#modify_local_gateway_route(params = {}) ⇒ Types::ModifyLocalGatewayRouteResult

Modifies the specified local gateway route.

Examples:

Request syntax with placeholder values


resp = client.modify_local_gateway_route({
  destination_cidr_block: "String",
  local_gateway_route_table_id: "LocalGatewayRoutetableId", # required
  local_gateway_virtual_interface_group_id: "LocalGatewayVirtualInterfaceGroupId",
  network_interface_id: "NetworkInterfaceId",
  dry_run: false,
  destination_prefix_list_id: "PrefixListResourceId",
})

Response structure


resp.route.destination_cidr_block #=> String
resp.route.local_gateway_virtual_interface_group_id #=> String
resp.route.type #=> String, one of "static", "propagated"
resp.route.state #=> String, one of "pending", "active", "blackhole", "deleting", "deleted"
resp.route.local_gateway_route_table_id #=> String
resp.route.local_gateway_route_table_arn #=> String
resp.route.owner_id #=> String
resp.route.subnet_id #=> String
resp.route.coip_pool_id #=> String
resp.route.network_interface_id #=> String
resp.route.destination_prefix_list_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_cidr_block (String) —

    The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table.

  • :local_gateway_route_table_id (required, String) —

    The ID of the local gateway route table.

  • :local_gateway_virtual_interface_group_id (String) —

    The ID of the virtual interface group.

  • :network_interface_id (String) —

    The ID of the network interface.

  • :dry_run (Boolean) —

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

  • :destination_prefix_list_id (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.

Returns:

See Also:



49382
49383
49384
49385
 
# File 'lib/aws-sdk-ec2/client.rb', line 49382

def modify_local_gateway_route(params = {}, options = {})
  req = build_request(:modify_local_gateway_route, params)
  req.send_request(options)
end

#modify_managed_prefix_list(params = {}) ⇒ Types::ModifyManagedPrefixListResult

Modifies the specified managed prefix list.

Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.

If you specify a current version number that does not match the true current version number, the request fails.

Examples:

Request syntax with placeholder values


resp = client.modify_managed_prefix_list({
  dry_run: false,
  prefix_list_id: "PrefixListResourceId", # required
  current_version: 1,
  prefix_list_name: "String",
  add_entries: [
    {
      cidr: "String", # required
      description: "String",
    },
  ],
  remove_entries: [
    {
      cidr: "String", # required
    },
  ],
  max_entries: 1,
})

Response structure


resp.prefix_list.prefix_list_id #=> String
resp.prefix_list.address_family #=> String
resp.prefix_list.state #=> String, one of "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"
resp.prefix_list.state_message #=> String
resp.prefix_list.prefix_list_arn #=> String
resp.prefix_list.prefix_list_name #=> String
resp.prefix_list.max_entries #=> Integer
resp.prefix_list.version #=> Integer
resp.prefix_list.tags #=> Array
resp.prefix_list.tags[0].key #=> String
resp.prefix_list.tags[0].value #=> String
resp.prefix_list.owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The ID of the prefix list.

  • :current_version (Integer) —

    The current version of the prefix list.

  • :prefix_list_name (String) —

    A name for the prefix list.

  • :add_entries (Array<Types::AddPrefixListEntry>) —

    One or more entries to add to the prefix list.

  • :remove_entries (Array<Types::RemovePrefixListEntry>) —

    One or more entries to remove from the prefix list.

  • :max_entries (Integer) —

    The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.

    If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.

Returns:

See Also:



49471
49472
49473
49474
 
# File 'lib/aws-sdk-ec2/client.rb', line 49471

def modify_managed_prefix_list(params = {}, options = {})
  req = build_request(:modify_managed_prefix_list, params)
  req.send_request(options)
end

#modify_network_interface_attribute(params = {}) ⇒ Struct

Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.

Examples:

Example: To modify the attachment attribute of a network interface


# This example modifies the attachment attribute of the specified network interface.

resp = client.modify_network_interface_attribute({
  attachment: {
    attachment_id: "eni-attach-43348162", 
    delete_on_termination: false, 
  }, 
  network_interface_id: "eni-686ea200", 
})

Example: To modify the description attribute of a network interface


# This example modifies the description attribute of the specified network interface.

resp = client.modify_network_interface_attribute({
  description: {
    value: "My description", 
  }, 
  network_interface_id: "eni-686ea200", 
})

Example: To modify the groupSet attribute of a network interface


# This example command modifies the groupSet attribute of the specified network interface.

resp = client.modify_network_interface_attribute({
  groups: [
    "sg-903004f8", 
    "sg-1a2b3c4d", 
  ], 
  network_interface_id: "eni-686ea200", 
})

Example: To modify the sourceDestCheck attribute of a network interface


# This example command modifies the sourceDestCheck attribute of the specified network interface.

resp = client.modify_network_interface_attribute({
  network_interface_id: "eni-686ea200", 
  source_dest_check: {
    value: false, 
  }, 
})

Request syntax with placeholder values


resp = client.modify_network_interface_attribute({
  ena_srd_specification: {
    ena_srd_enabled: false,
    ena_srd_udp_specification: {
      ena_srd_udp_enabled: false,
    },
  },
  enable_primary_ipv_6: false,
  connection_tracking_specification: {
    tcp_established_timeout: 1,
    udp_stream_timeout: 1,
    udp_timeout: 1,
  },
  associate_public_ip_address: false,
  dry_run: false,
  network_interface_id: "NetworkInterfaceId", # required
  description: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  source_dest_check: {
    value: false,
  },
  groups: ["SecurityGroupId"],
  attachment: {
    attachment_id: "NetworkInterfaceAttachmentId",
    delete_on_termination: false,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ena_srd_specification (Types::EnaSrdSpecification) —

    Updates the ENA Express configuration for the network interface that’s attached to the instance.

  • :enable_primary_ipv_6 (Boolean) —

    If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

  • :connection_tracking_specification (Types::ConnectionTrackingSpecificationRequest) —

    A connection tracking specification.

  • :associate_public_ip_address (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).

  • :dry_run (Boolean) —

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

  • :network_interface_id (required, String) —

    The ID of the network interface.

  • :description (Types::AttributeValue) —

    A description for the network interface.

  • :source_dest_check (Types::AttributeBooleanValue) —

    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.

  • :groups (Array<String>) —

    Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it’s just the default security group in the VPC. You must specify the ID of the security group, not the name.

  • :attachment (Types::NetworkInterfaceAttachmentChanges) —

    Information about the interface attachment. If modifying the ‘delete on termination` attribute, you must specify the ID of the interface attachment.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



49622
49623
49624
49625
 
# File 'lib/aws-sdk-ec2/client.rb', line 49622

def modify_network_interface_attribute(params = {}, options = {})
  req = build_request(:modify_network_interface_attribute, params)
  req.send_request(options)
end

#modify_private_dns_name_options(params = {}) ⇒ Types::ModifyPrivateDnsNameOptionsResult

Modifies the options for instance hostnames for the specified instance.

Examples:

Request syntax with placeholder values


resp = client.modify_private_dns_name_options({
  dry_run: false,
  instance_id: "InstanceId", # required
  private_dns_hostname_type: "ip-name", # accepts ip-name, resource-name
  enable_resource_name_dns_a_record: false,
  enable_resource_name_dns_aaaa_record: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the instance.

  • :private_dns_hostname_type (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.

  • :enable_resource_name_dns_a_record (Boolean) —

    Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

  • :enable_resource_name_dns_aaaa_record (Boolean) —

    Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

Returns:

See Also:



49676
49677
49678
49679
 
# File 'lib/aws-sdk-ec2/client.rb', line 49676

def modify_private_dns_name_options(params = {}, options = {})
  req = build_request(:modify_private_dns_name_options, params)
  req.send_request(options)
end

#modify_reserved_instances(params = {}) ⇒ Types::ModifyReservedInstancesResult

Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see [Modify Reserved Instances] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html

Examples:

Request syntax with placeholder values


resp = client.modify_reserved_instances({
  reserved_instances_ids: ["ReservationId"], # required
  client_token: "String",
  target_configurations: [ # required
    {
      availability_zone: "String",
      instance_count: 1,
      instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
      platform: "String",
      scope: "Availability Zone", # accepts Availability Zone, Region
    },
  ],
})

Response structure


resp.reserved_instances_modification_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



49736
49737
49738
49739
 
# File 'lib/aws-sdk-ec2/client.rb', line 49736

def modify_reserved_instances(params = {}, options = {})
  req = build_request(:modify_reserved_instances, params)
  req.send_request(options)
end

#modify_security_group_rules(params = {}) ⇒ Types::ModifySecurityGroupRulesResult

Modifies the rules of a security group.

Examples:

Request syntax with placeholder values


resp = client.modify_security_group_rules({
  group_id: "SecurityGroupId", # required
  security_group_rules: [ # required
    {
      security_group_rule_id: "SecurityGroupRuleId", # required
      security_group_rule: {
        ip_protocol: "String",
        from_port: 1,
        to_port: 1,
        cidr_ipv_4: "String",
        cidr_ipv_6: "String",
        prefix_list_id: "PrefixListResourceId",
        referenced_group_id: "SecurityGroupId",
        description: "String",
      },
    },
  ],
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_id (required, String) —

    The ID of the security group.

  • :security_group_rules (required, Array<Types::SecurityGroupRuleUpdate>) —

    Information about the security group properties to update.

  • :dry_run (Boolean) —

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

Returns:

See Also:



49789
49790
49791
49792
 
# File 'lib/aws-sdk-ec2/client.rb', line 49789

def modify_security_group_rules(params = {}, options = {})
  req = build_request(:modify_security_group_rules, params)
  req.send_request(options)
end

#modify_snapshot_attribute(params = {}) ⇒ Struct

Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot’s list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

For more information about modifying snapshot permissions, see [Share a snapshot] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-modifying-snapshot-permissions.html

Examples:

Example: To modify a snapshot attribute


# This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the
# account ID ``123456789012``. If the command succeeds, no output is returned.

resp = client.modify_snapshot_attribute({
  attribute: "createVolumePermission", 
  operation_type: "remove", 
  snapshot_id: "snap-1234567890abcdef0", 
  user_ids: [
    "123456789012", 
  ], 
})

resp.to_h outputs the following:
{
}

Example: To make a snapshot public


# This example makes the snapshot ``snap-1234567890abcdef0`` public.

resp = client.modify_snapshot_attribute({
  attribute: "createVolumePermission", 
  group_names: [
    "all", 
  ], 
  operation_type: "add", 
  snapshot_id: "snap-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.modify_snapshot_attribute({
  attribute: "productCodes", # accepts productCodes, createVolumePermission
  create_volume_permission: {
    add: [
      {
        user_id: "String",
        group: "all", # accepts all
      },
    ],
    remove: [
      {
        user_id: "String",
        group: "all", # accepts all
      },
    ],
  },
  group_names: ["SecurityGroupName"],
  operation_type: "add", # accepts add, remove
  snapshot_id: "SnapshotId", # required
  user_ids: ["String"],
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute (String) —

    The snapshot attribute to modify. Only volume creation permissions can be modified.

  • :create_volume_permission (Types::CreateVolumePermissionModifications) —

    A JSON representation of the snapshot attribute modification.

  • :group_names (Array<String>) —

    The group to modify for the snapshot.

  • :operation_type (String) —

    The type of operation to perform to the attribute.

  • :snapshot_id (required, String) —

    The ID of the snapshot.

  • :user_ids (Array<String>) —

    The account ID to modify for the snapshot.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



49904
49905
49906
49907
 
# File 'lib/aws-sdk-ec2/client.rb', line 49904

def modify_snapshot_attribute(params = {}, options = {})
  req = build_request(:modify_snapshot_attribute, params)
  req.send_request(options)
end

#modify_snapshot_tier(params = {}) ⇒ Types::ModifySnapshotTierResult

Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see [Archive Amazon EBS snapshots] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html

Examples:

Request syntax with placeholder values


resp = client.modify_snapshot_tier({
  snapshot_id: "SnapshotId", # required
  storage_tier: "archive", # accepts archive
  dry_run: false,
})

Response structure


resp.snapshot_id #=> String
resp.tiering_start_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The ID of the snapshot.

  • :storage_tier (String) —

    The name of the storage tier. You must specify ‘archive`.

  • :dry_run (Boolean) —

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

Returns:

See Also:



49954
49955
49956
49957
 
# File 'lib/aws-sdk-ec2/client.rb', line 49954

def modify_snapshot_tier(params = {}, options = {})
  req = build_request(:modify_snapshot_tier, params)
  req.send_request(options)
end

#modify_spot_fleet_request(params = {}) ⇒ Types::ModifySpotFleetRequestResponse

Modifies the specified Spot Fleet request.

You can only modify a Spot Fleet request of type ‘maintain`.

While the Spot Fleet request is being modified, it is in the ‘modifying` state.

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is ‘lowestPrice`, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is `diversified`, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is `capacityOptimized`, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is ‘lowestPrice`, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is `capacityOptimized`, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is `diversified`, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.

Examples:

Example: To increase the target capacity of a Spot fleet request


# This example increases the target capacity of the specified Spot fleet request.

resp = client.modify_spot_fleet_request({
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
  target_capacity: 20, 
})

resp.to_h outputs the following:
{
  return: true, 
}

Example: To decrease the target capacity of a Spot fleet request


# This example decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as
# a result.

resp = client.modify_spot_fleet_request({
  excess_capacity_termination_policy: "NoTermination ", 
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
  target_capacity: 10, 
})

resp.to_h outputs the following:
{
  return: true, 
}

Request syntax with placeholder values


resp = client.modify_spot_fleet_request({
  launch_template_configs: [
    {
      launch_template_specification: {
        launch_template_id: "String",
        launch_template_name: "LaunchTemplateName",
        version: "String",
      },
      overrides: [
        {
          instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
          spot_price: "String",
          subnet_id: "SubnetId",
          availability_zone: "String",
          weighted_capacity: 1.0,
          priority: 1.0,
          instance_requirements: {
            v_cpu_count: {
              min: 1,
              max: 1,
            },
            memory_mi_b: {
              min: 1,
              max: 1,
            },
            cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
            memory_gi_b_per_v_cpu: {
              min: 1.0,
              max: 1.0,
            },
            excluded_instance_types: ["ExcludedInstanceType"],
            instance_generations: ["current"], # accepts current, previous
            spot_max_price_percentage_over_lowest_price: 1,
            on_demand_max_price_percentage_over_lowest_price: 1,
            bare_metal: "included", # accepts included, required, excluded
            burstable_performance: "included", # accepts included, required, excluded
            require_hibernate_support: false,
            network_interface_count: {
              min: 1,
              max: 1,
            },
            local_storage: "included", # accepts included, required, excluded
            local_storage_types: ["hdd"], # accepts hdd, ssd
            total_local_storage_gb: {
              min: 1.0,
              max: 1.0,
            },
            baseline_ebs_bandwidth_mbps: {
              min: 1,
              max: 1,
            },
            accelerator_types: ["gpu"], # accepts gpu, fpga, inference
            accelerator_count: {
              min: 1,
              max: 1,
            },
            accelerator_manufacturers: ["amazon-web-services"], # accepts amazon-web-services, amd, nvidia, xilinx, habana
            accelerator_names: ["a100"], # accepts a100, inferentia, k520, k80, m60, radeon-pro-v520, t4, vu9p, v100, a10g, h100, t4g
            accelerator_total_memory_mi_b: {
              min: 1,
              max: 1,
            },
            network_bandwidth_gbps: {
              min: 1.0,
              max: 1.0,
            },
            allowed_instance_types: ["AllowedInstanceType"],
            max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
          },
        },
      ],
    },
  ],
  on_demand_target_capacity: 1,
  context: "String",
  spot_fleet_request_id: "SpotFleetRequestId", # required
  target_capacity: 1,
  excess_capacity_termination_policy: "noTermination", # accepts noTermination, default
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch_template_configs (Array<Types::LaunchTemplateConfig>) —

    The launch template and overrides. You can only use this parameter if you specified a launch template (‘LaunchTemplateConfigs`) in your Spot Fleet request. If you specified `LaunchSpecifications` in your Spot Fleet request, then omit this parameter.

  • :on_demand_target_capacity (Integer) —

    The number of On-Demand Instances in the fleet.

  • :context (String) —

    Reserved.

  • :spot_fleet_request_id (required, String) —

    The ID of the Spot Fleet request.

  • :target_capacity (Integer) —

    The size of the fleet.

  • :excess_capacity_termination_policy (String) —

    Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.

    Supported only for fleets of type ‘maintain`.

Returns:

See Also:



50144
50145
50146
50147
 
# File 'lib/aws-sdk-ec2/client.rb', line 50144

def modify_spot_fleet_request(params = {}, options = {})
  req = build_request(:modify_spot_fleet_request, params)
  req.send_request(options)
end

#modify_subnet_attribute(params = {}) ⇒ Struct

Modifies a subnet attribute. You can only modify one attribute at a time.

Use this action to modify subnets on Amazon Web Services Outposts.

  • To modify a subnet on an Outpost rack, set both ‘MapCustomerOwnedIpOnLaunch` and `CustomerOwnedIpv4Pool`. These two parameters act as a single attribute.

  • To modify a subnet on an Outpost server, set either ‘EnableLniAtDeviceIndex` or `DisableLniAtDeviceIndex`.

For more information about Amazon Web Services Outposts, see the following:

  • Outpost servers][1
  • Outpost racks][2

[1]: docs.aws.amazon.com/outposts/latest/userguide/how-servers-work.html [2]: docs.aws.amazon.com/outposts/latest/userguide/how-racks-work.html

Examples:

Example: To change a subnet’s public IP addressing behavior


# This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP
# address.

resp = client.modify_subnet_attribute({
  map_public_ip_on_launch: {
    value: true, 
  }, 
  subnet_id: "subnet-1a2b3c4d", 
})

Request syntax with placeholder values


resp = client.modify_subnet_attribute({
  assign_ipv_6_address_on_creation: {
    value: false,
  },
  map_public_ip_on_launch: {
    value: false,
  },
  subnet_id: "SubnetId", # required
  map_customer_owned_ip_on_launch: {
    value: false,
  },
  customer_owned_ipv_4_pool: "CoipPoolId",
  enable_dns_64: {
    value: false,
  },
  private_dns_hostname_type_on_launch: "ip-name", # accepts ip-name, resource-name
  enable_resource_name_dns_a_record_on_launch: {
    value: false,
  },
  enable_resource_name_dns_aaaa_record_on_launch: {
    value: false,
  },
  enable_lni_at_device_index: 1,
  disable_lni_at_device_index: {
    value: false,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assign_ipv_6_address_on_creation (Types::AttributeBooleanValue) —

    Specify ‘true` to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that’s created when launching an instance into the subnet (the instance therefore receives an IPv6 address).

    If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it’s created using version ‘2016-11-15` or later of the Amazon EC2 API.

  • :map_public_ip_on_launch (Types::AttributeBooleanValue) —

    Specify ‘true` to indicate that network interfaces attached to instances created in the specified subnet should be assigned 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].

    [1]: aws.amazon.com/vpc/pricing/

  • :subnet_id (required, String) —

    The ID of the subnet.

  • :map_customer_owned_ip_on_launch (Types::AttributeBooleanValue) —

    Specify ‘true` to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.

    When this value is ‘true`, you must specify the customer-owned IP pool using `CustomerOwnedIpv4Pool`.

  • :customer_owned_ipv_4_pool (String) —

    The customer-owned IPv4 address pool associated with the subnet.

    You must set this value when you specify ‘true` for `MapCustomerOwnedIpOnLaunch`.

  • :enable_dns_64 (Types::AttributeBooleanValue) —

    Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

    <note markdown=“1”> You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a ‘0.0.0.0/0` route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64] in the *Amazon VPC User Guide*.

    </note>

    [1]: docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough

  • :private_dns_hostname_type_on_launch (String) —

    The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).

  • :enable_resource_name_dns_a_record_on_launch (Types::AttributeBooleanValue) —

    Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

  • :enable_resource_name_dns_aaaa_record_on_launch (Types::AttributeBooleanValue) —

    Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

  • :enable_lni_at_device_index (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). A local network interface cannot be the primary network interface (eth0).

  • :disable_lni_at_device_index (Types::AttributeBooleanValue) —

    Specify ‘true` to indicate that local network interfaces at the current position should be disabled.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



50305
50306
50307
50308
 
# File 'lib/aws-sdk-ec2/client.rb', line 50305

def modify_subnet_attribute(params = {}, options = {})
  req = build_request(:modify_subnet_attribute, params)
  req.send_request(options)
end

#modify_traffic_mirror_filter_network_services(params = {}) ⇒ Types::ModifyTrafficMirrorFilterNetworkServicesResult

Allows or restricts mirroring network services.

By default, Amazon DNS network services are not eligible for Traffic Mirror. Use ‘AddNetworkServices` to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use `RemoveNetworkServices` to remove the network services from the Traffic Mirror filter.

Examples:

Request syntax with placeholder values


resp = client.modify_traffic_mirror_filter_network_services({
  traffic_mirror_filter_id: "TrafficMirrorFilterId", # required
  add_network_services: ["amazon-dns"], # accepts amazon-dns
  remove_network_services: ["amazon-dns"], # accepts amazon-dns
  dry_run: false,
})

Response structure


resp.traffic_mirror_filter.traffic_mirror_filter_id #=> String
resp.traffic_mirror_filter.ingress_filter_rules #=> Array
resp.traffic_mirror_filter.ingress_filter_rules[0].traffic_mirror_filter_rule_id #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].traffic_mirror_filter_id #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].traffic_direction #=> String, one of "ingress", "egress"
resp.traffic_mirror_filter.ingress_filter_rules[0].rule_number #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].rule_action #=> String, one of "accept", "reject"
resp.traffic_mirror_filter.ingress_filter_rules[0].protocol #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].destination_port_range.from_port #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].destination_port_range.to_port #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].source_port_range.from_port #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].source_port_range.to_port #=> Integer
resp.traffic_mirror_filter.ingress_filter_rules[0].destination_cidr_block #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].source_cidr_block #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].description #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].tags #=> Array
resp.traffic_mirror_filter.ingress_filter_rules[0].tags[0].key #=> String
resp.traffic_mirror_filter.ingress_filter_rules[0].tags[0].value #=> String
resp.traffic_mirror_filter.egress_filter_rules #=> Array
resp.traffic_mirror_filter.egress_filter_rules[0].traffic_mirror_filter_rule_id #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].traffic_mirror_filter_id #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].traffic_direction #=> String, one of "ingress", "egress"
resp.traffic_mirror_filter.egress_filter_rules[0].rule_number #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].rule_action #=> String, one of "accept", "reject"
resp.traffic_mirror_filter.egress_filter_rules[0].protocol #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].destination_port_range.from_port #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].destination_port_range.to_port #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].source_port_range.from_port #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].source_port_range.to_port #=> Integer
resp.traffic_mirror_filter.egress_filter_rules[0].destination_cidr_block #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].source_cidr_block #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].description #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].tags #=> Array
resp.traffic_mirror_filter.egress_filter_rules[0].tags[0].key #=> String
resp.traffic_mirror_filter.egress_filter_rules[0].tags[0].value #=> String
resp.traffic_mirror_filter.network_services #=> Array
resp.traffic_mirror_filter.network_services[0] #=> String, one of "amazon-dns"
resp.traffic_mirror_filter.description #=> String
resp.traffic_mirror_filter.tags #=> Array
resp.traffic_mirror_filter.tags[0].key #=> String
resp.traffic_mirror_filter.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_filter_id (required, String) —

    The ID of the Traffic Mirror filter.

  • :add_network_services (Array<String>) —

    The network service, for example Amazon DNS, that you want to mirror.

  • :remove_network_services (Array<String>) —

    The network service, for example Amazon DNS, that you no longer want to mirror.

  • :dry_run (Boolean) —

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

Returns:

See Also:



50397
50398
50399
50400
 
# File 'lib/aws-sdk-ec2/client.rb', line 50397

def modify_traffic_mirror_filter_network_services(params = {}, options = {})
  req = build_request(:modify_traffic_mirror_filter_network_services, params)
  req.send_request(options)
end

#modify_traffic_mirror_filter_rule(params = {}) ⇒ Types::ModifyTrafficMirrorFilterRuleResult

Modifies the specified Traffic Mirror rule.

‘DestinationCidrBlock` and `SourceCidrBlock` must both be an IPv4 range or an IPv6 range.

Examples:

Request syntax with placeholder values


resp = client.modify_traffic_mirror_filter_rule({
  traffic_mirror_filter_rule_id: "TrafficMirrorFilterRuleIdWithResolver", # required
  traffic_direction: "ingress", # accepts ingress, egress
  rule_number: 1,
  rule_action: "accept", # accepts accept, reject
  destination_port_range: {
    from_port: 1,
    to_port: 1,
  },
  source_port_range: {
    from_port: 1,
    to_port: 1,
  },
  protocol: 1,
  destination_cidr_block: "String",
  source_cidr_block: "String",
  description: "String",
  remove_fields: ["destination-port-range"], # accepts destination-port-range, source-port-range, protocol, description
  dry_run: false,
})

Response structure


resp.traffic_mirror_filter_rule.traffic_mirror_filter_rule_id #=> String
resp.traffic_mirror_filter_rule.traffic_mirror_filter_id #=> String
resp.traffic_mirror_filter_rule.traffic_direction #=> String, one of "ingress", "egress"
resp.traffic_mirror_filter_rule.rule_number #=> Integer
resp.traffic_mirror_filter_rule.rule_action #=> String, one of "accept", "reject"
resp.traffic_mirror_filter_rule.protocol #=> Integer
resp.traffic_mirror_filter_rule.destination_port_range.from_port #=> Integer
resp.traffic_mirror_filter_rule.destination_port_range.to_port #=> Integer
resp.traffic_mirror_filter_rule.source_port_range.from_port #=> Integer
resp.traffic_mirror_filter_rule.source_port_range.to_port #=> Integer
resp.traffic_mirror_filter_rule.destination_cidr_block #=> String
resp.traffic_mirror_filter_rule.source_cidr_block #=> String
resp.traffic_mirror_filter_rule.description #=> String
resp.traffic_mirror_filter_rule.tags #=> Array
resp.traffic_mirror_filter_rule.tags[0].key #=> String
resp.traffic_mirror_filter_rule.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_filter_rule_id (required, String) —

    The ID of the Traffic Mirror rule.

  • :traffic_direction (String) —

    The type of traffic to assign to the rule.

  • :rule_number (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.

  • :rule_action (String) —

    The action to assign to the rule.

  • :destination_port_range (Types::TrafficMirrorPortRangeRequest) —

    The destination ports that are associated with the Traffic Mirror rule.

  • :source_port_range (Types::TrafficMirrorPortRangeRequest) —

    The port range to assign to the Traffic Mirror rule.

  • :protocol (Integer) —

    The protocol, for example TCP, to assign to the Traffic Mirror rule.

  • :destination_cidr_block (String) —

    The destination CIDR block to assign to the Traffic Mirror rule.

  • :source_cidr_block (String) —

    The source CIDR block to assign to the Traffic Mirror rule.

  • :description (String) —

    The description to assign to the Traffic Mirror rule.

  • :remove_fields (Array<String>) —

    The properties that you want to remove from the Traffic Mirror filter rule.

    When you remove a property from a Traffic Mirror filter rule, the property is set to the default.

  • :dry_run (Boolean) —

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

Returns:

See Also:



50503
50504
50505
50506
 
# File 'lib/aws-sdk-ec2/client.rb', line 50503

def modify_traffic_mirror_filter_rule(params = {}, options = {})
  req = build_request(:modify_traffic_mirror_filter_rule, params)
  req.send_request(options)
end

#modify_traffic_mirror_session(params = {}) ⇒ Types::ModifyTrafficMirrorSessionResult

Modifies a Traffic Mirror session.

Examples:

Request syntax with placeholder values


resp = client.modify_traffic_mirror_session({
  traffic_mirror_session_id: "TrafficMirrorSessionId", # required
  traffic_mirror_target_id: "TrafficMirrorTargetId",
  traffic_mirror_filter_id: "TrafficMirrorFilterId",
  packet_length: 1,
  session_number: 1,
  virtual_network_id: 1,
  description: "String",
  remove_fields: ["packet-length"], # accepts packet-length, description, virtual-network-id
  dry_run: false,
})

Response structure


resp.traffic_mirror_session.traffic_mirror_session_id #=> String
resp.traffic_mirror_session.traffic_mirror_target_id #=> String
resp.traffic_mirror_session.traffic_mirror_filter_id #=> String
resp.traffic_mirror_session.network_interface_id #=> String
resp.traffic_mirror_session.owner_id #=> String
resp.traffic_mirror_session.packet_length #=> Integer
resp.traffic_mirror_session.session_number #=> Integer
resp.traffic_mirror_session.virtual_network_id #=> Integer
resp.traffic_mirror_session.description #=> String
resp.traffic_mirror_session.tags #=> Array
resp.traffic_mirror_session.tags[0].key #=> String
resp.traffic_mirror_session.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :traffic_mirror_session_id (required, String) —

    The ID of the Traffic Mirror session.

  • :traffic_mirror_target_id (String) —

    The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

  • :traffic_mirror_filter_id (String) —

    The ID of the Traffic Mirror filter.

  • :packet_length (Integer) —

    The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

    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.

  • :session_number (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.

  • :virtual_network_id (Integer) —

    The virtual network ID of the Traffic Mirror session.

  • :description (String) —

    The description to assign to the Traffic Mirror session.

  • :remove_fields (Array<String>) —

    The properties that you want to remove from the Traffic Mirror session.

    When you remove a property from a Traffic Mirror session, the property is set to the default.

  • :dry_run (Boolean) —

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

Returns:

See Also:



50596
50597
50598
50599
 
# File 'lib/aws-sdk-ec2/client.rb', line 50596

def modify_traffic_mirror_session(params = {}, options = {})
  req = build_request(:modify_traffic_mirror_session, params)
  req.send_request(options)
end

#modify_transit_gateway(params = {}) ⇒ Types::ModifyTransitGatewayResult

Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.

Examples:

Request syntax with placeholder values


resp = client.modify_transit_gateway({
  transit_gateway_id: "TransitGatewayId", # required
  description: "String",
  options: {
    add_transit_gateway_cidr_blocks: ["String"],
    remove_transit_gateway_cidr_blocks: ["String"],
    vpn_ecmp_support: "enable", # accepts enable, disable
    dns_support: "enable", # accepts enable, disable
    security_group_referencing_support: "enable", # accepts enable, disable
    auto_accept_shared_attachments: "enable", # accepts enable, disable
    default_route_table_association: "enable", # accepts enable, disable
    association_default_route_table_id: "TransitGatewayRouteTableId",
    default_route_table_propagation: "enable", # accepts enable, disable
    propagation_default_route_table_id: "TransitGatewayRouteTableId",
    amazon_side_asn: 1,
  },
  dry_run: false,
})

Response structure


resp.transit_gateway.transit_gateway_id #=> String
resp.transit_gateway.transit_gateway_arn #=> String
resp.transit_gateway.state #=> String, one of "pending", "available", "modifying", "deleting", "deleted"
resp.transit_gateway.owner_id #=> String
resp.transit_gateway.description #=> String
resp.transit_gateway.creation_time #=> Time
resp.transit_gateway.options.amazon_side_asn #=> Integer
resp.transit_gateway.options.transit_gateway_cidr_blocks #=> Array
resp.transit_gateway.options.transit_gateway_cidr_blocks[0] #=> String
resp.transit_gateway.options.auto_accept_shared_attachments #=> String, one of "enable", "disable"
resp.transit_gateway.options.default_route_table_association #=> String, one of "enable", "disable"
resp.transit_gateway.options.association_default_route_table_id #=> String
resp.transit_gateway.options.default_route_table_propagation #=> String, one of "enable", "disable"
resp.transit_gateway.options.propagation_default_route_table_id #=> String
resp.transit_gateway.options.vpn_ecmp_support #=> String, one of "enable", "disable"
resp.transit_gateway.options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateway.options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateway.options.multicast_support #=> String, one of "enable", "disable"
resp.transit_gateway.tags #=> Array
resp.transit_gateway.tags[0].key #=> String
resp.transit_gateway.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_id (required, String) —

    The ID of the transit gateway.

  • :description (String) —

    The description for the transit gateway.

  • :options (Types::ModifyTransitGatewayOptions) —

    The options to modify.

  • :dry_run (Boolean) —

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

Returns:

See Also:



50674
50675
50676
50677
 
# File 'lib/aws-sdk-ec2/client.rb', line 50674

def modify_transit_gateway(params = {}, options = {})
  req = build_request(:modify_transit_gateway, params)
  req.send_request(options)
end

#modify_transit_gateway_prefix_list_reference(params = {}) ⇒ Types::ModifyTransitGatewayPrefixListReferenceResult

Modifies a reference (route) to a prefix list in a specified transit gateway route table.

Examples:

Request syntax with placeholder values


resp = client.modify_transit_gateway_prefix_list_reference({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  prefix_list_id: "PrefixListResourceId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId",
  blackhole: false,
  dry_run: false,
})

Response structure


resp.transit_gateway_prefix_list_reference.transit_gateway_route_table_id #=> String
resp.transit_gateway_prefix_list_reference.prefix_list_id #=> String
resp.transit_gateway_prefix_list_reference.prefix_list_owner_id #=> String
resp.transit_gateway_prefix_list_reference.state #=> String, one of "pending", "available", "modifying", "deleting"
resp.transit_gateway_prefix_list_reference.blackhole #=> Boolean
resp.transit_gateway_prefix_list_reference.transit_gateway_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_prefix_list_reference.transit_gateway_attachment.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.transit_gateway_prefix_list_reference.transit_gateway_attachment.resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :prefix_list_id (required, String) —

    The ID of the prefix list.

  • :transit_gateway_attachment_id (String) —

    The ID of the attachment to which traffic is routed.

  • :blackhole (Boolean) —

    Indicates whether to drop traffic that matches this route.

  • :dry_run (Boolean) —

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

Returns:

See Also:



50729
50730
50731
50732
 
# File 'lib/aws-sdk-ec2/client.rb', line 50729

def modify_transit_gateway_prefix_list_reference(params = {}, options = {})
  req = build_request(:modify_transit_gateway_prefix_list_reference, params)
  req.send_request(options)
end

#modify_transit_gateway_vpc_attachment(params = {}) ⇒ Types::ModifyTransitGatewayVpcAttachmentResult

Modifies the specified VPC attachment.

Examples:

Request syntax with placeholder values


resp = client.modify_transit_gateway_vpc_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  add_subnet_ids: ["SubnetId"],
  remove_subnet_ids: ["SubnetId"],
  options: {
    dns_support: "enable", # accepts enable, disable
    security_group_referencing_support: "enable", # accepts enable, disable
    ipv_6_support: "enable", # accepts enable, disable
    appliance_mode_support: "enable", # accepts enable, disable
  },
  dry_run: false,
})

Response structure


resp.transit_gateway_vpc_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_vpc_attachment.transit_gateway_id #=> String
resp.transit_gateway_vpc_attachment.vpc_id #=> String
resp.transit_gateway_vpc_attachment.vpc_owner_id #=> String
resp.transit_gateway_vpc_attachment.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_vpc_attachment.subnet_ids #=> Array
resp.transit_gateway_vpc_attachment.subnet_ids[0] #=> String
resp.transit_gateway_vpc_attachment.creation_time #=> Time
resp.transit_gateway_vpc_attachment.options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.ipv_6_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.appliance_mode_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.tags #=> Array
resp.transit_gateway_vpc_attachment.tags[0].key #=> String
resp.transit_gateway_vpc_attachment.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the attachment.

  • :add_subnet_ids (Array<String>) —

    The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.

  • :remove_subnet_ids (Array<String>) —

    The IDs of one or more subnets to remove.

  • :options (Types::ModifyTransitGatewayVpcAttachmentRequestOptions) —

    The new VPC attachment options.

  • :dry_run (Boolean) —

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

Returns:

See Also:



50796
50797
50798
50799
 
# File 'lib/aws-sdk-ec2/client.rb', line 50796

def modify_transit_gateway_vpc_attachment(params = {}, options = {})
  req = build_request(:modify_transit_gateway_vpc_attachment, params)
  req.send_request(options)
end

#modify_verified_access_endpoint(params = {}) ⇒ Types::ModifyVerifiedAccessEndpointResult

Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.

Examples:

Request syntax with placeholder values


resp = client.modify_verified_access_endpoint({
  verified_access_endpoint_id: "VerifiedAccessEndpointId", # required
  verified_access_group_id: "VerifiedAccessGroupId",
  load_balancer_options: {
    subnet_ids: ["SubnetId"],
    protocol: "http", # accepts http, https
    port: 1,
  },
  network_interface_options: {
    protocol: "http", # accepts http, https
    port: 1,
  },
  description: "String",
  client_token: "String",
  dry_run: false,
})

Response structure


resp.verified_access_endpoint.verified_access_instance_id #=> String
resp.verified_access_endpoint.verified_access_group_id #=> String
resp.verified_access_endpoint.verified_access_endpoint_id #=> String
resp.verified_access_endpoint.application_domain #=> String
resp.verified_access_endpoint.endpoint_type #=> String, one of "load-balancer", "network-interface"
resp.verified_access_endpoint.attachment_type #=> String, one of "vpc"
resp.verified_access_endpoint.domain_certificate_arn #=> String
resp.verified_access_endpoint.endpoint_domain #=> String
resp.verified_access_endpoint.device_validation_domain #=> String
resp.verified_access_endpoint.security_group_ids #=> Array
resp.verified_access_endpoint.security_group_ids[0] #=> String
resp.verified_access_endpoint.load_balancer_options.protocol #=> String, one of "http", "https"
resp.verified_access_endpoint.load_balancer_options.port #=> Integer
resp.verified_access_endpoint.load_balancer_options.load_balancer_arn #=> String
resp.verified_access_endpoint.load_balancer_options.subnet_ids #=> Array
resp.verified_access_endpoint.load_balancer_options.subnet_ids[0] #=> String
resp.verified_access_endpoint.network_interface_options.network_interface_id #=> String
resp.verified_access_endpoint.network_interface_options.protocol #=> String, one of "http", "https"
resp.verified_access_endpoint.network_interface_options.port #=> Integer
resp.verified_access_endpoint.status.code #=> String, one of "pending", "active", "updating", "deleting", "deleted"
resp.verified_access_endpoint.status.message #=> String
resp.verified_access_endpoint.description #=> String
resp.verified_access_endpoint.creation_time #=> String
resp.verified_access_endpoint.last_updated_time #=> String
resp.verified_access_endpoint.deletion_time #=> String
resp.verified_access_endpoint.tags #=> Array
resp.verified_access_endpoint.tags[0].key #=> String
resp.verified_access_endpoint.tags[0].value #=> String
resp.verified_access_endpoint.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_endpoint.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_endpoint_id (required, String) —

    The ID of the Verified Access endpoint.

  • :verified_access_group_id (String) —

    The ID of the Verified Access group.

  • :load_balancer_options (Types::ModifyVerifiedAccessEndpointLoadBalancerOptions) —

    The load balancer details if creating the Verified Access endpoint as ‘load-balancer`type.

  • :network_interface_options (Types::ModifyVerifiedAccessEndpointEniOptions) —

    The network interface options.

  • :description (String) —

    A description for the Verified Access endpoint.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



50898
50899
50900
50901
 
# File 'lib/aws-sdk-ec2/client.rb', line 50898

def modify_verified_access_endpoint(params = {}, options = {})
  req = build_request(:modify_verified_access_endpoint, params)
  req.send_request(options)
end

#modify_verified_access_endpoint_policy(params = {}) ⇒ Types::ModifyVerifiedAccessEndpointPolicyResult

Modifies the specified Amazon Web Services Verified Access endpoint policy.

Examples:

Request syntax with placeholder values


resp = client.modify_verified_access_endpoint_policy({
  verified_access_endpoint_id: "VerifiedAccessEndpointId", # required
  policy_enabled: false,
  policy_document: "String",
  client_token: "String",
  dry_run: false,
  sse_specification: {
    customer_managed_key_enabled: false,
    kms_key_arn: "KmsKeyArn",
  },
})

Response structure


resp.policy_enabled #=> Boolean
resp.policy_document #=> String
resp.sse_specification.customer_managed_key_enabled #=> Boolean
resp.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_endpoint_id (required, String) —

    The ID of the Verified Access endpoint.

  • :policy_enabled (Boolean) —

    The status of the Verified Access policy.

  • :policy_document (String) —

    The Verified Access policy document.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :sse_specification (Types::VerifiedAccessSseSpecificationRequest) —

    The options for server side encryption.

Returns:

See Also:



50967
50968
50969
50970
 
# File 'lib/aws-sdk-ec2/client.rb', line 50967

def modify_verified_access_endpoint_policy(params = {}, options = {})
  req = build_request(:modify_verified_access_endpoint_policy, params)
  req.send_request(options)
end

#modify_verified_access_group(params = {}) ⇒ Types::ModifyVerifiedAccessGroupResult

Modifies the specified Amazon Web Services Verified Access group configuration.

Examples:

Request syntax with placeholder values


resp = client.modify_verified_access_group({
  verified_access_group_id: "VerifiedAccessGroupId", # required
  verified_access_instance_id: "VerifiedAccessInstanceId",
  description: "String",
  client_token: "String",
  dry_run: false,
})

Response structure


resp.verified_access_group.verified_access_group_id #=> String
resp.verified_access_group.verified_access_instance_id #=> String
resp.verified_access_group.description #=> String
resp.verified_access_group.owner #=> String
resp.verified_access_group.verified_access_group_arn #=> String
resp.verified_access_group.creation_time #=> String
resp.verified_access_group.last_updated_time #=> String
resp.verified_access_group.deletion_time #=> String
resp.verified_access_group.tags #=> Array
resp.verified_access_group.tags[0].key #=> String
resp.verified_access_group.tags[0].value #=> String
resp.verified_access_group.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_group.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_group_id (required, String) —

    The ID of the Verified Access group.

  • :verified_access_instance_id (String) —

    The ID of the Verified Access instance.

  • :description (String) —

    A description for the Verified Access group.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

Returns:

See Also:



51036
51037
51038
51039
 
# File 'lib/aws-sdk-ec2/client.rb', line 51036

def modify_verified_access_group(params = {}, options = {})
  req = build_request(:modify_verified_access_group, params)
  req.send_request(options)
end

#modify_verified_access_group_policy(params = {}) ⇒ Types::ModifyVerifiedAccessGroupPolicyResult

Modifies the specified Amazon Web Services Verified Access group policy.

Examples:

Request syntax with placeholder values


resp = client.modify_verified_access_group_policy({
  verified_access_group_id: "VerifiedAccessGroupId", # required
  policy_enabled: false,
  policy_document: "String",
  client_token: "String",
  dry_run: false,
  sse_specification: {
    customer_managed_key_enabled: false,
    kms_key_arn: "KmsKeyArn",
  },
})

Response structure


resp.policy_enabled #=> Boolean
resp.policy_document #=> String
resp.sse_specification.customer_managed_key_enabled #=> Boolean
resp.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_group_id (required, String) —

    The ID of the Verified Access group.

  • :policy_enabled (Boolean) —

    The status of the Verified Access policy.

  • :policy_document (String) —

    The Verified Access policy document.

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :dry_run (Boolean) —

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

  • :sse_specification (Types::VerifiedAccessSseSpecificationRequest) —

    The options for server side encryption.

Returns:

See Also:



51105
51106
51107
51108
 
# File 'lib/aws-sdk-ec2/client.rb', line 51105

def modify_verified_access_group_policy(params = {}, options = {})
  req = build_request(:modify_verified_access_group_policy, params)
  req.send_request(options)
end

#modify_verified_access_instance(params = {}) ⇒ Types::ModifyVerifiedAccessInstanceResult

Modifies the configuration of the specified Amazon Web Services Verified Access instance.

Examples:

Request syntax with placeholder values


resp = client.modify_verified_access_instance({
  verified_access_instance_id: "VerifiedAccessInstanceId", # required
  description: "String",
  dry_run: false,
  client_token: "String",
})

Response structure


resp.verified_access_instance.verified_access_instance_id #=> String
resp.verified_access_instance.description #=> String
resp.verified_access_instance.verified_access_trust_providers #=> Array
resp.verified_access_instance.verified_access_trust_providers[0].verified_access_trust_provider_id #=> String
resp.verified_access_instance.verified_access_trust_providers[0].description #=> String
resp.verified_access_instance.verified_access_trust_providers[0].trust_provider_type #=> String, one of "user", "device"
resp.verified_access_instance.verified_access_trust_providers[0].user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_instance.verified_access_trust_providers[0].device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_instance.creation_time #=> String
resp.verified_access_instance.last_updated_time #=> String
resp.verified_access_instance.tags #=> Array
resp.verified_access_instance.tags[0].key #=> String
resp.verified_access_instance.tags[0].value #=> String
resp.verified_access_instance.fips_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_instance_id (required, String) —

    The ID of the Verified Access instance.

  • :description (String) —

    A description for the Verified Access instance.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



51171
51172
51173
51174
 
# File 'lib/aws-sdk-ec2/client.rb', line 51171

def modify_verified_access_instance(params = {}, options = {})
  req = build_request(:modify_verified_access_instance, params)
  req.send_request(options)
end

#modify_verified_access_instance_logging_configuration(params = {}) ⇒ Types::ModifyVerifiedAccessInstanceLoggingConfigurationResult

Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.

Examples:

Request syntax with placeholder values


resp = client.modify_verified_access_instance_logging_configuration({
  verified_access_instance_id: "VerifiedAccessInstanceId", # required
  access_logs: { # required
    s3: {
      enabled: false, # required
      bucket_name: "String",
      prefix: "String",
      bucket_owner: "String",
    },
    cloud_watch_logs: {
      enabled: false, # required
      log_group: "String",
    },
    kinesis_data_firehose: {
      enabled: false, # required
      delivery_stream: "String",
    },
    log_version: "String",
    include_trust_context: false,
  },
  dry_run: false,
  client_token: "String",
})

Response structure


resp.logging_configuration.verified_access_instance_id #=> String
resp.logging_configuration.access_logs.s3.enabled #=> Boolean
resp.logging_configuration.access_logs.s3.delivery_status.code #=> String, one of "success", "failed"
resp.logging_configuration.access_logs.s3.delivery_status.message #=> String
resp.logging_configuration.access_logs.s3.bucket_name #=> String
resp.logging_configuration.access_logs.s3.prefix #=> String
resp.logging_configuration.access_logs.s3.bucket_owner #=> String
resp.logging_configuration.access_logs.cloud_watch_logs.enabled #=> Boolean
resp.logging_configuration.access_logs.cloud_watch_logs.delivery_status.code #=> String, one of "success", "failed"
resp.logging_configuration.access_logs.cloud_watch_logs.delivery_status.message #=> String
resp.logging_configuration.access_logs.cloud_watch_logs.log_group #=> String
resp.logging_configuration.access_logs.kinesis_data_firehose.enabled #=> Boolean
resp.logging_configuration.access_logs.kinesis_data_firehose.delivery_status.code #=> String, one of "success", "failed"
resp.logging_configuration.access_logs.kinesis_data_firehose.delivery_status.message #=> String
resp.logging_configuration.access_logs.kinesis_data_firehose.delivery_stream #=> String
resp.logging_configuration.access_logs.log_version #=> String
resp.logging_configuration.access_logs.include_trust_context #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_instance_id (required, String) —

    The ID of the Verified Access instance.

  • :access_logs (required, Types::VerifiedAccessLogOptions) —

    The configuration options for Verified Access instances.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



51257
51258
51259
51260
 
# File 'lib/aws-sdk-ec2/client.rb', line 51257

def modify_verified_access_instance_logging_configuration(params = {}, options = {})
  req = build_request(:modify_verified_access_instance_logging_configuration, params)
  req.send_request(options)
end

#modify_verified_access_trust_provider(params = {}) ⇒ Types::ModifyVerifiedAccessTrustProviderResult

Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.

Examples:

Request syntax with placeholder values


resp = client.modify_verified_access_trust_provider({
  verified_access_trust_provider_id: "VerifiedAccessTrustProviderId", # required
  oidc_options: {
    issuer: "String",
    authorization_endpoint: "String",
    token_endpoint: "String",
    user_info_endpoint: "String",
    client_id: "String",
    client_secret: "ClientSecretType",
    scope: "String",
  },
  device_options: {
    public_signing_key_url: "String",
  },
  description: "String",
  dry_run: false,
  client_token: "String",
  sse_specification: {
    customer_managed_key_enabled: false,
    kms_key_arn: "KmsKeyArn",
  },
})

Response structure


resp.verified_access_trust_provider.verified_access_trust_provider_id #=> String
resp.verified_access_trust_provider.description #=> String
resp.verified_access_trust_provider.trust_provider_type #=> String, one of "user", "device"
resp.verified_access_trust_provider.user_trust_provider_type #=> String, one of "iam-identity-center", "oidc"
resp.verified_access_trust_provider.device_trust_provider_type #=> String, one of "jamf", "crowdstrike", "jumpcloud"
resp.verified_access_trust_provider.oidc_options.issuer #=> String
resp.verified_access_trust_provider.oidc_options.authorization_endpoint #=> String
resp.verified_access_trust_provider.oidc_options.token_endpoint #=> String
resp.verified_access_trust_provider.oidc_options. #=> String
resp.verified_access_trust_provider.oidc_options.client_id #=> String
resp.verified_access_trust_provider.oidc_options.client_secret #=> String
resp.verified_access_trust_provider.oidc_options.scope #=> String
resp.verified_access_trust_provider.device_options.tenant_id #=> String
resp.verified_access_trust_provider.device_options.public_signing_key_url #=> String
resp.verified_access_trust_provider.policy_reference_name #=> String
resp.verified_access_trust_provider.creation_time #=> String
resp.verified_access_trust_provider.last_updated_time #=> String
resp.verified_access_trust_provider.tags #=> Array
resp.verified_access_trust_provider.tags[0].key #=> String
resp.verified_access_trust_provider.tags[0].value #=> String
resp.verified_access_trust_provider.sse_specification.customer_managed_key_enabled #=> Boolean
resp.verified_access_trust_provider.sse_specification.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verified_access_trust_provider_id (required, String) —

    The ID of the Verified Access trust provider.

  • :oidc_options (Types::ModifyVerifiedAccessTrustProviderOidcOptions) —

    The options for an OpenID Connect-compatible user-identity trust provider.

  • :device_options (Types::ModifyVerifiedAccessTrustProviderDeviceOptions) —

    The options for a device-based trust provider. This parameter is required when the provider type is ‘device`.

  • :description (String) —

    A description for the Verified Access trust provider.

  • :dry_run (Boolean) —

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

  • :client_token (String) —

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :sse_specification (Types::VerifiedAccessSseSpecificationRequest) —

    The options for server side encryption.

Returns:

See Also:



51358
51359
51360
51361
 
# File 'lib/aws-sdk-ec2/client.rb', line 51358

def modify_verified_access_trust_provider(params = {}, options = {})
  req = build_request(:modify_verified_access_trust_provider, params)
  req.send_request(options)
end

#modify_volume(params = {}) ⇒ Types::ModifyVolumeResult

You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see

Amazon EBS Elastic Volumes][1

in the *Amazon EBS User Guide*.

When you complete a resize operation on your volume, you need to extend the volume’s file-system size to take advantage of the new storage capacity. For more information, see [Extend the file system].

For more information, see [Monitor the progress of volume modifications] in the *Amazon EBS User Guide*.

With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.

After modifying a volume, you must wait at least six hours and ensure that the volume is in the ‘in-use` or `available` state before you can modify the same volume. This is sometimes referred to as a cooldown period.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-modify-volume.html [2]: docs.aws.amazon.com/ebs/latest/userguide/recognize-expanded-volume-linux.html [3]: docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html

Examples:

Request syntax with placeholder values


resp = client.modify_volume({
  dry_run: false,
  volume_id: "VolumeId", # required
  size: 1,
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
  iops: 1,
  throughput: 1,
  multi_attach_enabled: false,
})

Response structure


resp.volume_modification.volume_id #=> String
resp.volume_modification.modification_state #=> String, one of "modifying", "optimizing", "completed", "failed"
resp.volume_modification.status_message #=> String
resp.volume_modification.target_size #=> Integer
resp.volume_modification.target_iops #=> Integer
resp.volume_modification.target_volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.volume_modification.target_throughput #=> Integer
resp.volume_modification.target_multi_attach_enabled #=> Boolean
resp.volume_modification.original_size #=> Integer
resp.volume_modification.original_iops #=> Integer
resp.volume_modification.original_volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.volume_modification.original_throughput #=> Integer
resp.volume_modification.original_multi_attach_enabled #=> Boolean
resp.volume_modification.progress #=> Integer
resp.volume_modification.start_time #=> Time
resp.volume_modification.end_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :volume_id (required, String) —

    The ID of the volume.

  • :size (Integer) —

    The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

    The following are the supported volumes sizes for each volume type:

    • ‘gp2` and `gp3`: 1 - 16,384 GiB

    • ‘io1`: 4 - 16,384 GiB

    • ‘io2`: 4 - 65,536 GiB

    • ‘st1` and `sc1`: 125 - 16,384 GiB

    • ‘standard`: 1 - 1024 GiB

    Default: The existing size is retained.

  • :volume_type (String) —

    The target EBS volume type of the volume. For more information, see

    Amazon EBS volume types][1

    in the *Amazon EBS User Guide*.

    Default: The existing type is retained.

    [1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html

  • :iops (Integer) —

    The target IOPS rate of the volume. This parameter is valid only for ‘gp3`, `io1`, and `io2` volumes.

    The following are the supported values for each volume type:

    • ‘gp3`: 3,000 - 16,000 IOPS

    • ‘io1`: 100 - 64,000 IOPS

    • ‘io2`: 100 - 256,000 IOPS

    For ‘io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System]. On other instances, you can achieve performance up to 32,000 IOPS.

    Default: The existing value is retained if you keep the same volume type. If you change the volume type to ‘io1`, `io2`, or `gp3`, the default is 3,000.

    [1]: docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html

  • :throughput (Integer) —

    The target throughput of the volume, in MiB/s. This parameter is valid only for ‘gp3` volumes. The maximum value is 1,000.

    Default: The existing value is retained if the source and target volume type is ‘gp3`. Otherwise, the default value is 125.

    Valid Range: Minimum value of 125. Maximum value of 1000.

  • :multi_attach_enabled (Boolean) —

    Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 [ Nitro-based instances] in the same Availability Zone. This parameter is supported with ‘io1` and `io2` volumes only. For more information, see

    Amazon EBS Multi-Attach][2

    in the *Amazon EBS User Guide*.

    [1]: docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html [2]: docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html

Returns:

See Also:



51514
51515
51516
51517
 
# File 'lib/aws-sdk-ec2/client.rb', line 51514

def modify_volume(params = {}, options = {})
  req = build_request(:modify_volume, params)
  req.send_request(options)
end

#modify_volume_attribute(params = {}) ⇒ Struct

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

Examples:

Example: To modify a volume attribute


# This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the
# command succeeds, no output is returned.

resp = client.modify_volume_attribute({
  auto_enable_io: {
    value: true, 
  }, 
  dry_run: true, 
  volume_id: "vol-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.modify_volume_attribute({
  auto_enable_io: {
    value: false,
  },
  volume_id: "VolumeId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_enable_io (Types::AttributeBooleanValue) —

    Indicates whether the volume should be auto-enabled for I/O operations.

  • :volume_id (required, String) —

    The ID of the volume.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



51578
51579
51580
51581
 
# File 'lib/aws-sdk-ec2/client.rb', line 51578

def modify_volume_attribute(params = {}, options = {})
  req = build_request(:modify_volume_attribute, params)
  req.send_request(options)
end

#modify_vpc_attribute(params = {}) ⇒ Struct

Modifies the specified attribute of the specified VPC.

Examples:

Example: To modify the enableDnsSupport attribute


# This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the
# VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their
# corresponding IP addresses; otherwise, it does not.

resp = client.modify_vpc_attribute({
  enable_dns_support: {
    value: false, 
  }, 
  vpc_id: "vpc-a01106c2", 
})

Example: To modify the enableDnsHostnames attribute


# This example modifies the enableDnsHostnames attribute. This attribute indicates whether instances launched in the VPC
# get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

resp = client.modify_vpc_attribute({
  enable_dns_hostnames: {
    value: false, 
  }, 
  vpc_id: "vpc-a01106c2", 
})

Request syntax with placeholder values


resp = client.modify_vpc_attribute({
  enable_dns_hostnames: {
    value: false,
  },
  enable_dns_support: {
    value: false,
  },
  vpc_id: "VpcId", # required
  enable_network_address_usage_metrics: {
    value: false,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enable_dns_hostnames (Types::AttributeBooleanValue) —

    Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

    You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you’ve enabled DNS support.

  • :enable_dns_support (Types::AttributeBooleanValue) —

    Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range “plus two” succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

    You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :enable_network_address_usage_metrics (Types::AttributeBooleanValue) —

    Indicates whether Network Address Usage metrics are enabled for your VPC.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



51659
51660
51661
51662
 
# File 'lib/aws-sdk-ec2/client.rb', line 51659

def modify_vpc_attribute(params = {}, options = {})
  req = build_request(:modify_vpc_attribute, params)
  req.send_request(options)
end

#modify_vpc_endpoint(params = {}) ⇒ Types::ModifyVpcEndpointResult

Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the [Amazon Web Services PrivateLink Guide].

[1]: docs.aws.amazon.com/vpc/latest/privatelink/

Examples:

Request syntax with placeholder values


resp = client.modify_vpc_endpoint({
  dry_run: false,
  vpc_endpoint_id: "VpcEndpointId", # required
  reset_policy: false,
  policy_document: "String",
  add_route_table_ids: ["RouteTableId"],
  remove_route_table_ids: ["RouteTableId"],
  add_subnet_ids: ["SubnetId"],
  remove_subnet_ids: ["SubnetId"],
  add_security_group_ids: ["SecurityGroupId"],
  remove_security_group_ids: ["SecurityGroupId"],
  ip_address_type: "ipv4", # accepts ipv4, dualstack, ipv6
  dns_options: {
    dns_record_ip_type: "ipv4", # accepts ipv4, dualstack, ipv6, service-defined
    private_dns_only_for_inbound_resolver_endpoint: false,
  },
  private_dns_enabled: false,
  subnet_configurations: [
    {
      subnet_id: "SubnetId",
      ipv_4: "String",
      ipv_6: "String",
    },
  ],
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_endpoint_id (required, String) —

    The ID of the endpoint.

  • :reset_policy (Boolean) — default: Gateway endpoint —

    Specify ‘true` to reset the policy document to the default policy. The default policy allows full access to the service.

  • :policy_document (String) — default: 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.

  • :add_route_table_ids (Array<String>) — default: Gateway endpoint —

    The IDs of the route tables to associate with the endpoint.

  • :remove_route_table_ids (Array<String>) — default: Gateway endpoint —

    The IDs of the route tables to disassociate from the endpoint.

  • :add_subnet_ids (Array<String>) — default: Interface and Gateway Load Balancer endpoints —

    The IDs of the subnets in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

  • :remove_subnet_ids (Array<String>) — default: Interface endpoint —

    The IDs of the subnets from which to remove the endpoint.

  • :add_security_group_ids (Array<String>) — default: Interface endpoint —

    The IDs of the security groups to associate with the endpoint network interfaces.

  • :remove_security_group_ids (Array<String>) — default: Interface endpoint —

    The IDs of the security groups to disassociate from the endpoint network interfaces.

  • :ip_address_type (String) —

    The IP address type for the endpoint.

  • :dns_options (Types::DnsOptionsSpecification) —

    The DNS options for the endpoint.

  • :private_dns_enabled (Boolean) — default: Interface endpoint —

    Indicates whether a private hosted zone is associated with the VPC.

  • :subnet_configurations (Array<Types::SubnetConfiguration>) —

    The subnet configurations for the endpoint.

Returns:

See Also:



51769
51770
51771
51772
 
# File 'lib/aws-sdk-ec2/client.rb', line 51769

def modify_vpc_endpoint(params = {}, options = {})
  req = build_request(:modify_vpc_endpoint, params)
  req.send_request(options)
end

#modify_vpc_endpoint_connection_notification(params = {}) ⇒ Types::ModifyVpcEndpointConnectionNotificationResult

Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.

Examples:

Request syntax with placeholder values


resp = client.modify_vpc_endpoint_connection_notification({
  dry_run: false,
  connection_notification_id: "ConnectionNotificationId", # required
  connection_notification_arn: "String",
  connection_events: ["String"],
})

Response structure


resp.return_value #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :connection_notification_id (required, String) —

    The ID of the notification.

  • :connection_notification_arn (String) —

    The ARN for the SNS topic for the notification.

  • :connection_events (Array<String>) —

    The events for the endpoint. Valid values are ‘Accept`, `Connect`, `Delete`, and `Reject`.

Returns:

See Also:



51815
51816
51817
51818
 
# File 'lib/aws-sdk-ec2/client.rb', line 51815

def modify_vpc_endpoint_connection_notification(params = {}, options = {})
  req = build_request(:modify_vpc_endpoint_connection_notification, params)
  req.send_request(options)
end

#modify_vpc_endpoint_service_configuration(params = {}) ⇒ Types::ModifyVpcEndpointServiceConfigurationResult

Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.

If you set or modify the private DNS name, you must prove that you own the private DNS domain name.

Examples:

Request syntax with placeholder values


resp = client.modify_vpc_endpoint_service_configuration({
  dry_run: false,
  service_id: "VpcEndpointServiceId", # required
  private_dns_name: "String",
  remove_private_dns_name: false,
  acceptance_required: false,
  add_network_load_balancer_arns: ["String"],
  remove_network_load_balancer_arns: ["String"],
  add_gateway_load_balancer_arns: ["String"],
  remove_gateway_load_balancer_arns: ["String"],
  add_supported_ip_address_types: ["String"],
  remove_supported_ip_address_types: ["String"],
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_id (required, String) —

    The ID of the service.

  • :private_dns_name (String) — default: Interface endpoint configuration —

    The private DNS name to assign to the endpoint service.

  • :remove_private_dns_name (Boolean) — default: Interface endpoint configuration —

    Removes the private DNS name of the endpoint service.

  • :acceptance_required (Boolean) —

    Indicates whether requests to create an endpoint to your service must be accepted.

  • :add_network_load_balancer_arns (Array<String>) —

    The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.

  • :remove_network_load_balancer_arns (Array<String>) —

    The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.

  • :add_gateway_load_balancer_arns (Array<String>) —

    The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.

  • :remove_gateway_load_balancer_arns (Array<String>) —

    The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.

  • :add_supported_ip_address_types (Array<String>) —

    The IP address types to add to your service configuration.

  • :remove_supported_ip_address_types (Array<String>) —

    The IP address types to remove from your service configuration.

Returns:

See Also:



51900
51901
51902
51903
 
# File 'lib/aws-sdk-ec2/client.rb', line 51900

def modify_vpc_endpoint_service_configuration(params = {}, options = {})
  req = build_request(:modify_vpc_endpoint_service_configuration, params)
  req.send_request(options)
end

#modify_vpc_endpoint_service_payer_responsibility(params = {}) ⇒ Types::ModifyVpcEndpointServicePayerResponsibilityResult

Modifies the payer responsibility for your VPC endpoint service.

Examples:

Request syntax with placeholder values


resp = client.modify_vpc_endpoint_service_payer_responsibility({
  dry_run: false,
  service_id: "VpcEndpointServiceId", # required
  payer_responsibility: "ServiceOwner", # required, accepts ServiceOwner
})

Response structure


resp.return_value #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_id (required, String) —

    The ID of the service.

  • :payer_responsibility (required, String) —

    The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.

Returns:

See Also:



51941
51942
51943
51944
 
# File 'lib/aws-sdk-ec2/client.rb', line 51941

def modify_vpc_endpoint_service_payer_responsibility(params = {}, options = {})
  req = build_request(:modify_vpc_endpoint_service_payer_responsibility, params)
  req.send_request(options)
end

#modify_vpc_endpoint_service_permissions(params = {}) ⇒ Types::ModifyVpcEndpointServicePermissionsResult

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

Examples:

Request syntax with placeholder values


resp = client.modify_vpc_endpoint_service_permissions({
  dry_run: false,
  service_id: "VpcEndpointServiceId", # required
  add_allowed_principals: ["String"],
  remove_allowed_principals: ["String"],
})

Response structure


resp.added_principals #=> Array
resp.added_principals[0].principal_type #=> String, one of "All", "Service", "OrganizationUnit", "Account", "User", "Role"
resp.added_principals[0].principal #=> String
resp.added_principals[0].service_permission_id #=> String
resp.added_principals[0].service_id #=> String
resp.return_value #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_id (required, String) —

    The ID of the service.

  • :add_allowed_principals (Array<String>) —

    The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).

  • :remove_allowed_principals (Array<String>) —

    The Amazon Resource Names (ARN) of the principals. Permissions are revoked for principals in this list.

Returns:

See Also:



52000
52001
52002
52003
 
# File 'lib/aws-sdk-ec2/client.rb', line 52000

def modify_vpc_endpoint_service_permissions(params = {}, options = {})
  req = build_request(:modify_vpc_endpoint_service_permissions, params)
  req.send_request(options)
end

#modify_vpc_peering_connection_options(params = {}) ⇒ Types::ModifyVpcPeeringConnectionOptionsResult

Modifies the VPC peering connection options on one side of a VPC peering connection.

If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

Examples:

Request syntax with placeholder values


resp = client.modify_vpc_peering_connection_options({
  accepter_peering_connection_options: {
    allow_dns_resolution_from_remote_vpc: false,
    allow_egress_from_local_classic_link_to_remote_vpc: false,
    allow_egress_from_local_vpc_to_remote_classic_link: false,
  },
  dry_run: false,
  requester_peering_connection_options: {
    allow_dns_resolution_from_remote_vpc: false,
    allow_egress_from_local_classic_link_to_remote_vpc: false,
    allow_egress_from_local_vpc_to_remote_classic_link: false,
  },
  vpc_peering_connection_id: "VpcPeeringConnectionId", # required
})

Response structure


resp.accepter_peering_connection_options.allow_dns_resolution_from_remote_vpc #=> Boolean
resp.accepter_peering_connection_options.allow_egress_from_local_classic_link_to_remote_vpc #=> Boolean
resp.accepter_peering_connection_options.allow_egress_from_local_vpc_to_remote_classic_link #=> Boolean
resp.requester_peering_connection_options.allow_dns_resolution_from_remote_vpc #=> Boolean
resp.requester_peering_connection_options.allow_egress_from_local_classic_link_to_remote_vpc #=> Boolean
resp.requester_peering_connection_options.allow_egress_from_local_vpc_to_remote_classic_link #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accepter_peering_connection_options (Types::PeeringConnectionOptionsRequest) —

    The VPC peering connection options for the accepter VPC.

  • :dry_run (Boolean) —

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

  • :requester_peering_connection_options (Types::PeeringConnectionOptionsRequest) —

    The VPC peering connection options for the requester VPC.

  • :vpc_peering_connection_id (required, String) —

    The ID of the VPC peering connection.

Returns:

See Also:



52072
52073
52074
52075
 
# File 'lib/aws-sdk-ec2/client.rb', line 52072

def modify_vpc_peering_connection_options(params = {}, options = {})
  req = build_request(:modify_vpc_peering_connection_options, params)
  req.send_request(options)
end

#modify_vpc_tenancy(params = {}) ⇒ Types::ModifyVpcTenancyResult

Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to ‘default` only. You cannot change the instance tenancy attribute to `dedicated`.

After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of ‘default`, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.

For more information, see [Dedicated Instances] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html

Examples:

Request syntax with placeholder values


resp = client.modify_vpc_tenancy({
  vpc_id: "VpcId", # required
  instance_tenancy: "default", # required, accepts default
  dry_run: false,
})

Response structure


resp.return_value #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    The ID of the VPC.

  • :instance_tenancy (required, String) —

    The instance tenancy attribute for the VPC.

  • :dry_run (Boolean) —

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

Returns:

See Also:



52125
52126
52127
52128
 
# File 'lib/aws-sdk-ec2/client.rb', line 52125

def modify_vpc_tenancy(params = {}, options = {})
  req = build_request(:modify_vpc_tenancy, params)
  req.send_request(options)
end

#modify_vpn_connection(params = {}) ⇒ Types::ModifyVpnConnectionResult

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:

  • An existing virtual private gateway to a new virtual private gateway

  • An existing virtual private gateway to a transit gateway

  • An existing transit gateway to a new transit gateway

  • An existing transit gateway to a virtual private gateway

Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.

This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.

You must delete the static routes before you migrate to the new gateway.

Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.

After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in [Update VPC route tables] in the *Amazon Web Services Site-to-Site VPN User Guide*.

When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.

If you deleted VPN static routes, you must add the static routes to the transit gateway route table.

After you perform this operation, the VPN endpoint’s IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-target.html#step-update-routing

Examples:

Request syntax with placeholder values


resp = client.modify_vpn_connection({
  vpn_connection_id: "VpnConnectionId", # required
  transit_gateway_id: "TransitGatewayId",
  customer_gateway_id: "CustomerGatewayId",
  vpn_gateway_id: "VpnGatewayId",
  dry_run: false,
})

Response structure


resp.vpn_connection.category #=> String
resp.vpn_connection.transit_gateway_id #=> String
resp.vpn_connection.core_network_arn #=> String
resp.vpn_connection.core_network_attachment_arn #=> String
resp.vpn_connection.gateway_association_state #=> String, one of "associated", "not-associated", "associating", "disassociating"
resp.vpn_connection.options.enable_acceleration #=> Boolean
resp.vpn_connection.options.static_routes_only #=> Boolean
resp.vpn_connection.options.local_ipv_4_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_4_network_cidr #=> String
resp.vpn_connection.options.local_ipv_6_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_6_network_cidr #=> String
resp.vpn_connection.options.outside_ip_address_type #=> String
resp.vpn_connection.options.transport_transit_gateway_attachment_id #=> String
resp.vpn_connection.options.tunnel_inside_ip_version #=> String, one of "ipv4", "ipv6"
resp.vpn_connection.options.tunnel_options #=> Array
resp.vpn_connection.options.tunnel_options[0].outside_ip_address #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_ipv_6_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].pre_shared_key #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_margin_time_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_fuzz_percentage #=> Integer
resp.vpn_connection.options.tunnel_options[0].replay_window_size #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_action #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].ike_versions #=> Array
resp.vpn_connection.options.tunnel_options[0].ike_versions[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].startup_action #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_enabled #=> Boolean
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_group_arn #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_output_format #=> String
resp.vpn_connection.options.tunnel_options[0].enable_tunnel_lifecycle_control #=> Boolean
resp.vpn_connection.routes #=> Array
resp.vpn_connection.routes[0].destination_cidr_block #=> String
resp.vpn_connection.routes[0].source #=> String, one of "Static"
resp.vpn_connection.routes[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.tags #=> Array
resp.vpn_connection.tags[0].key #=> String
resp.vpn_connection.tags[0].value #=> String
resp.vpn_connection.vgw_telemetry #=> Array
resp.vpn_connection.vgw_telemetry[0].accepted_route_count #=> Integer
resp.vpn_connection.vgw_telemetry[0].last_status_change #=> Time
resp.vpn_connection.vgw_telemetry[0].outside_ip_address #=> String
resp.vpn_connection.vgw_telemetry[0].status #=> String, one of "UP", "DOWN"
resp.vpn_connection.vgw_telemetry[0].status_message #=> String
resp.vpn_connection.vgw_telemetry[0].certificate_arn #=> String
resp.vpn_connection.vpn_connection_id #=> String
resp.vpn_connection.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.customer_gateway_configuration #=> String
resp.vpn_connection.type #=> String, one of "ipsec.1"
resp.vpn_connection.customer_gateway_id #=> String
resp.vpn_connection.vpn_gateway_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpn_connection_id (required, String) —

    The ID of the VPN connection.

  • :transit_gateway_id (String) —

    The ID of the transit gateway.

  • :customer_gateway_id (String) —

    The ID of the customer gateway at your end of the VPN connection.

  • :vpn_gateway_id (String) —

    The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.

  • :dry_run (Boolean) —

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

Returns:

See Also:



52284
52285
52286
52287
 
# File 'lib/aws-sdk-ec2/client.rb', line 52284

def modify_vpn_connection(params = {}, options = {})
  req = build_request(:modify_vpn_connection, params)
  req.send_request(options)
end

#modify_vpn_connection_options(params = {}) ⇒ Types::ModifyVpnConnectionOptionsResult

Modifies the connection options for your Site-to-Site VPN connection.

When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.

Examples:

Request syntax with placeholder values


resp = client.modify_vpn_connection_options({
  vpn_connection_id: "VpnConnectionId", # required
  local_ipv_4_network_cidr: "String",
  remote_ipv_4_network_cidr: "String",
  local_ipv_6_network_cidr: "String",
  remote_ipv_6_network_cidr: "String",
  dry_run: false,
})

Response structure


resp.vpn_connection.category #=> String
resp.vpn_connection.transit_gateway_id #=> String
resp.vpn_connection.core_network_arn #=> String
resp.vpn_connection.core_network_attachment_arn #=> String
resp.vpn_connection.gateway_association_state #=> String, one of "associated", "not-associated", "associating", "disassociating"
resp.vpn_connection.options.enable_acceleration #=> Boolean
resp.vpn_connection.options.static_routes_only #=> Boolean
resp.vpn_connection.options.local_ipv_4_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_4_network_cidr #=> String
resp.vpn_connection.options.local_ipv_6_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_6_network_cidr #=> String
resp.vpn_connection.options.outside_ip_address_type #=> String
resp.vpn_connection.options.transport_transit_gateway_attachment_id #=> String
resp.vpn_connection.options.tunnel_inside_ip_version #=> String, one of "ipv4", "ipv6"
resp.vpn_connection.options.tunnel_options #=> Array
resp.vpn_connection.options.tunnel_options[0].outside_ip_address #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_ipv_6_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].pre_shared_key #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_margin_time_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_fuzz_percentage #=> Integer
resp.vpn_connection.options.tunnel_options[0].replay_window_size #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_action #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].ike_versions #=> Array
resp.vpn_connection.options.tunnel_options[0].ike_versions[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].startup_action #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_enabled #=> Boolean
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_group_arn #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_output_format #=> String
resp.vpn_connection.options.tunnel_options[0].enable_tunnel_lifecycle_control #=> Boolean
resp.vpn_connection.routes #=> Array
resp.vpn_connection.routes[0].destination_cidr_block #=> String
resp.vpn_connection.routes[0].source #=> String, one of "Static"
resp.vpn_connection.routes[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.tags #=> Array
resp.vpn_connection.tags[0].key #=> String
resp.vpn_connection.tags[0].value #=> String
resp.vpn_connection.vgw_telemetry #=> Array
resp.vpn_connection.vgw_telemetry[0].accepted_route_count #=> Integer
resp.vpn_connection.vgw_telemetry[0].last_status_change #=> Time
resp.vpn_connection.vgw_telemetry[0].outside_ip_address #=> String
resp.vpn_connection.vgw_telemetry[0].status #=> String, one of "UP", "DOWN"
resp.vpn_connection.vgw_telemetry[0].status_message #=> String
resp.vpn_connection.vgw_telemetry[0].certificate_arn #=> String
resp.vpn_connection.vpn_connection_id #=> String
resp.vpn_connection.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.customer_gateway_configuration #=> String
resp.vpn_connection.type #=> String, one of "ipsec.1"
resp.vpn_connection.customer_gateway_id #=> String
resp.vpn_connection.vpn_gateway_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpn_connection_id (required, String) —

    The ID of the Site-to-Site VPN connection.

  • :local_ipv_4_network_cidr (String) —

    The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

    Default: ‘0.0.0.0/0`

  • :remote_ipv_4_network_cidr (String) —

    The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

    Default: ‘0.0.0.0/0`

  • :local_ipv_6_network_cidr (String) —

    The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

    Default: ‘::/0`

  • :remote_ipv_6_network_cidr (String) —

    The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

    Default: ‘::/0`

  • :dry_run (Boolean) —

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

Returns:

See Also:



52414
52415
52416
52417
 
# File 'lib/aws-sdk-ec2/client.rb', line 52414

def modify_vpn_connection_options(params = {}, options = {})
  req = build_request(:modify_vpn_connection_options, params)
  req.send_request(options)
end

#modify_vpn_tunnel_certificate(params = {}) ⇒ Types::ModifyVpnTunnelCertificateResult

Modifies the VPN tunnel endpoint certificate.

Examples:

Request syntax with placeholder values


resp = client.modify_vpn_tunnel_certificate({
  vpn_connection_id: "VpnConnectionId", # required
  vpn_tunnel_outside_ip_address: "String", # required
  dry_run: false,
})

Response structure


resp.vpn_connection.category #=> String
resp.vpn_connection.transit_gateway_id #=> String
resp.vpn_connection.core_network_arn #=> String
resp.vpn_connection.core_network_attachment_arn #=> String
resp.vpn_connection.gateway_association_state #=> String, one of "associated", "not-associated", "associating", "disassociating"
resp.vpn_connection.options.enable_acceleration #=> Boolean
resp.vpn_connection.options.static_routes_only #=> Boolean
resp.vpn_connection.options.local_ipv_4_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_4_network_cidr #=> String
resp.vpn_connection.options.local_ipv_6_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_6_network_cidr #=> String
resp.vpn_connection.options.outside_ip_address_type #=> String
resp.vpn_connection.options.transport_transit_gateway_attachment_id #=> String
resp.vpn_connection.options.tunnel_inside_ip_version #=> String, one of "ipv4", "ipv6"
resp.vpn_connection.options.tunnel_options #=> Array
resp.vpn_connection.options.tunnel_options[0].outside_ip_address #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_ipv_6_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].pre_shared_key #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_margin_time_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_fuzz_percentage #=> Integer
resp.vpn_connection.options.tunnel_options[0].replay_window_size #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_action #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].ike_versions #=> Array
resp.vpn_connection.options.tunnel_options[0].ike_versions[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].startup_action #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_enabled #=> Boolean
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_group_arn #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_output_format #=> String
resp.vpn_connection.options.tunnel_options[0].enable_tunnel_lifecycle_control #=> Boolean
resp.vpn_connection.routes #=> Array
resp.vpn_connection.routes[0].destination_cidr_block #=> String
resp.vpn_connection.routes[0].source #=> String, one of "Static"
resp.vpn_connection.routes[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.tags #=> Array
resp.vpn_connection.tags[0].key #=> String
resp.vpn_connection.tags[0].value #=> String
resp.vpn_connection.vgw_telemetry #=> Array
resp.vpn_connection.vgw_telemetry[0].accepted_route_count #=> Integer
resp.vpn_connection.vgw_telemetry[0].last_status_change #=> Time
resp.vpn_connection.vgw_telemetry[0].outside_ip_address #=> String
resp.vpn_connection.vgw_telemetry[0].status #=> String, one of "UP", "DOWN"
resp.vpn_connection.vgw_telemetry[0].status_message #=> String
resp.vpn_connection.vgw_telemetry[0].certificate_arn #=> String
resp.vpn_connection.vpn_connection_id #=> String
resp.vpn_connection.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.customer_gateway_configuration #=> String
resp.vpn_connection.type #=> String, one of "ipsec.1"
resp.vpn_connection.customer_gateway_id #=> String
resp.vpn_connection.vpn_gateway_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpn_connection_id (required, String) —

    The ID of the Amazon Web Services Site-to-Site VPN connection.

  • :vpn_tunnel_outside_ip_address (required, String) —

    The external IP address of the VPN tunnel.

  • :dry_run (Boolean) —

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

Returns:

See Also:



52517
52518
52519
52520
 
# File 'lib/aws-sdk-ec2/client.rb', line 52517

def modify_vpn_tunnel_certificate(params = {}, options = {})
  req = build_request(:modify_vpn_tunnel_certificate, params)
  req.send_request(options)
end

#modify_vpn_tunnel_options(params = {}) ⇒ Types::ModifyVpnTunnelOptionsResult

Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see [Site-to-Site VPN tunnel options for your Site-to-Site VPN connection] in the *Amazon Web Services Site-to-Site VPN User Guide*.

[1]: docs.aws.amazon.com/vpn/latest/s2svpn/VPNTunnels.html

Examples:

Request syntax with placeholder values


resp = client.modify_vpn_tunnel_options({
  vpn_connection_id: "VpnConnectionId", # required
  vpn_tunnel_outside_ip_address: "String", # required
  tunnel_options: { # required
    tunnel_inside_cidr: "String",
    tunnel_inside_ipv_6_cidr: "String",
    pre_shared_key: "preSharedKey",
    phase_1_lifetime_seconds: 1,
    phase_2_lifetime_seconds: 1,
    rekey_margin_time_seconds: 1,
    rekey_fuzz_percentage: 1,
    replay_window_size: 1,
    dpd_timeout_seconds: 1,
    dpd_timeout_action: "String",
    phase_1_encryption_algorithms: [
      {
        value: "String",
      },
    ],
    phase_2_encryption_algorithms: [
      {
        value: "String",
      },
    ],
    phase_1_integrity_algorithms: [
      {
        value: "String",
      },
    ],
    phase_2_integrity_algorithms: [
      {
        value: "String",
      },
    ],
    phase_1_dh_group_numbers: [
      {
        value: 1,
      },
    ],
    phase_2_dh_group_numbers: [
      {
        value: 1,
      },
    ],
    ike_versions: [
      {
        value: "String",
      },
    ],
    startup_action: "String",
    log_options: {
      cloud_watch_log_options: {
        log_enabled: false,
        log_group_arn: "CloudWatchLogGroupArn",
        log_output_format: "String",
      },
    },
    enable_tunnel_lifecycle_control: false,
  },
  dry_run: false,
  skip_tunnel_replacement: false,
})

Response structure


resp.vpn_connection.category #=> String
resp.vpn_connection.transit_gateway_id #=> String
resp.vpn_connection.core_network_arn #=> String
resp.vpn_connection.core_network_attachment_arn #=> String
resp.vpn_connection.gateway_association_state #=> String, one of "associated", "not-associated", "associating", "disassociating"
resp.vpn_connection.options.enable_acceleration #=> Boolean
resp.vpn_connection.options.static_routes_only #=> Boolean
resp.vpn_connection.options.local_ipv_4_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_4_network_cidr #=> String
resp.vpn_connection.options.local_ipv_6_network_cidr #=> String
resp.vpn_connection.options.remote_ipv_6_network_cidr #=> String
resp.vpn_connection.options.outside_ip_address_type #=> String
resp.vpn_connection.options.transport_transit_gateway_attachment_id #=> String
resp.vpn_connection.options.tunnel_inside_ip_version #=> String, one of "ipv4", "ipv6"
resp.vpn_connection.options.tunnel_options #=> Array
resp.vpn_connection.options.tunnel_options[0].outside_ip_address #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].tunnel_inside_ipv_6_cidr #=> String
resp.vpn_connection.options.tunnel_options[0].pre_shared_key #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_lifetime_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_margin_time_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].rekey_fuzz_percentage #=> Integer
resp.vpn_connection.options.tunnel_options[0].replay_window_size #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_seconds #=> Integer
resp.vpn_connection.options.tunnel_options[0].dpd_timeout_action #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_encryption_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_integrity_algorithms[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_1_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers #=> Array
resp.vpn_connection.options.tunnel_options[0].phase_2_dh_group_numbers[0].value #=> Integer
resp.vpn_connection.options.tunnel_options[0].ike_versions #=> Array
resp.vpn_connection.options.tunnel_options[0].ike_versions[0].value #=> String
resp.vpn_connection.options.tunnel_options[0].startup_action #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_enabled #=> Boolean
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_group_arn #=> String
resp.vpn_connection.options.tunnel_options[0].log_options.cloud_watch_log_options.log_output_format #=> String
resp.vpn_connection.options.tunnel_options[0].enable_tunnel_lifecycle_control #=> Boolean
resp.vpn_connection.routes #=> Array
resp.vpn_connection.routes[0].destination_cidr_block #=> String
resp.vpn_connection.routes[0].source #=> String, one of "Static"
resp.vpn_connection.routes[0].state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.tags #=> Array
resp.vpn_connection.tags[0].key #=> String
resp.vpn_connection.tags[0].value #=> String
resp.vpn_connection.vgw_telemetry #=> Array
resp.vpn_connection.vgw_telemetry[0].accepted_route_count #=> Integer
resp.vpn_connection.vgw_telemetry[0].last_status_change #=> Time
resp.vpn_connection.vgw_telemetry[0].outside_ip_address #=> String
resp.vpn_connection.vgw_telemetry[0].status #=> String, one of "UP", "DOWN"
resp.vpn_connection.vgw_telemetry[0].status_message #=> String
resp.vpn_connection.vgw_telemetry[0].certificate_arn #=> String
resp.vpn_connection.vpn_connection_id #=> String
resp.vpn_connection.state #=> String, one of "pending", "available", "deleting", "deleted"
resp.vpn_connection.customer_gateway_configuration #=> String
resp.vpn_connection.type #=> String, one of "ipsec.1"
resp.vpn_connection.customer_gateway_id #=> String
resp.vpn_connection.vpn_gateway_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpn_connection_id (required, String) —

    The ID of the Amazon Web Services Site-to-Site VPN connection.

  • :vpn_tunnel_outside_ip_address (required, String) —

    The external IP address of the VPN tunnel.

  • :tunnel_options (required, Types::ModifyVpnTunnelOptionsSpecification) —

    The tunnel options to modify.

  • :dry_run (Boolean) —

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

  • :skip_tunnel_replacement (Boolean) —

    Choose whether or not to trigger immediate tunnel replacement. This is only applicable when turning on or off ‘EnableTunnelLifecycleControl`.

    Valid values: ‘True` | `False`

Returns:

See Also:



52695
52696
52697
52698
 
# File 'lib/aws-sdk-ec2/client.rb', line 52695

def modify_vpn_tunnel_options(params = {}, options = {})
  req = build_request(:modify_vpn_tunnel_options, params)
  req.send_request(options)
end

#monitor_instances(params = {}) ⇒ Types::MonitorInstancesResult

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see [Monitor your instances using CloudWatch] in the *Amazon EC2 User Guide*.

To disable detailed monitoring, see [UnmonitorInstances].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_UnmonitorInstances.html

Examples:

Request syntax with placeholder values


resp = client.monitor_instances({
  instance_ids: ["InstanceId"], # required
  dry_run: false,
})

Response structure


resp.instance_monitorings #=> Array
resp.instance_monitorings[0].instance_id #=> String
resp.instance_monitorings[0].monitoring.state #=> String, one of "disabled", "disabling", "enabled", "pending"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (required, Array<String>) —

    The IDs of the instances.

  • :dry_run (Boolean) —

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

Returns:

See Also:



52741
52742
52743
52744
 
# File 'lib/aws-sdk-ec2/client.rb', line 52741

def monitor_instances(params = {}, options = {})
  req = build_request(:monitor_instances, params)
  req.send_request(options)
end

#move_address_to_vpc(params = {}) ⇒ Types::MoveAddressToVpcResult

<note markdown=“1”> This action is deprecated.

</note>

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

Examples:

Example: To move an address to EC2-VPC


# This example moves the specified Elastic IP address to the EC2-VPC platform.

resp = client.move_address_to_vpc({
  public_ip: "54.123.4.56", 
})

resp.to_h outputs the following:
{
  status: "MoveInProgress", 
}

Request syntax with placeholder values


resp = client.move_address_to_vpc({
  dry_run: false,
  public_ip: "String", # required
})

Response structure


resp.allocation_id #=> String
resp.status #=> String, one of "MoveInProgress", "InVpc", "InClassic"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :public_ip (required, String) —

    The Elastic IP address.

Returns:

See Also:



52803
52804
52805
52806
 
# File 'lib/aws-sdk-ec2/client.rb', line 52803

def move_address_to_vpc(params = {}, options = {})
  req = build_request(:move_address_to_vpc, params)
  req.send_request(options)
end

#move_byoip_cidr_to_ipam(params = {}) ⇒ Types::MoveByoipCidrToIpamResult

Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.

If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in [Tutorial: BYOIP address CIDRs to IPAM].

[1]: docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoip-ipam.html

Examples:

Request syntax with placeholder values


resp = client.move_byoip_cidr_to_ipam({
  dry_run: false,
  cidr: "String", # required
  ipam_pool_id: "IpamPoolId", # required
  ipam_pool_owner: "String", # required
})

Response structure


resp.byoip_cidr.cidr #=> String
resp.byoip_cidr.description #=> String
resp.byoip_cidr.asn_associations #=> Array
resp.byoip_cidr.asn_associations[0].asn #=> String
resp.byoip_cidr.asn_associations[0].cidr #=> String
resp.byoip_cidr.asn_associations[0].status_message #=> String
resp.byoip_cidr.asn_associations[0].state #=> String, one of "disassociated", "failed-disassociation", "failed-association", "pending-disassociation", "pending-association", "associated"
resp.byoip_cidr.status_message #=> String
resp.byoip_cidr.state #=> String, one of "advertised", "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned", "provisioned-not-publicly-advertisable"
resp.byoip_cidr.network_border_group #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :cidr (required, String) —

    The BYOIP CIDR.

  • :ipam_pool_id (required, String) —

    The IPAM pool ID.

  • :ipam_pool_owner (required, String) —

    The Amazon Web Services account ID of the owner of the IPAM pool.

Returns:

See Also:



52865
52866
52867
52868
 
# File 'lib/aws-sdk-ec2/client.rb', line 52865

def move_byoip_cidr_to_ipam(params = {}, options = {})
  req = build_request(:move_byoip_cidr_to_ipam, params)
  req.send_request(options)
end

#move_capacity_reservation_instances(params = {}) ⇒ Types::MoveCapacityReservationInstancesResult

Move available capacity from a source Capacity Reservation to a destination Capacity Reservation. The source Capacity Reservation and the destination Capacity Reservation must be ‘active`, owned by your Amazon Web Services account, and share the following:

  • Instance type

  • Platform

  • Availability Zone

  • Tenancy

  • Placement group

  • Capacity Reservation end time - ‘At specific time` or `Manually`.

Examples:

Request syntax with placeholder values


resp = client.move_capacity_reservation_instances({
  dry_run: false,
  client_token: "String",
  source_capacity_reservation_id: "CapacityReservationId", # required
  destination_capacity_reservation_id: "CapacityReservationId", # required
  instance_count: 1, # required
})

Response structure


resp.source_capacity_reservation.capacity_reservation_id #=> String
resp.source_capacity_reservation.owner_id #=> String
resp.source_capacity_reservation.capacity_reservation_arn #=> String
resp.source_capacity_reservation.availability_zone_id #=> String
resp.source_capacity_reservation.instance_type #=> String
resp.source_capacity_reservation.instance_platform #=> String, one of "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"
resp.source_capacity_reservation.availability_zone #=> String
resp.source_capacity_reservation.tenancy #=> String, one of "default", "dedicated"
resp.source_capacity_reservation.total_instance_count #=> Integer
resp.source_capacity_reservation.available_instance_count #=> Integer
resp.source_capacity_reservation.ebs_optimized #=> Boolean
resp.source_capacity_reservation.ephemeral_storage #=> Boolean
resp.source_capacity_reservation.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "scheduled", "payment-pending", "payment-failed"
resp.source_capacity_reservation.start_date #=> Time
resp.source_capacity_reservation.end_date #=> Time
resp.source_capacity_reservation.end_date_type #=> String, one of "unlimited", "limited"
resp.source_capacity_reservation.instance_match_criteria #=> String, one of "open", "targeted"
resp.source_capacity_reservation.create_date #=> Time
resp.source_capacity_reservation.tags #=> Array
resp.source_capacity_reservation.tags[0].key #=> String
resp.source_capacity_reservation.tags[0].value #=> String
resp.source_capacity_reservation.outpost_arn #=> String
resp.source_capacity_reservation.capacity_reservation_fleet_id #=> String
resp.source_capacity_reservation.placement_group_arn #=> String
resp.source_capacity_reservation.capacity_allocations #=> Array
resp.source_capacity_reservation.capacity_allocations[0].allocation_type #=> String, one of "used"
resp.source_capacity_reservation.capacity_allocations[0].count #=> Integer
resp.source_capacity_reservation.reservation_type #=> String, one of "default", "capacity-block"
resp.source_capacity_reservation.unused_reservation_billing_owner_id #=> String
resp.destination_capacity_reservation.capacity_reservation_id #=> String
resp.destination_capacity_reservation.owner_id #=> String
resp.destination_capacity_reservation.capacity_reservation_arn #=> String
resp.destination_capacity_reservation.availability_zone_id #=> String
resp.destination_capacity_reservation.instance_type #=> String
resp.destination_capacity_reservation.instance_platform #=> String, one of "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"
resp.destination_capacity_reservation.availability_zone #=> String
resp.destination_capacity_reservation.tenancy #=> String, one of "default", "dedicated"
resp.destination_capacity_reservation.total_instance_count #=> Integer
resp.destination_capacity_reservation.available_instance_count #=> Integer
resp.destination_capacity_reservation.ebs_optimized #=> Boolean
resp.destination_capacity_reservation.ephemeral_storage #=> Boolean
resp.destination_capacity_reservation.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "scheduled", "payment-pending", "payment-failed"
resp.destination_capacity_reservation.start_date #=> Time
resp.destination_capacity_reservation.end_date #=> Time
resp.destination_capacity_reservation.end_date_type #=> String, one of "unlimited", "limited"
resp.destination_capacity_reservation.instance_match_criteria #=> String, one of "open", "targeted"
resp.destination_capacity_reservation.create_date #=> Time
resp.destination_capacity_reservation.tags #=> Array
resp.destination_capacity_reservation.tags[0].key #=> String
resp.destination_capacity_reservation.tags[0].value #=> String
resp.destination_capacity_reservation.outpost_arn #=> String
resp.destination_capacity_reservation.capacity_reservation_fleet_id #=> String
resp.destination_capacity_reservation.placement_group_arn #=> String
resp.destination_capacity_reservation.capacity_allocations #=> Array
resp.destination_capacity_reservation.capacity_allocations[0].allocation_type #=> String, one of "used"
resp.destination_capacity_reservation.capacity_allocations[0].count #=> Integer
resp.destination_capacity_reservation.reservation_type #=> String, one of "default", "capacity-block"
resp.destination_capacity_reservation.unused_reservation_billing_owner_id #=> String
resp.instance_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :source_capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation from which you want to move capacity.

  • :destination_capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation that you want to move capacity into.

  • :instance_count (required, Integer) —

    The number of instances that you want to move from the source Capacity Reservation.

Returns:

See Also:



52999
53000
53001
53002
 
# File 'lib/aws-sdk-ec2/client.rb', line 52999

def move_capacity_reservation_instances(params = {}, options = {})
  req = build_request(:move_capacity_reservation_instances, params)
  req.send_request(options)
end

#provision_byoip_cidr(params = {}) ⇒ Types::ProvisionByoipCidrResult

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see [Bring your own IP addresses (BYOIP)] in the *Amazon EC2 User Guide*.

Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from ‘pending-provision` to `provisioned`. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html

Examples:

Request syntax with placeholder values


resp = client.provision_byoip_cidr({
  cidr: "String", # required
  cidr_authorization_context: {
    message: "String", # required
    signature: "String", # required
  },
  publicly_advertisable: false,
  description: "String",
  dry_run: false,
  pool_tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  multi_region: false,
  network_border_group: "String",
})

Response structure


resp.byoip_cidr.cidr #=> String
resp.byoip_cidr.description #=> String
resp.byoip_cidr.asn_associations #=> Array
resp.byoip_cidr.asn_associations[0].asn #=> String
resp.byoip_cidr.asn_associations[0].cidr #=> String
resp.byoip_cidr.asn_associations[0].status_message #=> String
resp.byoip_cidr.asn_associations[0].state #=> String, one of "disassociated", "failed-disassociation", "failed-association", "pending-disassociation", "pending-association", "associated"
resp.byoip_cidr.status_message #=> String
resp.byoip_cidr.state #=> String, one of "advertised", "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned", "provisioned-not-publicly-advertisable"
resp.byoip_cidr.network_border_group #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr (required, String) —

    The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you’ve brought to this or another Region.

  • :cidr_authorization_context (Types::CidrAuthorizationContext) —

    A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

  • :publicly_advertisable (Boolean) — default: IPv6 only —

    Indicate whether the address range will be publicly advertised to the internet.

    Default: true

  • :description (String) —

    A description for the address range and the address pool.

  • :dry_run (Boolean) —

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

  • :pool_tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the address pool.

  • :multi_region (Boolean) —

    Reserved.

  • :network_border_group (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 markdown=“1”> You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

    </note>

    [1]: docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html

Returns:

See Also:



53133
53134
53135
53136
 
# File 'lib/aws-sdk-ec2/client.rb', line 53133

def provision_byoip_cidr(params = {}, options = {})
  req = build_request(:provision_byoip_cidr, params)
  req.send_request(options)
end

#provision_ipam_byoasn(params = {}) ⇒ Types::ProvisionIpamByoasnResult

Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. For more information, see [Tutorial: Bring your ASN to IPAM] in the *Amazon VPC IPAM guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html

Examples:

Request syntax with placeholder values


resp = client.provision_ipam_byoasn({
  dry_run: false,
  ipam_id: "IpamId", # required
  asn: "String", # required
  asn_authorization_context: { # required
    message: "String", # required
    signature: "String", # required
  },
})

Response structure


resp.byoasn.asn #=> String
resp.byoasn.ipam_id #=> String
resp.byoasn.status_message #=> String
resp.byoasn.state #=> String, one of "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :ipam_id (required, String) —

    An IPAM ID.

  • :asn (required, String) —

    A public 2-byte or 4-byte ASN.

  • :asn_authorization_context (required, Types::AsnAuthorizationContext) —

    An ASN authorization context.

Returns:

See Also:



53190
53191
53192
53193
 
# File 'lib/aws-sdk-ec2/client.rb', line 53190

def provision_ipam_byoasn(params = {}, options = {})
  req = build_request(:provision_ipam_byoasn, params)
  req.send_request(options)
end

#provision_ipam_pool_cidr(params = {}) ⇒ Types::ProvisionIpamPoolCidrResult

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

For more information, see [Provision CIDRs to pools] in the *Amazon VPC IPAM User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/prov-cidr-ipam.html

Examples:

Request syntax with placeholder values


resp = client.provision_ipam_pool_cidr({
  dry_run: false,
  ipam_pool_id: "IpamPoolId", # required
  cidr: "String",
  cidr_authorization_context: {
    message: "String",
    signature: "String",
  },
  netmask_length: 1,
  client_token: "String",
  verification_method: "remarks-x509", # accepts remarks-x509, dns-token
  ipam_external_resource_verification_token_id: "IpamExternalResourceVerificationTokenId",
})

Response structure


resp.ipam_pool_cidr.cidr #=> String
resp.ipam_pool_cidr.state #=> String, one of "pending-provision", "provisioned", "failed-provision", "pending-deprovision", "deprovisioned", "failed-deprovision", "pending-import", "failed-import"
resp.ipam_pool_cidr.failure_reason.code #=> String, one of "cidr-not-available", "limit-exceeded"
resp.ipam_pool_cidr.failure_reason.message #=> String
resp.ipam_pool_cidr.ipam_pool_cidr_id #=> String
resp.ipam_pool_cidr.netmask_length #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_pool_id (required, String) —

    The ID of the IPAM pool to which you want to assign a CIDR.

  • :cidr (String) —

    The CIDR you want to assign to the IPAM pool. Either “NetmaskLength” or “Cidr” is required. This value will be null if you specify “NetmaskLength” and will be filled in during the provisioning process.

  • :cidr_authorization_context (Types::IpamCidrAuthorizationContext) —

    A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.

  • :netmask_length (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. Either “NetmaskLength” or “Cidr” is required.

  • :client_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

  • :verification_method (String) —

    The method for verifying control of a public IP address range. Defaults to ‘remarks-x509` if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.

  • :ipam_external_resource_verification_token_id (String) —

    Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.

Returns:

See Also:



53287
53288
53289
53290
 
# File 'lib/aws-sdk-ec2/client.rb', line 53287

def provision_ipam_pool_cidr(params = {}, options = {})
  req = build_request(:provision_ipam_pool_cidr, params)
  req.send_request(options)
end

#provision_public_ipv_4_pool_cidr(params = {}) ⇒ Types::ProvisionPublicIpv4PoolCidrResult

Provision a CIDR to a public IPv4 pool.

For more information about IPAM, see [What is IPAM?] in the *Amazon VPC IPAM User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html

Examples:

Request syntax with placeholder values


resp = client.provision_public_ipv_4_pool_cidr({
  dry_run: false,
  ipam_pool_id: "IpamPoolId", # required
  pool_id: "Ipv4PoolEc2Id", # required
  netmask_length: 1, # required
  network_border_group: "String",
})

Response structure


resp.pool_id #=> String
resp.pool_address_range.first_address #=> String
resp.pool_address_range.last_address #=> String
resp.pool_address_range.address_count #=> Integer
resp.pool_address_range.available_address_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_pool_id (required, String) —

    The ID of the IPAM pool you would like to use to allocate this CIDR.

  • :pool_id (required, String) —

    The ID of the public IPv4 pool you would like to use for this CIDR.

  • :netmask_length (required, Integer) —

    The netmask length of the CIDR you would like to allocate to the public IPv4 pool. The least specific netmask length you can define is 24.

  • :network_border_group (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*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail

Returns:

See Also:



53356
53357
53358
53359
 
# File 'lib/aws-sdk-ec2/client.rb', line 53356

def provision_public_ipv_4_pool_cidr(params = {}, options = {})
  req = build_request(:provision_public_ipv_4_pool_cidr, params)
  req.send_request(options)
end

#purchase_capacity_block(params = {}) ⇒ Types::PurchaseCapacityBlockResult

Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning (ML) workloads. You must specify the ID of the Capacity Block offering you are purchasing.

Examples:

Request syntax with placeholder values


resp = client.purchase_capacity_block({
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  capacity_block_offering_id: "OfferingId", # required
  instance_platform: "Linux/UNIX", # required, accepts 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
})

Response structure


resp.capacity_reservation.capacity_reservation_id #=> String
resp.capacity_reservation.owner_id #=> String
resp.capacity_reservation.capacity_reservation_arn #=> String
resp.capacity_reservation.availability_zone_id #=> String
resp.capacity_reservation.instance_type #=> String
resp.capacity_reservation.instance_platform #=> String, one of "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"
resp.capacity_reservation.availability_zone #=> String
resp.capacity_reservation.tenancy #=> String, one of "default", "dedicated"
resp.capacity_reservation.total_instance_count #=> Integer
resp.capacity_reservation.available_instance_count #=> Integer
resp.capacity_reservation.ebs_optimized #=> Boolean
resp.capacity_reservation.ephemeral_storage #=> Boolean
resp.capacity_reservation.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "scheduled", "payment-pending", "payment-failed"
resp.capacity_reservation.start_date #=> Time
resp.capacity_reservation.end_date #=> Time
resp.capacity_reservation.end_date_type #=> String, one of "unlimited", "limited"
resp.capacity_reservation.instance_match_criteria #=> String, one of "open", "targeted"
resp.capacity_reservation.create_date #=> Time
resp.capacity_reservation.tags #=> Array
resp.capacity_reservation.tags[0].key #=> String
resp.capacity_reservation.tags[0].value #=> String
resp.capacity_reservation.outpost_arn #=> String
resp.capacity_reservation.capacity_reservation_fleet_id #=> String
resp.capacity_reservation.placement_group_arn #=> String
resp.capacity_reservation.capacity_allocations #=> Array
resp.capacity_reservation.capacity_allocations[0].allocation_type #=> String, one of "used"
resp.capacity_reservation.capacity_allocations[0].count #=> Integer
resp.capacity_reservation.reservation_type #=> String, one of "default", "capacity-block"
resp.capacity_reservation.unused_reservation_billing_owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the Capacity Block during launch.

  • :capacity_block_offering_id (required, String) —

    The ID of the Capacity Block offering.

  • :instance_platform (required, String) —

    The type of operating system for which to reserve capacity.

Returns:

See Also:



53440
53441
53442
53443
 
# File 'lib/aws-sdk-ec2/client.rb', line 53440

def purchase_capacity_block(params = {}, options = {})
  req = build_request(:purchase_capacity_block, params)
  req.send_request(options)
end

#purchase_host_reservation(params = {}) ⇒ Types::PurchaseHostReservationResult

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

Examples:

Request syntax with placeholder values


resp = client.purchase_host_reservation({
  client_token: "String",
  currency_code: "USD", # accepts USD
  host_id_set: ["DedicatedHostId"], # required
  limit_price: "String",
  offering_id: "OfferingId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
})

Response structure


resp.client_token #=> String
resp.currency_code #=> String, one of "USD"
resp.purchase #=> Array
resp.purchase[0].currency_code #=> String, one of "USD"
resp.purchase[0].duration #=> Integer
resp.purchase[0].host_id_set #=> Array
resp.purchase[0].host_id_set[0] #=> String
resp.purchase[0].host_reservation_id #=> String
resp.purchase[0].hourly_price #=> String
resp.purchase[0].instance_family #=> String
resp.purchase[0].payment_option #=> String, one of "AllUpfront", "PartialUpfront", "NoUpfront"
resp.purchase[0].upfront_price #=> String
resp.total_hourly_price #=> String
resp.total_upfront_price #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :currency_code (String) —

    The currency in which the ‘totalUpfrontPrice`, `LimitPrice`, and `totalHourlyPrice` amounts are specified. At this time, the only supported currency is `USD`.

  • :host_id_set (required, Array<String>) —

    The IDs of the Dedicated Hosts with which the reservation will be associated.

  • :limit_price (String) —

    The specified limit is checked against the total upfront cost of the reservation (calculated as the offering’s upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is ‘USD`. For example, to indicate a limit price of USD 100, specify 100.00.

  • :offering_id (required, String) —

    The ID of the offering.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the Dedicated Host Reservation during purchase.

Returns:

See Also:



53533
53534
53535
53536
 
# File 'lib/aws-sdk-ec2/client.rb', line 53533

def purchase_host_reservation(params = {}, options = {})
  req = build_request(:purchase_host_reservation, params)
  req.send_request(options)
end

#purchase_reserved_instances_offering(params = {}) ⇒ Types::PurchaseReservedInstancesOfferingResult

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you’ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.

For more information, see [Reserved Instances] and [Sell in the Reserved Instance Marketplace] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html

Examples:

Request syntax with placeholder values


resp = client.purchase_reserved_instances_offering({
  instance_count: 1, # required
  reserved_instances_offering_id: "ReservedInstancesOfferingId", # required
  purchase_time: Time.now,
  dry_run: false,
  limit_price: {
    amount: 1.0,
    currency_code: "USD", # accepts USD
  },
})

Response structure


resp.reserved_instances_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_count (required, Integer) —

    The number of Reserved Instances to purchase.

  • :reserved_instances_offering_id (required, String) —

    The ID of the Reserved Instance offering to purchase.

  • :purchase_time (Time, DateTime, Date, Integer, String) —

    The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z).

  • :dry_run (Boolean) —

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

  • :limit_price (Types::ReservedInstanceLimitPrice) —

    Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

Returns:

See Also:



53605
53606
53607
53608
 
# File 'lib/aws-sdk-ec2/client.rb', line 53605

def purchase_reserved_instances_offering(params = {}, options = {})
  req = build_request(:purchase_reserved_instances_offering, params)
  req.send_request(options)
end

#purchase_scheduled_instances(params = {}) ⇒ Types::PurchaseScheduledInstancesResult

<note markdown=“1”> You can no longer purchase Scheduled Instances.

</note>

Purchases the Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can’t cancel, modify, or resell your purchase.

Examples:

Request syntax with placeholder values


resp = client.purchase_scheduled_instances({
  client_token: "String",
  dry_run: false,
  purchase_requests: [ # required
    {
      instance_count: 1, # required
      purchase_token: "String", # required
    },
  ],
})

Response structure


resp.scheduled_instance_set #=> Array
resp.scheduled_instance_set[0].availability_zone #=> String
resp.scheduled_instance_set[0].create_date #=> Time
resp.scheduled_instance_set[0].hourly_price #=> String
resp.scheduled_instance_set[0].instance_count #=> Integer
resp.scheduled_instance_set[0].instance_type #=> String
resp.scheduled_instance_set[0].network_platform #=> String
resp.scheduled_instance_set[0].next_slot_start_time #=> Time
resp.scheduled_instance_set[0].platform #=> String
resp.scheduled_instance_set[0].previous_slot_end_time #=> Time
resp.scheduled_instance_set[0].recurrence.frequency #=> String
resp.scheduled_instance_set[0].recurrence.interval #=> Integer
resp.scheduled_instance_set[0].recurrence.occurrence_day_set #=> Array
resp.scheduled_instance_set[0].recurrence.occurrence_day_set[0] #=> Integer
resp.scheduled_instance_set[0].recurrence.occurrence_relative_to_end #=> Boolean
resp.scheduled_instance_set[0].recurrence.occurrence_unit #=> String
resp.scheduled_instance_set[0].scheduled_instance_id #=> String
resp.scheduled_instance_set[0].slot_duration_in_hours #=> Integer
resp.scheduled_instance_set[0].term_end_date #=> Time
resp.scheduled_instance_set[0].term_start_date #=> Time
resp.scheduled_instance_set[0].total_scheduled_instance_hours #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see [Ensuring Idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :dry_run (Boolean) —

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

  • :purchase_requests (required, Array<Types::PurchaseRequest>) —

    The purchase requests.

Returns:

See Also:



53691
53692
53693
53694
 
# File 'lib/aws-sdk-ec2/client.rb', line 53691

def purchase_scheduled_instances(params = {}, options = {})
  req = build_request(:purchase_scheduled_instances, params)
  req.send_request(options)
end

#reboot_instances(params = {}) ⇒ Struct

Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see [Troubleshoot an unreachable instance] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html

Examples:

Example: To reboot an EC2 instance


# This example reboots the specified EC2 instance.

resp = client.reboot_instances({
  instance_ids: [
    "i-1234567890abcdef5", 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.reboot_instances({
  instance_ids: ["InstanceId"], # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (required, Array<String>) —

    The instance IDs.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



53748
53749
53750
53751
 
# File 'lib/aws-sdk-ec2/client.rb', line 53748

def reboot_instances(params = {}, options = {})
  req = build_request(:reboot_instances, params)
  req.send_request(options)
end

#register_image(params = {}) ⇒ Types::RegisterImageResult

Registers an AMI. When you’re creating an instance-store backed AMI, registering the AMI is the final step in the creation process. For more information about creating AMIs, see [Create an AMI from a snapshot] and [Create an instance-store backed AMI] in the *Amazon EC2 User Guide*.

<note markdown=“1”> For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don’t have to register the AMI yourself. We recommend that you always use CreateImage unless you have a specific reason to use RegisterImage.

</note>

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

**Register a snapshot of a root device volume**

You can use ‘RegisterImage` to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can’t set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.

For more information, see [Create an AMI from a snapshot] and [Use encryption with Amazon EBS-backed AMIs] in the *Amazon EC2 User Guide*.

**Amazon Web Services Marketplace product codes**

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.

In most cases, AMIs for Windows, RedHat, SUSE, and SQL Server require correct licensing information to be present on the AMI. For more information, see [Understand AMI billing information] in the *Amazon EC2 User Guide*. When creating an AMI from a snapshot, the ‘RegisterImage` operation derives the correct billing information from the snapshot’s metadata, but this requires the appropriate metadata to be present. To verify if the correct billing information was applied, check the ‘PlatformDetails` field on the new AMI. If the field is empty or doesn’t match the expected operating system code (for example, Windows, RedHat, SUSE, or SQL), the AMI creation was unsuccessful, and you should discard the AMI and instead create the AMI from an instance using CreateImage. For more information, see

Create an AMI from an instance ][5

in the *Amazon EC2 User Guide*.

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see [Understand AMI billing information] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#creating-launching-ami-from-snapshot [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-instance-store.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html [4]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html [5]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#how-to-create-ebs-ami

Examples:

Request syntax with placeholder values


resp = client.register_image({
  image_location: "String",
  billing_products: ["String"],
  boot_mode: "legacy-bios", # accepts legacy-bios, uefi, uefi-preferred
  tpm_support: "v2.0", # accepts v2.0
  uefi_data: "StringType",
  imds_support: "v2.0", # accepts v2.0
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  dry_run: false,
  name: "String", # required
  description: "String",
  architecture: "i386", # accepts i386, x86_64, arm64, x86_64_mac, arm64_mac
  kernel_id: "KernelId",
  ramdisk_id: "RamdiskId",
  root_device_name: "String",
  block_device_mappings: [
    {
      ebs: {
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "SnapshotId",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
        kms_key_id: "String",
        throughput: 1,
        outpost_arn: "String",
        encrypted: false,
      },
      no_device: "String",
      device_name: "String",
      virtual_name: "String",
    },
  ],
  virtualization_type: "String",
  sriov_net_support: "String",
  ena_support: false,
})

Response structure


resp.image_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_location (String) —

    The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the ‘aws-exec-read` canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see [Canned ACLs] in the *Amazon S3 Service Developer Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl

  • :billing_products (Array<String>) —

    The billing product codes. Your account must be authorized to specify billing product codes.

    If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see [Getting started as a seller] and [AMI-based products] in the *Amazon Web Services Marketplace Seller Guide*.

    [1]: docs.aws.amazon.com/marketplace/latest/userguide/user-guide-for-sellers.html [2]: docs.aws.amazon.com/marketplace/latest/userguide/ami-products.html

  • :boot_mode (String) —

    The boot mode of the AMI. A value of ‘uefi-preferred` indicates that the AMI supports both UEFI and Legacy BIOS.

    <note markdown=“1”> The operating system contained in the AMI must be configured to support the specified boot mode.

    </note>

    For more information, see [Boot modes] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html

  • :tpm_support (String) —

    Set to ‘v2.0` to enable Trusted Platform Module (TPM) support. For more information, see [NitroTPM] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html

  • :uefi_data (String) —

    Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the [GetInstanceUefiData] command. You can inspect and modify the UEFI data by using the [python-uefivars tool] on GitHub. For more information, see [UEFI Secure Boot] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData [2]: github.com/awslabs/python-uefivars [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html

  • :imds_support (String) —

    Set to ‘v2.0` to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have `HttpTokens` automatically set to `required` so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, `HttpPutResponseHopLimit` is set to `2`. For more information, see

    Configure the AMI][1

    in the *Amazon EC2 User Guide*.

    <note markdown=“1”> If you set the value to ‘v2.0`, make sure that your AMI software can support IMDSv2.

    </note>

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the AMI.

    To tag the AMI, the value for ‘ResourceType` must be `image`. If you specify another value for `ResourceType`, the request fails.

    To tag an AMI after it has been registered, see [CreateTags].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html

  • :dry_run (Boolean) —

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

    A name for your AMI.

    Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (‘), at-signs (@), or underscores(_)

  • :description (String) —

    A description for your AMI.

  • :architecture (String) —

    The architecture of the AMI.

    Default: For Amazon EBS-backed AMIs, ‘i386`. For instance store-backed AMIs, the architecture specified in the manifest file.

  • :kernel_id (String) —

    The ID of the kernel.

  • :ramdisk_id (String) —

    The ID of the RAM disk.

  • :root_device_name (String) —

    The device name of the root device volume (for example, ‘/dev/sda1`).

  • :block_device_mappings (Array<Types::BlockDeviceMapping>) —

    The block device mapping entries.

    If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can’t specify the encryption state of the volume.

    If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, [Amazon EBS local snapshots on Outposts] in the *Amazon EBS User Guide*.

    [1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#ami

  • :virtualization_type (String) —

    The type of virtualization (‘hvm` | `paravirtual`).

    Default: ‘paravirtual`

  • :sriov_net_support (String) —

    Set to ‘simple` to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

    There is no way to disable ‘sriovNetSupport` at this time.

    This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

  • :ena_support (Boolean) —

    Set to ‘true` to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

    This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Returns:

See Also:



54043
54044
54045
54046
 
# File 'lib/aws-sdk-ec2/client.rb', line 54043

def register_image(params = {}, options = {})
  req = build_request(:register_image, params)
  req.send_request(options)
end

#register_instance_event_notification_attributes(params = {}) ⇒ Types::RegisterInstanceEventNotificationAttributesResult

Registers a set of tag keys to include in scheduled event notifications for your resources.

To remove tags, use [DeregisterInstanceEventNotificationAttributes].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeregisterInstanceEventNotificationAttributes.html

Examples:

Request syntax with placeholder values


resp = client.register_instance_event_notification_attributes({
  dry_run: false,
  instance_tag_attribute: { # required
    include_all_tags_of_instance: false,
    instance_tag_keys: ["String"],
  },
})

Response structure


resp.instance_tag_attribute.instance_tag_keys #=> Array
resp.instance_tag_attribute.instance_tag_keys[0] #=> String
resp.instance_tag_attribute.include_all_tags_of_instance #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_tag_attribute (required, Types::RegisterInstanceTagAttributeRequest) —

    Information about the tag keys to register.

Returns:

See Also:



54091
54092
54093
54094
 
# File 'lib/aws-sdk-ec2/client.rb', line 54091

def register_instance_event_notification_attributes(params = {}, options = {})
  req = build_request(:register_instance_event_notification_attributes, params)
  req.send_request(options)
end

#register_transit_gateway_multicast_group_members(params = {}) ⇒ Types::RegisterTransitGatewayMulticastGroupMembersResult

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For more information, see [Multicast on transit gateways] in the *Amazon Web Services Transit Gateways Guide*.

After you add the members, use

SearchTransitGatewayMulticastGroups][2

to verify that the members

were added to the transit gateway multicast group.

[1]: docs.aws.amazon.com/vpc/latest/tgw/tgw-multicast-overview.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html

Examples:

Request syntax with placeholder values


resp = client.register_transit_gateway_multicast_group_members({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId", # required
  group_ip_address: "String",
  network_interface_ids: ["NetworkInterfaceId"], # required
  dry_run: false,
})

Response structure


resp.registered_multicast_group_members.transit_gateway_multicast_domain_id #=> String
resp.registered_multicast_group_members.registered_network_interface_ids #=> Array
resp.registered_multicast_group_members.registered_network_interface_ids[0] #=> String
resp.registered_multicast_group_members.group_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (required, String) —

    The ID of the transit gateway multicast domain.

  • :group_ip_address (String) —

    The IP address assigned to the transit gateway multicast group.

  • :network_interface_ids (required, Array<String>) —

    The group members’ network interface IDs to register with the transit gateway multicast group.

  • :dry_run (Boolean) —

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

Returns:

See Also:



54151
54152
54153
54154
 
# File 'lib/aws-sdk-ec2/client.rb', line 54151

def register_transit_gateway_multicast_group_members(params = {}, options = {})
  req = build_request(:register_transit_gateway_multicast_group_members, params)
  req.send_request(options)
end

#register_transit_gateway_multicast_group_sources(params = {}) ⇒ Types::RegisterTransitGatewayMulticastGroupSourcesResult

Registers sources (network interfaces) with the specified transit gateway multicast group.

A multicast source is a network interface attached to a supported instance that sends multicast traffic. For more information about supported instances, see [Multicast on transit gateways] in the *Amazon Web Services Transit Gateways Guide*.

After you add the source, use [SearchTransitGatewayMulticastGroups] to verify that the source was added to the multicast group.

[1]: docs.aws.amazon.com/vpc/latest/tgw/tgw-multicast-overview.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html

Examples:

Request syntax with placeholder values


resp = client.register_transit_gateway_multicast_group_sources({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId", # required
  group_ip_address: "String",
  network_interface_ids: ["NetworkInterfaceId"], # required
  dry_run: false,
})

Response structure


resp.registered_multicast_group_sources.transit_gateway_multicast_domain_id #=> String
resp.registered_multicast_group_sources.registered_network_interface_ids #=> Array
resp.registered_multicast_group_sources.registered_network_interface_ids[0] #=> String
resp.registered_multicast_group_sources.group_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (required, String) —

    The ID of the transit gateway multicast domain.

  • :group_ip_address (String) —

    The IP address assigned to the transit gateway multicast group.

  • :network_interface_ids (required, Array<String>) —

    The group sources’ network interface IDs to register with the transit gateway multicast group.

  • :dry_run (Boolean) —

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

Returns:

See Also:



54212
54213
54214
54215
 
# File 'lib/aws-sdk-ec2/client.rb', line 54212

def register_transit_gateway_multicast_group_sources(params = {}, options = {})
  req = build_request(:register_transit_gateway_multicast_group_sources, params)
  req.send_request(options)
end

#reject_capacity_reservation_billing_ownership(params = {}) ⇒ Types::RejectCapacityReservationBillingOwnershipResult

Rejects a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see [ Billing assignment for shared Amazon EC2 Capacity Reservations].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html

Examples:

Request syntax with placeholder values


resp = client.reject_capacity_reservation_billing_ownership({
  dry_run: false,
  capacity_reservation_id: "CapacityReservationId", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :capacity_reservation_id (required, String) —

    The ID of the Capacity Reservation for which to reject the request.

Returns:

See Also:



54253
54254
54255
54256
 
# File 'lib/aws-sdk-ec2/client.rb', line 54253

def reject_capacity_reservation_billing_ownership(params = {}, options = {})
  req = build_request(:reject_capacity_reservation_billing_ownership, params)
  req.send_request(options)
end

#reject_transit_gateway_multicast_domain_associations(params = {}) ⇒ Types::RejectTransitGatewayMulticastDomainAssociationsResult

Rejects a request to associate cross-account subnets with a transit gateway multicast domain.

Examples:

Request syntax with placeholder values


resp = client.reject_transit_gateway_multicast_domain_associations({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId",
  transit_gateway_attachment_id: "TransitGatewayAttachmentId",
  subnet_ids: ["String"],
  dry_run: false,
})

Response structure


resp.associations.transit_gateway_multicast_domain_id #=> String
resp.associations.transit_gateway_attachment_id #=> String
resp.associations.resource_id #=> String
resp.associations.resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.associations.resource_owner_id #=> String
resp.associations.subnets #=> Array
resp.associations.subnets[0].subnet_id #=> String
resp.associations.subnets[0].state #=> String, one of "pendingAcceptance", "associating", "associated", "disassociating", "disassociated", "rejected", "failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (String) —

    The ID of the transit gateway multicast domain.

  • :transit_gateway_attachment_id (String) —

    The ID of the transit gateway attachment.

  • :subnet_ids (Array<String>) —

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

  • :dry_run (Boolean) —

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

Returns:

See Also:



54305
54306
54307
54308
 
# File 'lib/aws-sdk-ec2/client.rb', line 54305

def reject_transit_gateway_multicast_domain_associations(params = {}, options = {})
  req = build_request(:reject_transit_gateway_multicast_domain_associations, params)
  req.send_request(options)
end

#reject_transit_gateway_peering_attachment(params = {}) ⇒ Types::RejectTransitGatewayPeeringAttachmentResult

Rejects a transit gateway peering attachment request.

Examples:

Request syntax with placeholder values


resp = client.reject_transit_gateway_peering_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_peering_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachment.accepter_transit_gateway_attachment_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachment.requester_tgw_info.region #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.transit_gateway_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.core_network_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.owner_id #=> String
resp.transit_gateway_peering_attachment.accepter_tgw_info.region #=> String
resp.transit_gateway_peering_attachment.options.dynamic_routing #=> String, one of "enable", "disable"
resp.transit_gateway_peering_attachment.status.code #=> String
resp.transit_gateway_peering_attachment.status.message #=> String
resp.transit_gateway_peering_attachment.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_peering_attachment.creation_time #=> Time
resp.transit_gateway_peering_attachment.tags #=> Array
resp.transit_gateway_peering_attachment.tags[0].key #=> String
resp.transit_gateway_peering_attachment.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the transit gateway peering attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



54357
54358
54359
54360
 
# File 'lib/aws-sdk-ec2/client.rb', line 54357

def reject_transit_gateway_peering_attachment(params = {}, options = {})
  req = build_request(:reject_transit_gateway_peering_attachment, params)
  req.send_request(options)
end

#reject_transit_gateway_vpc_attachment(params = {}) ⇒ Types::RejectTransitGatewayVpcAttachmentResult

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

The VPC attachment must be in the ‘pendingAcceptance` state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

Examples:

Request syntax with placeholder values


resp = client.reject_transit_gateway_vpc_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
  dry_run: false,
})

Response structure


resp.transit_gateway_vpc_attachment.transit_gateway_attachment_id #=> String
resp.transit_gateway_vpc_attachment.transit_gateway_id #=> String
resp.transit_gateway_vpc_attachment.vpc_id #=> String
resp.transit_gateway_vpc_attachment.vpc_owner_id #=> String
resp.transit_gateway_vpc_attachment.state #=> String, one of "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing"
resp.transit_gateway_vpc_attachment.subnet_ids #=> Array
resp.transit_gateway_vpc_attachment.subnet_ids[0] #=> String
resp.transit_gateway_vpc_attachment.creation_time #=> Time
resp.transit_gateway_vpc_attachment.options.dns_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.security_group_referencing_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.ipv_6_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.options.appliance_mode_support #=> String, one of "enable", "disable"
resp.transit_gateway_vpc_attachment.tags #=> Array
resp.transit_gateway_vpc_attachment.tags[0].key #=> String
resp.transit_gateway_vpc_attachment.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_attachment_id (required, String) —

    The ID of the attachment.

  • :dry_run (Boolean) —

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

Returns:

See Also:



54411
54412
54413
54414
 
# File 'lib/aws-sdk-ec2/client.rb', line 54411

def reject_transit_gateway_vpc_attachment(params = {}, options = {})
  req = build_request(:reject_transit_gateway_vpc_attachment, params)
  req.send_request(options)
end

#reject_vpc_endpoint_connections(params = {}) ⇒ Types::RejectVpcEndpointConnectionsResult

Rejects VPC endpoint connection requests to your VPC endpoint service.

Examples:

Request syntax with placeholder values


resp = client.reject_vpc_endpoint_connections({
  dry_run: false,
  service_id: "VpcEndpointServiceId", # required
  vpc_endpoint_ids: ["VpcEndpointId"], # required
})

Response structure


resp.unsuccessful #=> Array
resp.unsuccessful[0].error.code #=> String
resp.unsuccessful[0].error.message #=> String
resp.unsuccessful[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_id (required, String) —

    The ID of the service.

  • :vpc_endpoint_ids (required, Array<String>) —

    The IDs of the VPC endpoints.

Returns:

See Also:



54453
54454
54455
54456
 
# File 'lib/aws-sdk-ec2/client.rb', line 54453

def reject_vpc_endpoint_connections(params = {}, options = {})
  req = build_request(:reject_vpc_endpoint_connections, params)
  req.send_request(options)
end

#reject_vpc_peering_connection(params = {}) ⇒ Types::RejectVpcPeeringConnectionResult

Rejects a VPC peering connection request. The VPC peering connection must be in the ‘pending-acceptance` state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

Examples:

Request syntax with placeholder values


resp = client.reject_vpc_peering_connection({
  dry_run: false,
  vpc_peering_connection_id: "VpcPeeringConnectionId", # required
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :vpc_peering_connection_id (required, String) —

    The ID of the VPC peering connection.

Returns:

See Also:



54493
54494
54495
54496
 
# File 'lib/aws-sdk-ec2/client.rb', line 54493

def reject_vpc_peering_connection(params = {}, options = {})
  req = build_request(:reject_vpc_peering_connection, params)
  req.send_request(options)
end

#release_address(params = {}) ⇒ Struct

Releases the specified Elastic IP address.

[Default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it’s associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (‘InvalidIPAddress.InUse`).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you’ll get an ‘AuthFailure` error if the address is already allocated to another Amazon Web Services account.

After you release an Elastic IP address, you might be able to recover it. For more information, see AllocateAddress.

Examples:

Example: To release an Elastic IP address


# This example releases the specified Elastic IP address.

resp = client.release_address({
  allocation_id: "eipalloc-64d5890a", 
})

Request syntax with placeholder values


resp = client.release_address({
  allocation_id: "AllocationId",
  public_ip: "String",
  network_border_group: "String",
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_id (String) —

    The allocation ID. This parameter is required.

  • :public_ip (String) —

    Deprecated.

  • :network_border_group (String) —

    The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

    If you provide an incorrect network border group, you receive an ‘InvalidAddress.NotFound` error.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



54562
54563
54564
54565
 
# File 'lib/aws-sdk-ec2/client.rb', line 54562

def release_address(params = {}, options = {})
  req = build_request(:release_address, params)
  req.send_request(options)
end

#release_hosts(params = {}) ⇒ Types::ReleaseHostsResult

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into ‘released` state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.

Released hosts still appear in a DescribeHosts response.

Examples:

Request syntax with placeholder values


resp = client.release_hosts({
  host_ids: ["DedicatedHostId"], # required
})

Response structure


resp.successful #=> Array
resp.successful[0] #=> String
resp.unsuccessful #=> Array
resp.unsuccessful[0].error.code #=> String
resp.unsuccessful[0].error.message #=> String
resp.unsuccessful[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :host_ids (required, Array<String>) —

    The IDs of the Dedicated Hosts to release.

Returns:

See Also:



54608
54609
54610
54611
 
# File 'lib/aws-sdk-ec2/client.rb', line 54608

def release_hosts(params = {}, options = {})
  req = build_request(:release_hosts, params)
  req.send_request(options)
end

#release_ipam_pool_allocation(params = {}) ⇒ Types::ReleaseIpamPoolAllocationResult

Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using [ModifyIpamResourceCidr]. For more information, see

Release an allocation][2

in the *Amazon VPC IPAM User Guide*.

<note markdown=“1”> All EC2 API actions follow an [eventual consistency] model.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyIpamResourceCidr.html [2]: docs.aws.amazon.com/vpc/latest/ipam/release-alloc-ipam.html [3]: docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html

Examples:

Request syntax with placeholder values


resp = client.release_ipam_pool_allocation({
  dry_run: false,
  ipam_pool_id: "IpamPoolId", # required
  cidr: "String", # required
  ipam_pool_allocation_id: "IpamPoolAllocationId", # required
})

Response structure


resp.success #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (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`.

  • :ipam_pool_id (required, String) —

    The ID of the IPAM pool which contains the allocation you want to release.

  • :cidr (required, String) —

    The CIDR of the allocation you want to release.

  • :ipam_pool_allocation_id (required, String) —

    The ID of the allocation.

Returns:

See Also:



54668
54669
54670
54671
 
# File 'lib/aws-sdk-ec2/client.rb', line 54668

def release_ipam_pool_allocation(params = {}, options = {})
  req = build_request(:release_ipam_pool_allocation, params)
  req.send_request(options)
end

#replace_iam_instance_profile_association(params = {}) ⇒ Types::ReplaceIamInstanceProfileAssociationResult

Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that’s associated with an instance without having to disassociate the existing IAM instance profile first.

Use DescribeIamInstanceProfileAssociations to get the association ID.

Examples:

Request syntax with placeholder values


resp = client.replace_iam_instance_profile_association({
  iam_instance_profile: { # required
    arn: "String",
    name: "String",
  },
  association_id: "IamInstanceProfileAssociationId", # required
})

Response structure


resp.iam_instance_profile_association.association_id #=> String
resp.iam_instance_profile_association.instance_id #=> String
resp.iam_instance_profile_association.iam_instance_profile.arn #=> String
resp.iam_instance_profile_association.iam_instance_profile.id #=> String
resp.iam_instance_profile_association.state #=> String, one of "associating", "associated", "disassociating", "disassociated"
resp.iam_instance_profile_association.timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :iam_instance_profile (required, Types::IamInstanceProfileSpecification) —

    The IAM instance profile.

  • :association_id (required, String) —

    The ID of the existing IAM instance profile association.

Returns:

See Also:



54713
54714
54715
54716
 
# File 'lib/aws-sdk-ec2/client.rb', line 54713

def replace_iam_instance_profile_association(params = {}, options = {})
  req = build_request(:replace_iam_instance_profile_association, params)
  req.send_request(options)
end

#replace_network_acl_association(params = {}) ⇒ Types::ReplaceNetworkAclAssociationResult

Changes which network ACL a subnet is associated with. By default when you create a subnet, it’s automatically associated with the default network ACL. For more information, see [Network ACLs] in the *Amazon VPC User Guide*.

This is an idempotent operation.

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html

Examples:

Example: To replace the network ACL associated with a subnet


# This example associates the specified network ACL with the subnet for the specified network ACL association.

resp = client.replace_network_acl_association({
  association_id: "aclassoc-e5b95c8c", 
  network_acl_id: "acl-5fb85d36", 
})

resp.to_h outputs the following:
{
  new_association_id: "aclassoc-3999875b", 
}

Request syntax with placeholder values


resp = client.replace_network_acl_association({
  dry_run: false,
  association_id: "NetworkAclAssociationId", # required
  network_acl_id: "NetworkAclId", # required
})

Response structure


resp.new_association_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :association_id (required, String) —

    The ID of the current association between the original network ACL and the subnet.

  • :network_acl_id (required, String) —

    The ID of the new network ACL to associate with the subnet.

Returns:

See Also:



54777
54778
54779
54780
 
# File 'lib/aws-sdk-ec2/client.rb', line 54777

def replace_network_acl_association(params = {}, options = {})
  req = build_request(:replace_network_acl_association, params)
  req.send_request(options)
end

#replace_network_acl_entry(params = {}) ⇒ Struct

Replaces an entry (rule) in a network ACL. For more information, see

Network ACLs][1

in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html

Examples:

Example: To replace a network ACL entry


# This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from
# 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.

resp = client.replace_network_acl_entry({
  cidr_block: "203.0.113.12/24", 
  egress: false, 
  network_acl_id: "acl-5fb85d36", 
  port_range: {
    from: 53, 
    to: 53, 
  }, 
  protocol: "17", 
  rule_action: "allow", 
  rule_number: 100, 
})

Request syntax with placeholder values


resp = client.replace_network_acl_entry({
  dry_run: false,
  network_acl_id: "NetworkAclId", # required
  rule_number: 1, # required
  protocol: "String", # required
  rule_action: "allow", # required, accepts allow, deny
  egress: false, # required
  cidr_block: "String",
  ipv_6_cidr_block: "String",
  icmp_type_code: {
    code: 1,
    type: 1,
  },
  port_range: {
    from: 1,
    to: 1,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_acl_id (required, String) —

    The ID of the ACL.

  • :rule_number (required, Integer) —

    The rule number of the entry to replace.

  • :protocol (required, 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.

  • :rule_action (required, String) —

    Indicates whether to allow or deny the traffic that matches the rule.

  • :egress (required, Boolean) —

    Indicates whether to replace the egress rule.

    Default: If no value is specified, we replace the ingress rule.

  • :cidr_block (String) —

    The IPv4 network range to allow or deny, in CIDR notation (for example ‘172.16.0.0/24`).

  • :ipv_6_cidr_block (String) —

    The IPv6 network range to allow or deny, in CIDR notation (for example ‘2001:bd8:1234:1a00::/64`).

  • :icmp_type_code (Types::IcmpTypeCode) —

    ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

  • :port_range (Types::PortRange) —

    TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



54882
54883
54884
54885
 
# File 'lib/aws-sdk-ec2/client.rb', line 54882

def replace_network_acl_entry(params = {}, options = {})
  req = build_request(:replace_network_acl_entry, params)
  req.send_request(options)
end

#replace_route(params = {}) ⇒ Struct

Replaces an existing route within a route table in a VPC.

You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target.

For more information, see [Route tables] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html

Examples:

Example: To replace a route


# This example replaces the specified route in the specified table table. The new route matches the specified CIDR and
# sends the traffic to the specified virtual private gateway.

resp = client.replace_route({
  destination_cidr_block: "10.0.0.0/16", 
  gateway_id: "vgw-9a4cacf3", 
  route_table_id: "rtb-22574640", 
})

Request syntax with placeholder values


resp = client.replace_route({
  destination_prefix_list_id: "PrefixListResourceId",
  vpc_endpoint_id: "VpcEndpointId",
  local_target: false,
  transit_gateway_id: "TransitGatewayId",
  local_gateway_id: "LocalGatewayId",
  carrier_gateway_id: "CarrierGatewayId",
  core_network_arn: "CoreNetworkArn",
  dry_run: false,
  route_table_id: "RouteTableId", # required
  destination_cidr_block: "String",
  gateway_id: "RouteGatewayId",
  destination_ipv_6_cidr_block: "String",
  egress_only_internet_gateway_id: "EgressOnlyInternetGatewayId",
  instance_id: "InstanceId",
  network_interface_id: "NetworkInterfaceId",
  vpc_peering_connection_id: "VpcPeeringConnectionId",
  nat_gateway_id: "NatGatewayId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_prefix_list_id (String) —

    The ID of the prefix list for the route.

  • :vpc_endpoint_id (String) —

    The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

  • :local_target (Boolean) —

    Specifies whether to reset the local route to its default target (‘local`).

  • :transit_gateway_id (String) —

    The ID of a transit gateway.

  • :local_gateway_id (String) —

    The ID of the local gateway.

  • :carrier_gateway_id (String) —

    [IPv4 traffic only] The ID of a carrier gateway.

  • :core_network_arn (String) —

    The Amazon Resource Name (ARN) of the core network.

  • :dry_run (Boolean) —

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

  • :route_table_id (required, String) —

    The ID of the route table.

  • :destination_cidr_block (String) —

    The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

  • :gateway_id (String) —

    The ID of an internet gateway or virtual private gateway.

  • :destination_ipv_6_cidr_block (String) —

    The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

  • :egress_only_internet_gateway_id (String) —

    [IPv6 traffic only] The ID of an egress-only internet gateway.

  • :instance_id (String) —

    The ID of a NAT instance in your VPC.

  • :network_interface_id (String) —

    The ID of a network interface.

  • :vpc_peering_connection_id (String) —

    The ID of a VPC peering connection.

  • :nat_gateway_id (String) —

    [IPv4 traffic only] The ID of a NAT gateway.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



55000
55001
55002
55003
 
# File 'lib/aws-sdk-ec2/client.rb', line 55000

def replace_route(params = {}, options = {})
  req = build_request(:replace_route, params)
  req.send_request(options)
end

#replace_route_table_association(params = {}) ⇒ Types::ReplaceRouteTableAssociationResult

Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see [Route tables] in the *Amazon VPC User Guide*.

You can also use this operation to change which table is the main route table in the VPC. Specify the main route table’s association ID and the route table ID of the new main route table.

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html

Examples:

Example: To replace the route table associated with a subnet


# This example associates the specified route table with the subnet for the specified route table association.

resp = client.replace_route_table_association({
  association_id: "rtbassoc-781d0d1a", 
  route_table_id: "rtb-22574640", 
})

resp.to_h outputs the following:
{
  new_association_id: "rtbassoc-3a1f0f58", 
}

Request syntax with placeholder values


resp = client.replace_route_table_association({
  dry_run: false,
  association_id: "RouteTableAssociationId", # required
  route_table_id: "RouteTableId", # required
})

Response structure


resp.new_association_id #=> String
resp.association_state.state #=> String, one of "associating", "associated", "disassociating", "disassociated", "failed"
resp.association_state.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :association_id (required, String) —

    The association ID.

  • :route_table_id (required, String) —

    The ID of the new route table to associate with the subnet.

Returns:

See Also:



55069
55070
55071
55072
 
# File 'lib/aws-sdk-ec2/client.rb', line 55069

def replace_route_table_association(params = {}, options = {})
  req = build_request(:replace_route_table_association, params)
  req.send_request(options)
end

#replace_transit_gateway_route(params = {}) ⇒ Types::ReplaceTransitGatewayRouteResult

Replaces the specified route in the specified transit gateway route table.

Examples:

Request syntax with placeholder values


resp = client.replace_transit_gateway_route({
  destination_cidr_block: "String", # required
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  transit_gateway_attachment_id: "TransitGatewayAttachmentId",
  blackhole: false,
  dry_run: false,
})

Response structure


resp.route.destination_cidr_block #=> String
resp.route.prefix_list_id #=> String
resp.route.transit_gateway_route_table_announcement_id #=> String
resp.route.transit_gateway_attachments #=> Array
resp.route.transit_gateway_attachments[0].resource_id #=> String
resp.route.transit_gateway_attachments[0].transit_gateway_attachment_id #=> String
resp.route.transit_gateway_attachments[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.route.type #=> String, one of "static", "propagated"
resp.route.state #=> String, one of "pending", "active", "blackhole", "deleting", "deleted"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_cidr_block (required, String) —

    The CIDR range used for the destination match. Routing decisions are based on the most specific match.

  • :transit_gateway_route_table_id (required, String) —

    The ID of the route table.

  • :transit_gateway_attachment_id (String) —

    The ID of the attachment.

  • :blackhole (Boolean) —

    Indicates whether traffic matching this route is to be dropped.

  • :dry_run (Boolean) —

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

Returns:

See Also:



55126
55127
55128
55129
 
# File 'lib/aws-sdk-ec2/client.rb', line 55126

def replace_transit_gateway_route(params = {}, options = {})
  req = build_request(:replace_transit_gateway_route, params)
  req.send_request(options)
end

#replace_vpn_tunnel(params = {}) ⇒ Types::ReplaceVpnTunnelResult

Trigger replacement of specified VPN tunnel.

Examples:

Request syntax with placeholder values


resp = client.replace_vpn_tunnel({
  vpn_connection_id: "VpnConnectionId", # required
  vpn_tunnel_outside_ip_address: "String", # required
  apply_pending_maintenance: false,
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpn_connection_id (required, String) —

    The ID of the Site-to-Site VPN connection.

  • :vpn_tunnel_outside_ip_address (required, String) —

    The external IP address of the VPN tunnel.

  • :apply_pending_maintenance (Boolean) —

    Trigger pending tunnel endpoint maintenance.

  • :dry_run (Boolean) —

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

Returns:

See Also:



55169
55170
55171
55172
 
# File 'lib/aws-sdk-ec2/client.rb', line 55169

def replace_vpn_tunnel(params = {}, options = {})
  req = build_request(:replace_vpn_tunnel, params)
  req.send_request(options)
end

#report_instance_status(params = {}) ⇒ Struct

Submits feedback about the status of an instance. The instance must be in the ‘running` state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

Examples:

Request syntax with placeholder values


resp = client.report_instance_status({
  dry_run: false,
  instances: ["InstanceId"], # required
  status: "ok", # required, accepts ok, impaired
  start_time: Time.now,
  end_time: Time.now,
  reason_codes: ["instance-stuck-in-state"], # required, accepts instance-stuck-in-state, unresponsive, not-accepting-credentials, password-not-available, performance-network, performance-instance-store, performance-ebs-volume, performance-other, other
  description: "ReportInstanceStatusRequestDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instances (required, Array<String>) —

    The instances.

  • :status (required, String) —

    The status of all instances listed.

  • :start_time (Time, DateTime, Date, Integer, String) —

    The time at which the reported instance health state began.

  • :end_time (Time, DateTime, Date, Integer, String) —

    The time at which the reported instance health state ended.

  • :reason_codes (required, Array<String>) —

    The reason codes that describe the health state of your instance.

    • ‘instance-stuck-in-state`: My instance is stuck in a state.

    • ‘unresponsive`: My instance is unresponsive.

    • ‘not-accepting-credentials`: My instance is not accepting my credentials.

    • ‘password-not-available`: A password is not available for my instance.

    • ‘performance-network`: My instance is experiencing performance problems that I believe are network related.

    • ‘performance-instance-store`: My instance is experiencing performance problems that I believe are related to the instance stores.

    • ‘performance-ebs-volume`: My instance is experiencing performance problems that I believe are related to an EBS volume.

    • ‘performance-other`: My instance is experiencing performance problems.

    • ‘other`: [explain using the description parameter]

  • :description (String) —

    Descriptive text about the health state of your instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



55251
55252
55253
55254
 
# File 'lib/aws-sdk-ec2/client.rb', line 55251

def report_instance_status(params = {}, options = {})
  req = build_request(:report_instance_status, params)
  req.send_request(options)
end

#request_spot_fleet(params = {}) ⇒ Types::RequestSpotFleetResponse

Creates a Spot Fleet request.

The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the ‘spot-fleet-request` and `instance` resource types are supported.

For more information, see [Spot Fleet requests] in the *Amazon EC2 User Guide*.

We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see [Which is the best Spot request method to use?] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-best-practices.html#which-spot-request-method-to-use

Examples:

Example: To request a Spot fleet in the subnet with the lowest price


# This example creates a Spot fleet request with two launch specifications that differ only by subnet. The Spot fleet
# launches the instances in the specified subnet with the lowest price. If the instances are launched in a default VPC,
# they receive a public IP address by default. If the instances are launched in a nondefault VPC, they do not receive a
# public IP address by default. Note that you can't specify different subnets from the same Availability Zone in a Spot
# fleet request.

resp = client.request_spot_fleet({
  spot_fleet_request_config: {
    iam_fleet_role: "arn:aws:iam::123456789012:role/my-spot-fleet-role", 
    launch_specifications: [
      {
        iam_instance_profile: {
          arn: "arn:aws:iam::123456789012:instance-profile/my-iam-role", 
        }, 
        image_id: "ami-1a2b3c4d", 
        instance_type: "m3.medium", 
        key_name: "my-key-pair", 
        security_groups: [
          {
            group_id: "sg-1a2b3c4d", 
          }, 
        ], 
        subnet_id: "subnet-1a2b3c4d, subnet-3c4d5e6f", 
      }, 
    ], 
    spot_price: "0.04", 
    target_capacity: 2, 
  }, 
})

resp.to_h outputs the following:
{
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
}

Example: To request a Spot fleet in the Availability Zone with the lowest price


# This example creates a Spot fleet request with two launch specifications that differ only by Availability Zone. The Spot
# fleet launches the instances in the specified Availability Zone with the lowest price. If your account supports EC2-VPC
# only, Amazon EC2 launches the Spot instances in the default subnet of the Availability Zone.

resp = client.request_spot_fleet({
  spot_fleet_request_config: {
    iam_fleet_role: "arn:aws:iam::123456789012:role/my-spot-fleet-role", 
    launch_specifications: [
      {
        iam_instance_profile: {
          arn: "arn:aws:iam::123456789012:instance-profile/my-iam-role", 
        }, 
        image_id: "ami-1a2b3c4d", 
        instance_type: "m3.medium", 
        key_name: "my-key-pair", 
        placement: {
          availability_zone: "us-west-2a, us-west-2b", 
        }, 
        security_groups: [
          {
            group_id: "sg-1a2b3c4d", 
          }, 
        ], 
      }, 
    ], 
    spot_price: "0.04", 
    target_capacity: 2, 
  }, 
})

resp.to_h outputs the following:
{
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
}

Example: To launch Spot instances in a subnet and assign them public IP addresses


# This example assigns public addresses to instances launched in a nondefault VPC. Note that when you specify a network
# interface, you must include the subnet ID and security group ID using the network interface.

resp = client.request_spot_fleet({
  spot_fleet_request_config: {
    iam_fleet_role: "arn:aws:iam::123456789012:role/my-spot-fleet-role", 
    launch_specifications: [
      {
        iam_instance_profile: {
          arn: "arn:aws:iam::880185128111:instance-profile/my-iam-role", 
        }, 
        image_id: "ami-1a2b3c4d", 
        instance_type: "m3.medium", 
        key_name: "my-key-pair", 
        network_interfaces: [
          {
            associate_public_ip_address: true, 
            device_index: 0, 
            groups: [
              "sg-1a2b3c4d", 
            ], 
            subnet_id: "subnet-1a2b3c4d", 
          }, 
        ], 
      }, 
    ], 
    spot_price: "0.04", 
    target_capacity: 2, 
  }, 
})

resp.to_h outputs the following:
{
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
}

Example: To request a Spot fleet using the diversified allocation strategy


# This example creates a Spot fleet request that launches 30 instances using the diversified allocation strategy. The
# launch specifications differ by instance type. The Spot fleet distributes the instances across the launch specifications
# such that there are 10 instances of each type.

resp = client.request_spot_fleet({
  spot_fleet_request_config: {
    allocation_strategy: "diversified", 
    iam_fleet_role: "arn:aws:iam::123456789012:role/my-spot-fleet-role", 
    launch_specifications: [
      {
        image_id: "ami-1a2b3c4d", 
        instance_type: "c4.2xlarge", 
        subnet_id: "subnet-1a2b3c4d", 
      }, 
      {
        image_id: "ami-1a2b3c4d", 
        instance_type: "m3.2xlarge", 
        subnet_id: "subnet-1a2b3c4d", 
      }, 
      {
        image_id: "ami-1a2b3c4d", 
        instance_type: "r3.2xlarge", 
        subnet_id: "subnet-1a2b3c4d", 
      }, 
    ], 
    spot_price: "0.70", 
    target_capacity: 30, 
  }, 
})

resp.to_h outputs the following:
{
  spot_fleet_request_id: "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", 
}

Request syntax with placeholder values


resp = client.request_spot_fleet({
  dry_run: false,
  spot_fleet_request_config: { # required
    allocation_strategy: "lowestPrice", # accepts lowestPrice, diversified, capacityOptimized, capacityOptimizedPrioritized, priceCapacityOptimized
    on_demand_allocation_strategy: "lowestPrice", # accepts lowestPrice, prioritized
    spot_maintenance_strategies: {
      capacity_rebalance: {
        replacement_strategy: "launch", # accepts launch, launch-before-terminate
        termination_delay: 1,
      },
    },
    client_token: "String",
    excess_capacity_termination_policy: "noTermination", # accepts noTermination, default
    fulfilled_capacity: 1.0,
    on_demand_fulfilled_capacity: 1.0,
    iam_fleet_role: "String", # required
    launch_specifications: [
      {
        addressing_type: "String",
        block_device_mappings: [
          {
            ebs: {
              delete_on_termination: false,
              iops: 1,
              snapshot_id: "SnapshotId",
              volume_size: 1,
              volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
              kms_key_id: "String",
              throughput: 1,
              outpost_arn: "String",
              encrypted: false,
            },
            no_device: "String",
            device_name: "String",
            virtual_name: "String",
          },
        ],
        ebs_optimized: false,
        iam_instance_profile: {
          arn: "String",
          name: "String",
        },
        image_id: "ImageId",
        instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
        kernel_id: "String",
        key_name: "KeyPairName",
        monitoring: {
          enabled: false,
        },
        network_interfaces: [
          {
            associate_public_ip_address: false,
            delete_on_termination: false,
            description: "String",
            device_index: 1,
            groups: ["SecurityGroupId"],
            ipv_6_address_count: 1,
            ipv_6_addresses: [
              {
                ipv_6_address: "String",
                is_primary_ipv_6: false,
              },
            ],
            network_interface_id: "NetworkInterfaceId",
            private_ip_address: "String",
            private_ip_addresses: [
              {
                primary: false,
                private_ip_address: "String",
              },
            ],
            secondary_private_ip_address_count: 1,
            subnet_id: "String",
            associate_carrier_ip_address: false,
            interface_type: "String",
            network_card_index: 1,
            ipv_4_prefixes: [
              {
                ipv_4_prefix: "String",
              },
            ],
            ipv_4_prefix_count: 1,
            ipv_6_prefixes: [
              {
                ipv_6_prefix: "String",
              },
            ],
            ipv_6_prefix_count: 1,
            primary_ipv_6: false,
            ena_srd_specification: {
              ena_srd_enabled: false,
              ena_srd_udp_specification: {
                ena_srd_udp_enabled: false,
              },
            },
            connection_tracking_specification: {
              tcp_established_timeout: 1,
              udp_stream_timeout: 1,
              udp_timeout: 1,
            },
          },
        ],
        placement: {
          availability_zone: "String",
          group_name: "PlacementGroupName",
          tenancy: "default", # accepts default, dedicated, host
        },
        ramdisk_id: "String",
        spot_price: "String",
        subnet_id: "SubnetId",
        user_data: "SensitiveUserData",
        weighted_capacity: 1.0,
        tag_specifications: [
          {
            resource_type: "capacity-reservation", # accepts 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: "String",
              },
            ],
          },
        ],
        instance_requirements: {
          v_cpu_count: {
            min: 1,
            max: 1,
          },
          memory_mi_b: {
            min: 1,
            max: 1,
          },
          cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
          memory_gi_b_per_v_cpu: {
            min: 1.0,
            max: 1.0,
          },
          excluded_instance_types: ["ExcludedInstanceType"],
          instance_generations: ["current"], # accepts current, previous
          spot_max_price_percentage_over_lowest_price: 1,
          on_demand_max_price_percentage_over_lowest_price: 1,
          bare_metal: "included", # accepts included, required, excluded
          burstable_performance: "included", # accepts included, required, excluded
          require_hibernate_support: false,
          network_interface_count: {
            min: 1,
            max: 1,
          },
          local_storage: "included", # accepts included, required, excluded
          local_storage_types: ["hdd"], # accepts hdd, ssd
          total_local_storage_gb: {
            min: 1.0,
            max: 1.0,
          },
          baseline_ebs_bandwidth_mbps: {
            min: 1,
            max: 1,
          },
          accelerator_types: ["gpu"], # accepts gpu, fpga, inference
          accelerator_count: {
            min: 1,
            max: 1,
          },
          accelerator_manufacturers: ["amazon-web-services"], # accepts amazon-web-services, amd, nvidia, xilinx, habana
          accelerator_names: ["a100"], # accepts a100, inferentia, k520, k80, m60, radeon-pro-v520, t4, vu9p, v100, a10g, h100, t4g
          accelerator_total_memory_mi_b: {
            min: 1,
            max: 1,
          },
          network_bandwidth_gbps: {
            min: 1.0,
            max: 1.0,
          },
          allowed_instance_types: ["AllowedInstanceType"],
          max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
        },
        security_groups: [
          {
            group_id: "String",
            group_name: "String",
          },
        ],
      },
    ],
    launch_template_configs: [
      {
        launch_template_specification: {
          launch_template_id: "String",
          launch_template_name: "LaunchTemplateName",
          version: "String",
        },
        overrides: [
          {
            instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
            spot_price: "String",
            subnet_id: "SubnetId",
            availability_zone: "String",
            weighted_capacity: 1.0,
            priority: 1.0,
            instance_requirements: {
              v_cpu_count: {
                min: 1,
                max: 1,
              },
              memory_mi_b: {
                min: 1,
                max: 1,
              },
              cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
              memory_gi_b_per_v_cpu: {
                min: 1.0,
                max: 1.0,
              },
              excluded_instance_types: ["ExcludedInstanceType"],
              instance_generations: ["current"], # accepts current, previous
              spot_max_price_percentage_over_lowest_price: 1,
              on_demand_max_price_percentage_over_lowest_price: 1,
              bare_metal: "included", # accepts included, required, excluded
              burstable_performance: "included", # accepts included, required, excluded
              require_hibernate_support: false,
              network_interface_count: {
                min: 1,
                max: 1,
              },
              local_storage: "included", # accepts included, required, excluded
              local_storage_types: ["hdd"], # accepts hdd, ssd
              total_local_storage_gb: {
                min: 1.0,
                max: 1.0,
              },
              baseline_ebs_bandwidth_mbps: {
                min: 1,
                max: 1,
              },
              accelerator_types: ["gpu"], # accepts gpu, fpga, inference
              accelerator_count: {
                min: 1,
                max: 1,
              },
              accelerator_manufacturers: ["amazon-web-services"], # accepts amazon-web-services, amd, nvidia, xilinx, habana
              accelerator_names: ["a100"], # accepts a100, inferentia, k520, k80, m60, radeon-pro-v520, t4, vu9p, v100, a10g, h100, t4g
              accelerator_total_memory_mi_b: {
                min: 1,
                max: 1,
              },
              network_bandwidth_gbps: {
                min: 1.0,
                max: 1.0,
              },
              allowed_instance_types: ["AllowedInstanceType"],
              max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
            },
          },
        ],
      },
    ],
    spot_price: "String",
    target_capacity: 1, # required
    on_demand_target_capacity: 1,
    on_demand_max_total_price: "String",
    spot_max_total_price: "String",
    terminate_instances_with_expiration: false,
    type: "request", # accepts request, maintain, instant
    valid_from: Time.now,
    valid_until: Time.now,
    replace_unhealthy_instances: false,
    instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
    load_balancers_config: {
      classic_load_balancers_config: {
        classic_load_balancers: [
          {
            name: "String",
          },
        ],
      },
      target_groups_config: {
        target_groups: [
          {
            arn: "String",
          },
        ],
      },
    },
    instance_pools_to_use_count: 1,
    context: "String",
    target_capacity_unit_type: "vcpu", # accepts vcpu, memory-mib, units
    tag_specifications: [
      {
        resource_type: "capacity-reservation", # accepts 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: "String",
          },
        ],
      },
    ],
  },
})

Response structure


resp.spot_fleet_request_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :spot_fleet_request_config (required, Types::SpotFleetRequestConfigData) —

    The configuration for the Spot Fleet request.

Returns:

See Also:



55769
55770
55771
55772
 
# File 'lib/aws-sdk-ec2/client.rb', line 55769

def request_spot_fleet(params = {}, options = {})
  req = build_request(:request_spot_fleet, params)
  req.send_request(options)
end

#request_spot_instances(params = {}) ⇒ Types::RequestSpotInstancesResult

Creates a Spot Instance request.

For more information, see [Work with Spot Instance] in the *Amazon EC2 User Guide*.

We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see [Which is the best Spot request method to use?] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-best-practices.html#which-spot-request-method-to-use

Examples:

Example: To create a one-time Spot Instance request


# This example creates a one-time Spot Instance request for five instances in the specified Availability Zone. If your
# account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability
# Zone.

resp = client.request_spot_instances({
  instance_count: 5, 
  launch_specification: {
    iam_instance_profile: {
      arn: "arn:aws:iam::123456789012:instance-profile/my-iam-role", 
    }, 
    image_id: "ami-1a2b3c4d", 
    instance_type: "m3.medium", 
    key_name: "my-key-pair", 
    placement: {
      availability_zone: "us-west-2a", 
    }, 
    security_group_ids: [
      "sg-1a2b3c4d", 
    ], 
  }, 
  spot_price: "0.03", 
  type: "one-time", 
})

Example: To create a one-time Spot Instance request


# This example command creates a one-time Spot Instance request for five instances in the specified subnet. Amazon EC2
# launches the instances in the specified subnet. If the VPC is a nondefault VPC, the instances do not receive a public IP
# address by default.

resp = client.request_spot_instances({
  instance_count: 5, 
  launch_specification: {
    iam_instance_profile: {
      arn: "arn:aws:iam::123456789012:instance-profile/my-iam-role", 
    }, 
    image_id: "ami-1a2b3c4d", 
    instance_type: "m3.medium", 
    security_group_ids: [
      "sg-1a2b3c4d", 
    ], 
    subnet_id: "subnet-1a2b3c4d", 
  }, 
  spot_price: "0.050", 
  type: "one-time", 
})

Request syntax with placeholder values


resp = client.request_spot_instances({
  launch_specification: {
    security_group_ids: ["SecurityGroupId"],
    security_groups: ["String"],
    addressing_type: "String",
    block_device_mappings: [
      {
        ebs: {
          delete_on_termination: false,
          iops: 1,
          snapshot_id: "SnapshotId",
          volume_size: 1,
          volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
          kms_key_id: "String",
          throughput: 1,
          outpost_arn: "String",
          encrypted: false,
        },
        no_device: "String",
        device_name: "String",
        virtual_name: "String",
      },
    ],
    ebs_optimized: false,
    iam_instance_profile: {
      arn: "String",
      name: "String",
    },
    image_id: "ImageId",
    instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
    kernel_id: "KernelId",
    key_name: "KeyPairName",
    monitoring: {
      enabled: false, # required
    },
    network_interfaces: [
      {
        associate_public_ip_address: false,
        delete_on_termination: false,
        description: "String",
        device_index: 1,
        groups: ["SecurityGroupId"],
        ipv_6_address_count: 1,
        ipv_6_addresses: [
          {
            ipv_6_address: "String",
            is_primary_ipv_6: false,
          },
        ],
        network_interface_id: "NetworkInterfaceId",
        private_ip_address: "String",
        private_ip_addresses: [
          {
            primary: false,
            private_ip_address: "String",
          },
        ],
        secondary_private_ip_address_count: 1,
        subnet_id: "String",
        associate_carrier_ip_address: false,
        interface_type: "String",
        network_card_index: 1,
        ipv_4_prefixes: [
          {
            ipv_4_prefix: "String",
          },
        ],
        ipv_4_prefix_count: 1,
        ipv_6_prefixes: [
          {
            ipv_6_prefix: "String",
          },
        ],
        ipv_6_prefix_count: 1,
        primary_ipv_6: false,
        ena_srd_specification: {
          ena_srd_enabled: false,
          ena_srd_udp_specification: {
            ena_srd_udp_enabled: false,
          },
        },
        connection_tracking_specification: {
          tcp_established_timeout: 1,
          udp_stream_timeout: 1,
          udp_timeout: 1,
        },
      },
    ],
    placement: {
      availability_zone: "String",
      group_name: "PlacementGroupName",
      tenancy: "default", # accepts default, dedicated, host
    },
    ramdisk_id: "RamdiskId",
    subnet_id: "SubnetId",
    user_data: "SensitiveUserData",
  },
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
  dry_run: false,
  spot_price: "String",
  client_token: "String",
  instance_count: 1,
  type: "one-time", # accepts one-time, persistent
  valid_from: Time.now,
  valid_until: Time.now,
  launch_group: "String",
  availability_zone_group: "String",
  block_duration_minutes: 1,
})

Response structure


resp.spot_instance_requests #=> Array
resp.spot_instance_requests[0].actual_block_hourly_price #=> String
resp.spot_instance_requests[0].availability_zone_group #=> String
resp.spot_instance_requests[0].block_duration_minutes #=> Integer
resp.spot_instance_requests[0].create_time #=> Time
resp.spot_instance_requests[0].fault.code #=> String
resp.spot_instance_requests[0].fault.message #=> String
resp.spot_instance_requests[0].instance_id #=> String
resp.spot_instance_requests[0].launch_group #=> String
resp.spot_instance_requests[0].launch_specification.user_data #=> String
resp.spot_instance_requests[0].launch_specification.addressing_type #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings #=> Array
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.iops #=> Integer
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.snapshot_id #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.volume_size #=> Integer
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.kms_key_id #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.throughput #=> Integer
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.outpost_arn #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].ebs.encrypted #=> Boolean
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].no_device #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].device_name #=> String
resp.spot_instance_requests[0].launch_specification.block_device_mappings[0].virtual_name #=> String
resp.spot_instance_requests[0].launch_specification.ebs_optimized #=> Boolean
resp.spot_instance_requests[0].launch_specification.iam_instance_profile.arn #=> String
resp.spot_instance_requests[0].launch_specification.iam_instance_profile.name #=> String
resp.spot_instance_requests[0].launch_specification.image_id #=> String
resp.spot_instance_requests[0].launch_specification.instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.spot_instance_requests[0].launch_specification.kernel_id #=> String
resp.spot_instance_requests[0].launch_specification.key_name #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].associate_public_ip_address #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].delete_on_termination #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].description #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].device_index #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].groups #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].groups[0] #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_address_count #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_addresses #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_addresses[0].ipv_6_address #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].network_interface_id #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].private_ip_address #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].private_ip_addresses #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].private_ip_addresses[0].primary #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].secondary_private_ip_address_count #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].subnet_id #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].associate_carrier_ip_address #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].interface_type #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].network_card_index #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_4_prefixes #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_4_prefix_count #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_prefixes #=> Array
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ipv_6_prefix_count #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].primary_ipv_6 #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ena_srd_specification.ena_srd_enabled #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].connection_tracking_specification.tcp_established_timeout #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].connection_tracking_specification.udp_stream_timeout #=> Integer
resp.spot_instance_requests[0].launch_specification.network_interfaces[0].connection_tracking_specification.udp_timeout #=> Integer
resp.spot_instance_requests[0].launch_specification.placement.availability_zone #=> String
resp.spot_instance_requests[0].launch_specification.placement.group_name #=> String
resp.spot_instance_requests[0].launch_specification.placement.tenancy #=> String, one of "default", "dedicated", "host"
resp.spot_instance_requests[0].launch_specification.ramdisk_id #=> String
resp.spot_instance_requests[0].launch_specification.subnet_id #=> String
resp.spot_instance_requests[0].launch_specification.security_groups #=> Array
resp.spot_instance_requests[0].launch_specification.security_groups[0].group_id #=> String
resp.spot_instance_requests[0].launch_specification.security_groups[0].group_name #=> String
resp.spot_instance_requests[0].launch_specification.monitoring.enabled #=> Boolean
resp.spot_instance_requests[0].launched_availability_zone #=> String
resp.spot_instance_requests[0].product_description #=> String, one of "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)"
resp.spot_instance_requests[0].spot_instance_request_id #=> String
resp.spot_instance_requests[0].spot_price #=> String
resp.spot_instance_requests[0].state #=> String, one of "open", "active", "closed", "cancelled", "failed", "disabled"
resp.spot_instance_requests[0].status.code #=> String
resp.spot_instance_requests[0].status.message #=> String
resp.spot_instance_requests[0].status.update_time #=> Time
resp.spot_instance_requests[0].tags #=> Array
resp.spot_instance_requests[0].tags[0].key #=> String
resp.spot_instance_requests[0].tags[0].value #=> String
resp.spot_instance_requests[0].type #=> String, one of "one-time", "persistent"
resp.spot_instance_requests[0].valid_from #=> Time
resp.spot_instance_requests[0].valid_until #=> Time
resp.spot_instance_requests[0].instance_interruption_behavior #=> String, one of "hibernate", "stop", "terminate"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch_specification (Types::RequestSpotLaunchSpecification) —

    The launch specification.

  • :tag_specifications (Array<Types::TagSpecification>) —

    The key-value pair for tagging the Spot Instance request on creation. The value for ‘ResourceType` must be `spot-instances-request`, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see [CreateTags].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html

  • :instance_interruption_behavior (String) —

    The behavior when a Spot Instance is interrupted. The default is ‘terminate`.

  • :dry_run (Boolean) —

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

  • :spot_price (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.

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency in Amazon EC2 API requests] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html

  • :instance_count (Integer) —

    The maximum number of Spot Instances to launch.

    Default: 1

  • :type (String) —

    The Spot Instance request type.

    Default: ‘one-time`

  • :valid_from (Time, DateTime, Date, Integer, String) —

    The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

    The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

  • :valid_until (Time, DateTime, Date, Integer, String) —

    The end date of the request, in UTC format (YYYY-MM-*DD*T*HH*:MM:*SS*Z).

    • For a persistent request, the request remains active until the ‘ValidUntil` date and time is reached. Otherwise, the request remains active until you cancel it.

    • For a one-time request, the request remains active until all instances launch, the request is canceled, or the ‘ValidUntil` date and time is reached. By default, the request is valid for 7 days from the date the request was created.

  • :launch_group (String) —

    The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

    Default: Instances are launched and terminated individually

  • :availability_zone_group (String) —

    The user-specified name for a logical grouping of requests.

    When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

    If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

    Default: Instances are launched in any available Availability Zone.

  • :block_duration_minutes (Integer) —

    Deprecated.

Returns:

See Also:



56169
56170
56171
56172
 
# File 'lib/aws-sdk-ec2/client.rb', line 56169

def request_spot_instances(params = {}, options = {})
  req = build_request(:request_spot_instances, params)
  req.send_request(options)
end

#reset_address_attribute(params = {}) ⇒ Types::ResetAddressAttributeResult

Resets the attribute of the specified IP address. For requirements, see [Using reverse DNS for email applications].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS

Examples:

Request syntax with placeholder values


resp = client.reset_address_attribute({
  allocation_id: "AllocationId", # required
  attribute: "domain-name", # required, accepts domain-name
  dry_run: false,
})

Response structure


resp.address.public_ip #=> String
resp.address.allocation_id #=> String
resp.address.ptr_record #=> String
resp.address.ptr_record_update.value #=> String
resp.address.ptr_record_update.status #=> String
resp.address.ptr_record_update.reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :allocation_id (required, String) —

    [EC2-VPC] The allocation ID.

  • :attribute (required, String) —

    The attribute of the IP address.

  • :dry_run (Boolean) —

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

Returns:

See Also:



56218
56219
56220
56221
 
# File 'lib/aws-sdk-ec2/client.rb', line 56218

def reset_address_attribute(params = {}, options = {})
  req = build_request(:reset_address_attribute, params)
  req.send_request(options)
end

#reset_ebs_default_kms_key_id(params = {}) ⇒ Types::ResetEbsDefaultKmsKeyIdResult

Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.

After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see

Amazon EBS encryption][1

in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html

Examples:

Request syntax with placeholder values


resp = client.reset_ebs_default_kms_key_id({
  dry_run: false,
})

Response structure


resp.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

Returns:

See Also:



56259
56260
56261
56262
 
# File 'lib/aws-sdk-ec2/client.rb', line 56259

def reset_ebs_default_kms_key_id(params = {}, options = {})
  req = build_request(:reset_ebs_default_kms_key_id, params)
  req.send_request(options)
end

#reset_fpga_image_attribute(params = {}) ⇒ Types::ResetFpgaImageAttributeResult

Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.

Examples:

Request syntax with placeholder values


resp = client.reset_fpga_image_attribute({
  dry_run: false,
  fpga_image_id: "FpgaImageId", # required
  attribute: "loadPermission", # accepts loadPermission
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :fpga_image_id (required, String) —

    The ID of the AFI.

  • :attribute (String) —

    The attribute.

Returns:

See Also:



56300
56301
56302
56303
 
# File 'lib/aws-sdk-ec2/client.rb', line 56300

def reset_fpga_image_attribute(params = {}, options = {})
  req = build_request(:reset_fpga_image_attribute, params)
  req.send_request(options)
end

#reset_image_attribute(params = {}) ⇒ Struct

Resets an attribute of an AMI to its default value.

Examples:

Example: To reset the launchPermission attribute


# This example resets the launchPermission attribute for the specified AMI. By default, AMIs are private.

resp = client.reset_image_attribute({
  attribute: "launchPermission", 
  image_id: "ami-5731123e", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.reset_image_attribute({
  attribute: "launchPermission", # required, accepts launchPermission
  image_id: "ImageId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute (required, String) —

    The attribute to reset (currently you can only reset the launch permission attribute).

  • :image_id (required, String) —

    The ID of the AMI.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



56348
56349
56350
56351
 
# File 'lib/aws-sdk-ec2/client.rb', line 56348

def reset_image_attribute(params = {}, options = {})
  req = build_request(:reset_image_attribute, params)
  req.send_request(options)
end

#reset_instance_attribute(params = {}) ⇒ Struct

Resets an attribute of an instance to its default value. To reset the ‘kernel` or `ramdisk`, the instance must be in a stopped state. To reset the `sourceDestCheck`, the instance can be either running or stopped.

The ‘sourceDestCheck` attribute controls whether source/destination checking is enabled. The default value is `true`, which means checking is enabled. This value must be `false` for a NAT instance to perform NAT. For more information, see [NAT instances] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html

Examples:

Example: To reset the sourceDestCheck attribute


# This example resets the sourceDestCheck attribute for the specified instance.

resp = client.reset_instance_attribute({
  attribute: "sourceDestCheck", 
  instance_id: "i-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.reset_instance_attribute({
  dry_run: false,
  instance_id: "InstanceId", # required
  attribute: "instanceType", # required, accepts instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport, enaSupport, enclaveOptions, disableApiStop
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :instance_id (required, String) —

    The ID of the instance.

  • :attribute (required, String) —

    The attribute to reset.

    You can only reset the following attributes: ‘kernel` | `ramdisk` | `sourceDestCheck`.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



56411
56412
56413
56414
 
# File 'lib/aws-sdk-ec2/client.rb', line 56411

def reset_instance_attribute(params = {}, options = {})
  req = build_request(:reset_instance_attribute, params)
  req.send_request(options)
end

#reset_network_interface_attribute(params = {}) ⇒ Struct

Resets a network interface attribute. You can specify only one attribute at a time.

Examples:

Request syntax with placeholder values


resp = client.reset_network_interface_attribute({
  dry_run: false,
  network_interface_id: "NetworkInterfaceId", # required
  source_dest_check: "String",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :network_interface_id (required, String) —

    The ID of the network interface.

  • :source_dest_check (String) —

    The source/destination checking attribute. Resets the value to ‘true`.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



56445
56446
56447
56448
 
# File 'lib/aws-sdk-ec2/client.rb', line 56445

def reset_network_interface_attribute(params = {}, options = {})
  req = build_request(:reset_network_interface_attribute, params)
  req.send_request(options)
end

#reset_snapshot_attribute(params = {}) ⇒ Struct

Resets permission settings for the specified snapshot.

For more information about modifying snapshot permissions, see [Share a snapshot] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-modifying-snapshot-permissions.html

Examples:

Example: To reset a snapshot attribute


# This example resets the create volume permissions for snapshot ``snap-1234567890abcdef0``. If the command succeeds, no
# output is returned.

resp = client.reset_snapshot_attribute({
  attribute: "createVolumePermission", 
  snapshot_id: "snap-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.reset_snapshot_attribute({
  attribute: "productCodes", # required, accepts productCodes, createVolumePermission
  snapshot_id: "SnapshotId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute (required, String) —

    The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

  • :snapshot_id (required, String) —

    The ID of the snapshot.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



56501
56502
56503
56504
 
# File 'lib/aws-sdk-ec2/client.rb', line 56501

def reset_snapshot_attribute(params = {}, options = {})
  req = build_request(:reset_snapshot_attribute, params)
  req.send_request(options)
end

#restore_address_to_classic(params = {}) ⇒ Types::RestoreAddressToClassicResult

<note markdown=“1”> This action is deprecated.

</note>

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

Examples:

Request syntax with placeholder values


resp = client.restore_address_to_classic({
  dry_run: false,
  public_ip: "String", # required
})

Response structure


resp.public_ip #=> String
resp.status #=> String, one of "MoveInProgress", "InVpc", "InClassic"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :public_ip (required, String) —

    The Elastic IP address.

Returns:

See Also:



56546
56547
56548
56549
 
# File 'lib/aws-sdk-ec2/client.rb', line 56546

def restore_address_to_classic(params = {}, options = {})
  req = build_request(:restore_address_to_classic, params)
  req.send_request(options)
end

#restore_image_from_recycle_bin(params = {}) ⇒ Types::RestoreImageFromRecycleBinResult

Restores an AMI from the Recycle Bin. For more information, see

Recycle Bin][1

in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html

Examples:

Request syntax with placeholder values


resp = client.restore_image_from_recycle_bin({
  image_id: "ImageId", # required
  dry_run: false,
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The ID of the AMI to restore.

  • :dry_run (Boolean) —

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

Returns:

See Also:



56586
56587
56588
56589
 
# File 'lib/aws-sdk-ec2/client.rb', line 56586

def restore_image_from_recycle_bin(params = {}, options = {})
  req = build_request(:restore_image_from_recycle_bin, params)
  req.send_request(options)
end

#restore_managed_prefix_list_version(params = {}) ⇒ Types::RestoreManagedPrefixListVersionResult

Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

Examples:

Request syntax with placeholder values


resp = client.restore_managed_prefix_list_version({
  dry_run: false,
  prefix_list_id: "PrefixListResourceId", # required
  previous_version: 1, # required
  current_version: 1, # required
})

Response structure


resp.prefix_list.prefix_list_id #=> String
resp.prefix_list.address_family #=> String
resp.prefix_list.state #=> String, one of "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"
resp.prefix_list.state_message #=> String
resp.prefix_list.prefix_list_arn #=> String
resp.prefix_list.prefix_list_name #=> String
resp.prefix_list.max_entries #=> Integer
resp.prefix_list.version #=> Integer
resp.prefix_list.tags #=> Array
resp.prefix_list.tags[0].key #=> String
resp.prefix_list.tags[0].value #=> String
resp.prefix_list.owner_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

    The ID of the prefix list.

  • :previous_version (required, Integer) —

    The version to restore.

  • :current_version (required, Integer) —

    The current version number for the prefix list.

Returns:

See Also:



56641
56642
56643
56644
 
# File 'lib/aws-sdk-ec2/client.rb', line 56641

def restore_managed_prefix_list_version(params = {}, options = {})
  req = build_request(:restore_managed_prefix_list_version, params)
  req.send_request(options)
end

#restore_snapshot_from_recycle_bin(params = {}) ⇒ Types::RestoreSnapshotFromRecycleBinResult

Restores a snapshot from the Recycle Bin. For more information, see

Restore snapshots from the Recycle Bin][1

in the *Amazon EBS User

Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-snaps.html#recycle-bin-restore-snaps

Examples:

Request syntax with placeholder values


resp = client.restore_snapshot_from_recycle_bin({
  snapshot_id: "SnapshotId", # required
  dry_run: false,
})

Response structure


resp.snapshot_id #=> String
resp.outpost_arn #=> String
resp.description #=> String
resp.encrypted #=> Boolean
resp.owner_id #=> String
resp.progress #=> String
resp.start_time #=> Time
resp.state #=> String, one of "pending", "completed", "error", "recoverable", "recovering"
resp.volume_id #=> String
resp.volume_size #=> Integer
resp.sse_type #=> String, one of "sse-ebs", "sse-kms", "none"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The ID of the snapshot to restore.

  • :dry_run (Boolean) —

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

Returns:

See Also:



56702
56703
56704
56705
 
# File 'lib/aws-sdk-ec2/client.rb', line 56702

def restore_snapshot_from_recycle_bin(params = {}, options = {})
  req = build_request(:restore_snapshot_from_recycle_bin, params)
  req.send_request(options)
end

#restore_snapshot_tier(params = {}) ⇒ Types::RestoreSnapshotTierResult

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.

For more information see [ Restore an archived snapshot] and [ modify the restore period or restore type for a temporarily restored snapshot] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/working-with-snapshot-archiving.html#restore-archived-snapshot [2]: docs.aws.amazon.com/ebs/latest/userguide/working-with-snapshot-archiving.html#modify-temp-restore-period

Examples:

Request syntax with placeholder values


resp = client.restore_snapshot_tier({
  snapshot_id: "SnapshotId", # required
  temporary_restore_days: 1,
  permanent_restore: false,
  dry_run: false,
})

Response structure


resp.snapshot_id #=> String
resp.restore_start_time #=> Time
resp.restore_duration #=> Integer
resp.is_permanent_restore #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The ID of the snapshot to restore.

  • :temporary_restore_days (Integer) —

    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.

    To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to ‘false`.

  • :permanent_restore (Boolean) —

    Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify ‘true` and omit the **RestoreSnapshotTierRequest$TemporaryRestoreDays** parameter.

  • :dry_run (Boolean) —

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

Returns:

See Also:



56769
56770
56771
56772
 
# File 'lib/aws-sdk-ec2/client.rb', line 56769

def restore_snapshot_tier(params = {}, options = {})
  req = build_request(:restore_snapshot_tier, params)
  req.send_request(options)
end

#revoke_client_vpn_ingress(params = {}) ⇒ Types::RevokeClientVpnIngressResult

Removes an ingress authorization rule from a Client VPN endpoint.

Examples:

Request syntax with placeholder values


resp = client.revoke_client_vpn_ingress({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  target_network_cidr: "String", # required
  access_group_id: "String",
  revoke_all_groups: false,
  dry_run: false,
})

Response structure


resp.status.code #=> String, one of "authorizing", "active", "failed", "revoking"
resp.status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint with which the authorization rule is associated.

  • :target_network_cidr (required, String) —

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

  • :access_group_id (String) —

    The ID of the Active Directory group for which to revoke access.

  • :revoke_all_groups (Boolean) —

    Indicates whether access should be revoked for all clients.

  • :dry_run (Boolean) —

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

Returns:

See Also:



56819
56820
56821
56822
 
# File 'lib/aws-sdk-ec2/client.rb', line 56819

def revoke_client_vpn_ingress(params = {}, options = {})
  req = build_request(:revoke_client_vpn_ingress, params)
  req.send_request(options)
end

#revoke_security_group_egress(params = {}) ⇒ Types::RevokeSecurityGroupEgressResult

Removes the specified outbound (egress) rules from the specified security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule’s values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

For a default VPC, if the values you specify do not match the existing rule’s values, no error is returned, and the output describes the security group rules that were not revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

Examples:

Request syntax with placeholder values


resp = client.revoke_security_group_egress({
  security_group_rule_ids: ["String"],
  dry_run: false,
  group_id: "SecurityGroupId", # required
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
  ip_protocol: "String",
  from_port: 1,
  to_port: 1,
  cidr_ip: "String",
  ip_permissions: [
    {
      ip_protocol: "String",
      from_port: 1,
      to_port: 1,
      user_id_group_pairs: [
        {
          description: "String",
          user_id: "String",
          group_name: "String",
          group_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
          peering_status: "String",
        },
      ],
      ip_ranges: [
        {
          description: "String",
          cidr_ip: "String",
        },
      ],
      ipv_6_ranges: [
        {
          description: "String",
          cidr_ipv_6: "String",
        },
      ],
      prefix_list_ids: [
        {
          description: "String",
          prefix_list_id: "String",
        },
      ],
    },
  ],
})

Response structure


resp.return #=> Boolean
resp.unknown_ip_permissions #=> Array
resp.unknown_ip_permissions[0].ip_protocol #=> String
resp.unknown_ip_permissions[0].from_port #=> Integer
resp.unknown_ip_permissions[0].to_port #=> Integer
resp.unknown_ip_permissions[0].user_id_group_pairs #=> Array
resp.unknown_ip_permissions[0].user_id_group_pairs[0].description #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].user_id #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].group_name #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].group_id #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].vpc_id #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].vpc_peering_connection_id #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].peering_status #=> String
resp.unknown_ip_permissions[0].ip_ranges #=> Array
resp.unknown_ip_permissions[0].ip_ranges[0].description #=> String
resp.unknown_ip_permissions[0].ip_ranges[0].cidr_ip #=> String
resp.unknown_ip_permissions[0].ipv_6_ranges #=> Array
resp.unknown_ip_permissions[0].ipv_6_ranges[0].description #=> String
resp.unknown_ip_permissions[0].ipv_6_ranges[0].cidr_ipv_6 #=> String
resp.unknown_ip_permissions[0].prefix_list_ids #=> Array
resp.unknown_ip_permissions[0].prefix_list_ids[0].description #=> String
resp.unknown_ip_permissions[0].prefix_list_ids[0].prefix_list_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :security_group_rule_ids (Array<String>) —

    The IDs of the security group rules.

  • :dry_run (Boolean) —

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

  • :group_id (required, String) —

    The ID of the security group.

  • :source_security_group_name (String) —

    Not supported. Use a set of IP permissions to specify a destination security group.

  • :source_security_group_owner_id (String) —

    Not supported. Use a set of IP permissions to specify a destination security group.

  • :ip_protocol (String) —

    Not supported. Use a set of IP permissions to specify the protocol name or number.

  • :from_port (Integer) —

    Not supported. Use a set of IP permissions to specify the port.

  • :to_port (Integer) —

    Not supported. Use a set of IP permissions to specify the port.

  • :cidr_ip (String) —

    Not supported. Use a set of IP permissions to specify the CIDR.

  • :ip_permissions (Array<Types::IpPermission>) —

    The sets of IP permissions. You can’t specify a destination security group and a CIDR IP address range in the same set of permissions.

Returns:

See Also:



56968
56969
56970
56971
 
# File 'lib/aws-sdk-ec2/client.rb', line 56968

def revoke_security_group_egress(params = {}, options = {})
  req = build_request(:revoke_security_group_egress, params)
  req.send_request(options)
end

#revoke_security_group_ingress(params = {}) ⇒ Types::RevokeSecurityGroupIngressResult

Removes the specified inbound (ingress) rules from a security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule’s values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

For a default VPC, if the values you specify do not match the existing rule’s values, no error is returned, and the output describes the security group rules that were not revoked.

For a non-default VPC, if the values you specify do not match the existing rule’s values, an ‘InvalidPermission.NotFound` client error is returned, and no rules are revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

Examples:

Request syntax with placeholder values


resp = client.revoke_security_group_ingress({
  cidr_ip: "String",
  from_port: 1,
  group_id: "SecurityGroupId",
  group_name: "SecurityGroupName",
  ip_permissions: [
    {
      ip_protocol: "String",
      from_port: 1,
      to_port: 1,
      user_id_group_pairs: [
        {
          description: "String",
          user_id: "String",
          group_name: "String",
          group_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
          peering_status: "String",
        },
      ],
      ip_ranges: [
        {
          description: "String",
          cidr_ip: "String",
        },
      ],
      ipv_6_ranges: [
        {
          description: "String",
          cidr_ipv_6: "String",
        },
      ],
      prefix_list_ids: [
        {
          description: "String",
          prefix_list_id: "String",
        },
      ],
    },
  ],
  ip_protocol: "String",
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
  to_port: 1,
  security_group_rule_ids: ["String"],
  dry_run: false,
})

Response structure


resp.return #=> Boolean
resp.unknown_ip_permissions #=> Array
resp.unknown_ip_permissions[0].ip_protocol #=> String
resp.unknown_ip_permissions[0].from_port #=> Integer
resp.unknown_ip_permissions[0].to_port #=> Integer
resp.unknown_ip_permissions[0].user_id_group_pairs #=> Array
resp.unknown_ip_permissions[0].user_id_group_pairs[0].description #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].user_id #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].group_name #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].group_id #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].vpc_id #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].vpc_peering_connection_id #=> String
resp.unknown_ip_permissions[0].user_id_group_pairs[0].peering_status #=> String
resp.unknown_ip_permissions[0].ip_ranges #=> Array
resp.unknown_ip_permissions[0].ip_ranges[0].description #=> String
resp.unknown_ip_permissions[0].ip_ranges[0].cidr_ip #=> String
resp.unknown_ip_permissions[0].ipv_6_ranges #=> Array
resp.unknown_ip_permissions[0].ipv_6_ranges[0].description #=> String
resp.unknown_ip_permissions[0].ipv_6_ranges[0].cidr_ipv_6 #=> String
resp.unknown_ip_permissions[0].prefix_list_ids #=> Array
resp.unknown_ip_permissions[0].prefix_list_ids[0].description #=> String
resp.unknown_ip_permissions[0].prefix_list_ids[0].prefix_list_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr_ip (String) —

    The CIDR IP address range. You can’t specify this parameter when specifying a source security group.

  • :from_port (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).

  • :group_id (String) —

    The ID of the security group.

  • :group_name (String) —

    [Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

  • :ip_permissions (Array<Types::IpPermission>) —

    The sets of IP permissions. You can’t specify a source security group and a CIDR IP address range in the same set of permissions.

  • :ip_protocol (String) —

    The IP protocol name (‘tcp`, `udp`, `icmp`) or number (see [Protocol Numbers]). Use `-1` to specify all.

    [1]: www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml

  • :source_security_group_name (String) —

    [Default VPC] The name of the source security group. You can’t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. The source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

  • :source_security_group_owner_id (String) —

    Not supported.

  • :to_port (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).

  • :security_group_rule_ids (Array<String>) —

    The IDs of the security group rules.

  • :dry_run (Boolean) —

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

Returns:

See Also:



57137
57138
57139
57140
 
# File 'lib/aws-sdk-ec2/client.rb', line 57137

def revoke_security_group_ingress(params = {}, options = {})
  req = build_request(:revoke_security_group_ingress, params)
  req.send_request(options)
end

#run_instances(params = {}) ⇒ Types::Reservation

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

  • If you don’t specify a subnet ID, we choose a default subnet from your default VPC for you. If you don’t have a default VPC, you must specify a subnet ID in the request.

  • All instances have a network interface with a primary private IPv4 address. If you don’t specify this address, we choose one from the IPv4 range of your subnet.

  • Not all instance types support IPv6 addresses. For more information, see [Instance types].

  • If you don’t specify a security group ID, we use the default security group for the VPC. For more information, see [Security groups].

  • If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a [launch template], which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

‘RunInstances` is subject to both request rate limiting and resource rate limiting. For more information, see [Request throttling].

An instance is ready for you to use when it’s in the ‘running` state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and [Tagging your Amazon EC2 resources].

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see [Key pairs].

For troubleshooting, see [What to do if an instance immediately terminates], and [Troubleshooting connecting to your instance].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html [4]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-throttling.html [5]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html [6]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html [7]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html [8]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html

Examples:

Example: To launch an instance


# This example launches an instance using the specified AMI, instance type, security group, subnet, block device mapping,
# and tags.

resp = client.run_instances({
  block_device_mappings: [
    {
      device_name: "/dev/sdh", 
      ebs: {
        volume_size: 100, 
      }, 
    }, 
  ], 
  image_id: "ami-abc12345", 
  instance_type: "t2.micro", 
  key_name: "my-key-pair", 
  max_count: 1, 
  min_count: 1, 
  security_group_ids: [
    "sg-1a2b3c4d", 
  ], 
  subnet_id: "subnet-6e7f829e", 
  tag_specifications: [
    {
      resource_type: "instance", 
      tags: [
        {
          key: "Purpose", 
          value: "test", 
        }, 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.run_instances({
  block_device_mappings: [
    {
      ebs: {
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "SnapshotId",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
        kms_key_id: "String",
        throughput: 1,
        outpost_arn: "String",
        encrypted: false,
      },
      no_device: "String",
      device_name: "String",
      virtual_name: "String",
    },
  ],
  image_id: "ImageId",
  instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge, mac2.metal, c6id.large, c6id.xlarge, c6id.2xlarge, c6id.4xlarge, c6id.8xlarge, c6id.12xlarge, c6id.16xlarge, c6id.24xlarge, c6id.32xlarge, c6id.metal, m6id.large, m6id.xlarge, m6id.2xlarge, m6id.4xlarge, m6id.8xlarge, m6id.12xlarge, m6id.16xlarge, m6id.24xlarge, m6id.32xlarge, m6id.metal, r6id.large, r6id.xlarge, r6id.2xlarge, r6id.4xlarge, r6id.8xlarge, r6id.12xlarge, r6id.16xlarge, r6id.24xlarge, r6id.32xlarge, r6id.metal, r6a.large, r6a.xlarge, r6a.2xlarge, r6a.4xlarge, r6a.8xlarge, r6a.12xlarge, r6a.16xlarge, r6a.24xlarge, r6a.32xlarge, r6a.48xlarge, r6a.metal, p4de.24xlarge, u-3tb1.56xlarge, u-18tb1.112xlarge, u-24tb1.112xlarge, trn1.2xlarge, trn1.32xlarge, hpc6id.32xlarge, c6in.large, c6in.xlarge, c6in.2xlarge, c6in.4xlarge, c6in.8xlarge, c6in.12xlarge, c6in.16xlarge, c6in.24xlarge, c6in.32xlarge, m6in.large, m6in.xlarge, m6in.2xlarge, m6in.4xlarge, m6in.8xlarge, m6in.12xlarge, m6in.16xlarge, m6in.24xlarge, m6in.32xlarge, m6idn.large, m6idn.xlarge, m6idn.2xlarge, m6idn.4xlarge, m6idn.8xlarge, m6idn.12xlarge, m6idn.16xlarge, m6idn.24xlarge, m6idn.32xlarge, r6in.large, r6in.xlarge, r6in.2xlarge, r6in.4xlarge, r6in.8xlarge, r6in.12xlarge, r6in.16xlarge, r6in.24xlarge, r6in.32xlarge, r6idn.large, r6idn.xlarge, r6idn.2xlarge, r6idn.4xlarge, r6idn.8xlarge, r6idn.12xlarge, r6idn.16xlarge, r6idn.24xlarge, r6idn.32xlarge, c7g.metal, m7g.medium, m7g.large, m7g.xlarge, m7g.2xlarge, m7g.4xlarge, m7g.8xlarge, m7g.12xlarge, m7g.16xlarge, m7g.metal, r7g.medium, r7g.large, r7g.xlarge, r7g.2xlarge, r7g.4xlarge, r7g.8xlarge, r7g.12xlarge, r7g.16xlarge, r7g.metal, c6in.metal, m6in.metal, m6idn.metal, r6in.metal, r6idn.metal, inf2.xlarge, inf2.8xlarge, inf2.24xlarge, inf2.48xlarge, trn1n.32xlarge, i4g.large, i4g.xlarge, i4g.2xlarge, i4g.4xlarge, i4g.8xlarge, i4g.16xlarge, hpc7g.4xlarge, hpc7g.8xlarge, hpc7g.16xlarge, c7gn.medium, c7gn.large, c7gn.xlarge, c7gn.2xlarge, c7gn.4xlarge, c7gn.8xlarge, c7gn.12xlarge, c7gn.16xlarge, p5.48xlarge, m7i.large, m7i.xlarge, m7i.2xlarge, m7i.4xlarge, m7i.8xlarge, m7i.12xlarge, m7i.16xlarge, m7i.24xlarge, m7i.48xlarge, m7i-flex.large, m7i-flex.xlarge, m7i-flex.2xlarge, m7i-flex.4xlarge, m7i-flex.8xlarge, m7a.medium, m7a.large, m7a.xlarge, m7a.2xlarge, m7a.4xlarge, m7a.8xlarge, m7a.12xlarge, m7a.16xlarge, m7a.24xlarge, m7a.32xlarge, m7a.48xlarge, m7a.metal-48xl, hpc7a.12xlarge, hpc7a.24xlarge, hpc7a.48xlarge, hpc7a.96xlarge, c7gd.medium, c7gd.large, c7gd.xlarge, c7gd.2xlarge, c7gd.4xlarge, c7gd.8xlarge, c7gd.12xlarge, c7gd.16xlarge, m7gd.medium, m7gd.large, m7gd.xlarge, m7gd.2xlarge, m7gd.4xlarge, m7gd.8xlarge, m7gd.12xlarge, m7gd.16xlarge, r7gd.medium, r7gd.large, r7gd.xlarge, r7gd.2xlarge, r7gd.4xlarge, r7gd.8xlarge, r7gd.12xlarge, r7gd.16xlarge, r7a.medium, r7a.large, r7a.xlarge, r7a.2xlarge, r7a.4xlarge, r7a.8xlarge, r7a.12xlarge, r7a.16xlarge, r7a.24xlarge, r7a.32xlarge, r7a.48xlarge, c7i.large, c7i.xlarge, c7i.2xlarge, c7i.4xlarge, c7i.8xlarge, c7i.12xlarge, c7i.16xlarge, c7i.24xlarge, c7i.48xlarge, mac2-m2pro.metal, r7iz.large, r7iz.xlarge, r7iz.2xlarge, r7iz.4xlarge, r7iz.8xlarge, r7iz.12xlarge, r7iz.16xlarge, r7iz.32xlarge, c7a.medium, c7a.large, c7a.xlarge, c7a.2xlarge, c7a.4xlarge, c7a.8xlarge, c7a.12xlarge, c7a.16xlarge, c7a.24xlarge, c7a.32xlarge, c7a.48xlarge, c7a.metal-48xl, r7a.metal-48xl, r7i.large, r7i.xlarge, r7i.2xlarge, r7i.4xlarge, r7i.8xlarge, r7i.12xlarge, r7i.16xlarge, r7i.24xlarge, r7i.48xlarge, dl2q.24xlarge, mac2-m2.metal, i4i.12xlarge, i4i.24xlarge, c7i.metal-24xl, c7i.metal-48xl, m7i.metal-24xl, m7i.metal-48xl, r7i.metal-24xl, r7i.metal-48xl, r7iz.metal-16xl, r7iz.metal-32xl, c7gd.metal, m7gd.metal, r7gd.metal, g6.xlarge, g6.2xlarge, g6.4xlarge, g6.8xlarge, g6.12xlarge, g6.16xlarge, g6.24xlarge, g6.48xlarge, gr6.4xlarge, gr6.8xlarge, c7i-flex.large, c7i-flex.xlarge, c7i-flex.2xlarge, c7i-flex.4xlarge, c7i-flex.8xlarge, u7i-12tb.224xlarge, u7in-16tb.224xlarge, u7in-24tb.224xlarge, u7in-32tb.224xlarge, u7ib-12tb.224xlarge, c7gn.metal, r8g.medium, r8g.large, r8g.xlarge, r8g.2xlarge, r8g.4xlarge, r8g.8xlarge, r8g.12xlarge, r8g.16xlarge, r8g.24xlarge, r8g.48xlarge, r8g.metal-24xl, r8g.metal-48xl, mac2-m1ultra.metal, g6e.xlarge, g6e.2xlarge, g6e.4xlarge, g6e.8xlarge, g6e.12xlarge, g6e.16xlarge, g6e.24xlarge, g6e.48xlarge
  ipv_6_address_count: 1,
  ipv_6_addresses: [
    {
      ipv_6_address: "String",
      is_primary_ipv_6: false,
    },
  ],
  kernel_id: "KernelId",
  key_name: "KeyPairName",
  max_count: 1, # required
  min_count: 1, # required
  monitoring: {
    enabled: false, # required
  },
  placement: {
    affinity: "String",
    group_name: "PlacementGroupName",
    partition_number: 1,
    host_id: "String",
    tenancy: "default", # accepts default, dedicated, host
    spread_domain: "String",
    host_resource_group_arn: "String",
    group_id: "PlacementGroupId",
    availability_zone: "String",
  },
  ramdisk_id: "RamdiskId",
  security_group_ids: ["SecurityGroupId"],
  security_groups: ["SecurityGroupName"],
  subnet_id: "SubnetId",
  user_data: "RunInstancesUserData",
  elastic_gpu_specification: [
    {
      type: "String", # required
    },
  ],
  elastic_inference_accelerators: [
    {
      type: "String", # required
      count: 1,
    },
  ],
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  launch_template: {
    launch_template_id: "LaunchTemplateId",
    launch_template_name: "String",
    version: "String",
  },
  instance_market_options: {
    market_type: "spot", # accepts spot, capacity-block
    spot_options: {
      max_price: "String",
      spot_instance_type: "one-time", # accepts one-time, persistent
      block_duration_minutes: 1,
      valid_until: Time.now,
      instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
    },
  },
  credit_specification: {
    cpu_credits: "String", # required
  },
  cpu_options: {
    core_count: 1,
    threads_per_core: 1,
    amd_sev_snp: "enabled", # accepts enabled, disabled
  },
  capacity_reservation_specification: {
    capacity_reservation_preference: "open", # accepts open, none
    capacity_reservation_target: {
      capacity_reservation_id: "CapacityReservationId",
      capacity_reservation_resource_group_arn: "String",
    },
  },
  hibernation_options: {
    configured: false,
  },
  license_specifications: [
    {
      license_configuration_arn: "String",
    },
  ],
  metadata_options: {
    http_tokens: "optional", # accepts optional, required
    http_put_response_hop_limit: 1,
    http_endpoint: "disabled", # accepts disabled, enabled
    http_protocol_ipv_6: "disabled", # accepts disabled, enabled
    instance_metadata_tags: "disabled", # accepts disabled, enabled
  },
  enclave_options: {
    enabled: false,
  },
  private_dns_name_options: {
    hostname_type: "ip-name", # accepts ip-name, resource-name
    enable_resource_name_dns_a_record: false,
    enable_resource_name_dns_aaaa_record: false,
  },
  maintenance_options: {
    auto_recovery: "disabled", # accepts disabled, default
  },
  disable_api_stop: false,
  enable_primary_ipv_6: false,
  dry_run: false,
  disable_api_termination: false,
  instance_initiated_shutdown_behavior: "stop", # accepts stop, terminate
  private_ip_address: "String",
  client_token: "String",
  additional_info: "String",
  network_interfaces: [
    {
      associate_public_ip_address: false,
      delete_on_termination: false,
      description: "String",
      device_index: 1,
      groups: ["SecurityGroupId"],
      ipv_6_address_count: 1,
      ipv_6_addresses: [
        {
          ipv_6_address: "String",
          is_primary_ipv_6: false,
        },
      ],
      network_interface_id: "NetworkInterfaceId",
      private_ip_address: "String",
      private_ip_addresses: [
        {
          primary: false,
          private_ip_address: "String",
        },
      ],
      secondary_private_ip_address_count: 1,
      subnet_id: "String",
      associate_carrier_ip_address: false,
      interface_type: "String",
      network_card_index: 1,
      ipv_4_prefixes: [
        {
          ipv_4_prefix: "String",
        },
      ],
      ipv_4_prefix_count: 1,
      ipv_6_prefixes: [
        {
          ipv_6_prefix: "String",
        },
      ],
      ipv_6_prefix_count: 1,
      primary_ipv_6: false,
      ena_srd_specification: {
        ena_srd_enabled: false,
        ena_srd_udp_specification: {
          ena_srd_udp_enabled: false,
        },
      },
      connection_tracking_specification: {
        tcp_established_timeout: 1,
        udp_stream_timeout: 1,
        udp_timeout: 1,
      },
    },
  ],
  iam_instance_profile: {
    arn: "String",
    name: "String",
  },
  ebs_optimized: false,
})

Response structure


resp.reservation_id #=> String
resp.owner_id #=> String
resp.requester_id #=> String
resp.groups #=> Array
resp.groups[0].group_id #=> String
resp.groups[0].group_name #=> String
resp.instances #=> Array
resp.instances[0].architecture #=> String, one of "i386", "x86_64", "arm64", "x86_64_mac", "arm64_mac"
resp.instances[0].block_device_mappings #=> Array
resp.instances[0].block_device_mappings[0].device_name #=> String
resp.instances[0].block_device_mappings[0].ebs.attach_time #=> Time
resp.instances[0].block_device_mappings[0].ebs.delete_on_termination #=> Boolean
resp.instances[0].block_device_mappings[0].ebs.status #=> String, one of "attaching", "attached", "detaching", "detached"
resp.instances[0].block_device_mappings[0].ebs.volume_id #=> String
resp.instances[0].block_device_mappings[0].ebs.associated_resource #=> String
resp.instances[0].block_device_mappings[0].ebs.volume_owner_id #=> String
resp.instances[0].client_token #=> String
resp.instances[0].ebs_optimized #=> Boolean
resp.instances[0].ena_support #=> Boolean
resp.instances[0].hypervisor #=> String, one of "ovm", "xen"
resp.instances[0].iam_instance_profile.arn #=> String
resp.instances[0].iam_instance_profile.id #=> String
resp.instances[0].instance_lifecycle #=> String, one of "spot", "scheduled", "capacity-block"
resp.instances[0].elastic_gpu_associations #=> Array
resp.instances[0].elastic_gpu_associations[0].elastic_gpu_id #=> String
resp.instances[0].elastic_gpu_associations[0].elastic_gpu_association_id #=> String
resp.instances[0].elastic_gpu_associations[0].elastic_gpu_association_state #=> String
resp.instances[0].elastic_gpu_associations[0].elastic_gpu_association_time #=> String
resp.instances[0].elastic_inference_accelerator_associations #=> Array
resp.instances[0].elastic_inference_accelerator_associations[0].elastic_inference_accelerator_arn #=> String
resp.instances[0].elastic_inference_accelerator_associations[0].elastic_inference_accelerator_association_id #=> String
resp.instances[0].elastic_inference_accelerator_associations[0].elastic_inference_accelerator_association_state #=> String
resp.instances[0].elastic_inference_accelerator_associations[0].elastic_inference_accelerator_association_time #=> Time
resp.instances[0].network_interfaces #=> Array
resp.instances[0].network_interfaces[0].association.carrier_ip #=> String
resp.instances[0].network_interfaces[0].association.customer_owned_ip #=> String
resp.instances[0].network_interfaces[0].association.ip_owner_id #=> String
resp.instances[0].network_interfaces[0].association.public_dns_name #=> String
resp.instances[0].network_interfaces[0].association.public_ip #=> String
resp.instances[0].network_interfaces[0].attachment.attach_time #=> Time
resp.instances[0].network_interfaces[0].attachment.attachment_id #=> String
resp.instances[0].network_interfaces[0].attachment.delete_on_termination #=> Boolean
resp.instances[0].network_interfaces[0].attachment.device_index #=> Integer
resp.instances[0].network_interfaces[0].attachment.status #=> String, one of "attaching", "attached", "detaching", "detached"
resp.instances[0].network_interfaces[0].attachment.network_card_index #=> Integer
resp.instances[0].network_interfaces[0].attachment.ena_srd_specification.ena_srd_enabled #=> Boolean
resp.instances[0].network_interfaces[0].attachment.ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled #=> Boolean
resp.instances[0].network_interfaces[0].description #=> String
resp.instances[0].network_interfaces[0].groups #=> Array
resp.instances[0].network_interfaces[0].groups[0].group_id #=> String
resp.instances[0].network_interfaces[0].groups[0].group_name #=> String
resp.instances[0].network_interfaces[0].ipv_6_addresses #=> Array
resp.instances[0].network_interfaces[0].ipv_6_addresses[0].ipv_6_address #=> String
resp.instances[0].network_interfaces[0].ipv_6_addresses[0].is_primary_ipv_6 #=> Boolean
resp.instances[0].network_interfaces[0].mac_address #=> String
resp.instances[0].network_interfaces[0].network_interface_id #=> String
resp.instances[0].network_interfaces[0].owner_id #=> String
resp.instances[0].network_interfaces[0].private_dns_name #=> String
resp.instances[0].network_interfaces[0].private_ip_address #=> String
resp.instances[0].network_interfaces[0].private_ip_addresses #=> Array
resp.instances[0].network_interfaces[0].private_ip_addresses[0].association.carrier_ip #=> String
resp.instances[0].network_interfaces[0].private_ip_addresses[0].association.customer_owned_ip #=> String
resp.instances[0].network_interfaces[0].private_ip_addresses[0].association.ip_owner_id #=> String
resp.instances[0].network_interfaces[0].private_ip_addresses[0].association.public_dns_name #=> String
resp.instances[0].network_interfaces[0].private_ip_addresses[0].association.public_ip #=> String
resp.instances[0].network_interfaces[0].private_ip_addresses[0].primary #=> Boolean
resp.instances[0].network_interfaces[0].private_ip_addresses[0].private_dns_name #=> String
resp.instances[0].network_interfaces[0].private_ip_addresses[0].private_ip_address #=> String
resp.instances[0].network_interfaces[0].source_dest_check #=> Boolean
resp.instances[0].network_interfaces[0].status #=> String, one of "available", "associated", "attaching", "in-use", "detaching"
resp.instances[0].network_interfaces[0].subnet_id #=> String
resp.instances[0].network_interfaces[0].vpc_id #=> String
resp.instances[0].network_interfaces[0].interface_type #=> String
resp.instances[0].network_interfaces[0].ipv_4_prefixes #=> Array
resp.instances[0].network_interfaces[0].ipv_4_prefixes[0].ipv_4_prefix #=> String
resp.instances[0].network_interfaces[0].ipv_6_prefixes #=> Array
resp.instances[0].network_interfaces[0].ipv_6_prefixes[0].ipv_6_prefix #=> String
resp.instances[0].network_interfaces[0].connection_tracking_configuration.tcp_established_timeout #=> Integer
resp.instances[0].network_interfaces[0].connection_tracking_configuration.udp_stream_timeout #=> Integer
resp.instances[0].network_interfaces[0].connection_tracking_configuration.udp_timeout #=> Integer
resp.instances[0].outpost_arn #=> String
resp.instances[0].root_device_name #=> String
resp.instances[0].root_device_type #=> String, one of "ebs", "instance-store"
resp.instances[0].security_groups #=> Array
resp.instances[0].security_groups[0].group_id #=> String
resp.instances[0].security_groups[0].group_name #=> String
resp.instances[0].source_dest_check #=> Boolean
resp.instances[0].spot_instance_request_id #=> String
resp.instances[0].sriov_net_support #=> String
resp.instances[0].state_reason.code #=> String
resp.instances[0].state_reason.message #=> String
resp.instances[0].tags #=> Array
resp.instances[0].tags[0].key #=> String
resp.instances[0].tags[0].value #=> String
resp.instances[0].virtualization_type #=> String, one of "hvm", "paravirtual"
resp.instances[0].cpu_options.core_count #=> Integer
resp.instances[0].cpu_options.threads_per_core #=> Integer
resp.instances[0].cpu_options.amd_sev_snp #=> String, one of "enabled", "disabled"
resp.instances[0].capacity_reservation_id #=> String
resp.instances[0].capacity_reservation_specification.capacity_reservation_preference #=> String, one of "open", "none"
resp.instances[0].capacity_reservation_specification.capacity_reservation_target.capacity_reservation_id #=> String
resp.instances[0].capacity_reservation_specification.capacity_reservation_target.capacity_reservation_resource_group_arn #=> String
resp.instances[0].hibernation_options.configured #=> Boolean
resp.instances[0].licenses #=> Array
resp.instances[0].licenses[0].license_configuration_arn #=> String
resp.instances[0].metadata_options.state #=> String, one of "pending", "applied"
resp.instances[0].metadata_options.http_tokens #=> String, one of "optional", "required"
resp.instances[0].metadata_options.http_put_response_hop_limit #=> Integer
resp.instances[0].metadata_options.http_endpoint #=> String, one of "disabled", "enabled"
resp.instances[0].metadata_options.http_protocol_ipv_6 #=> String, one of "disabled", "enabled"
resp.instances[0].metadata_options.instance_metadata_tags #=> String, one of "disabled", "enabled"
resp.instances[0].enclave_options.enabled #=> Boolean
resp.instances[0].boot_mode #=> String, one of "legacy-bios", "uefi", "uefi-preferred"
resp.instances[0].platform_details #=> String
resp.instances[0].usage_operation #=> String
resp.instances[0].usage_operation_update_time #=> Time
resp.instances[0].private_dns_name_options.hostname_type #=> String, one of "ip-name", "resource-name"
resp.instances[0].private_dns_name_options.enable_resource_name_dns_a_record #=> Boolean
resp.instances[0].private_dns_name_options.enable_resource_name_dns_aaaa_record #=> Boolean
resp.instances[0].ipv_6_address #=> String
resp.instances[0].tpm_support #=> String
resp.instances[0].maintenance_options.auto_recovery #=> String, one of "disabled", "default"
resp.instances[0].current_instance_boot_mode #=> String, one of "legacy-bios", "uefi"
resp.instances[0].instance_id #=> String
resp.instances[0].image_id #=> String
resp.instances[0].state.code #=> Integer
resp.instances[0].state.name #=> String, one of "pending", "running", "shutting-down", "terminated", "stopping", "stopped"
resp.instances[0].private_dns_name #=> String
resp.instances[0].public_dns_name #=> String
resp.instances[0].state_transition_reason #=> String
resp.instances[0].key_name #=> String
resp.instances[0].ami_launch_index #=> Integer
resp.instances[0].product_codes #=> Array
resp.instances[0].product_codes[0].product_code_id #=> String
resp.instances[0].product_codes[0].product_code_type #=> String, one of "devpay", "marketplace"
resp.instances[0].instance_type #=> String, one of "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge"
resp.instances[0].launch_time #=> Time
resp.instances[0].placement.affinity #=> String
resp.instances[0].placement.group_name #=> String
resp.instances[0].placement.partition_number #=> Integer
resp.instances[0].placement.host_id #=> String
resp.instances[0].placement.tenancy #=> String, one of "default", "dedicated", "host"
resp.instances[0].placement.spread_domain #=> String
resp.instances[0].placement.host_resource_group_arn #=> String
resp.instances[0].placement.group_id #=> String
resp.instances[0].placement.availability_zone #=> String
resp.instances[0].kernel_id #=> String
resp.instances[0].ramdisk_id #=> String
resp.instances[0].platform #=> String, one of "Windows"
resp.instances[0].monitoring.state #=> String, one of "disabled", "disabling", "enabled", "pending"
resp.instances[0].subnet_id #=> String
resp.instances[0].vpc_id #=> String
resp.instances[0].private_ip_address #=> String
resp.instances[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :block_device_mappings (Array<Types::BlockDeviceMapping>) —

    The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see [Block device mappings] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

  • :image_id (String) —

    The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.

  • :instance_type (String) —

    The instance type. For more information, see [Amazon EC2 instance types] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

  • :ipv_6_address_count (Integer) —

    The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you’ve specified a minimum number of instances to launch.

    You cannot specify this option and the network interfaces option in the same request.

  • :ipv_6_addresses (Array<Types::InstanceIpv6Address>) —

    The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you’ve specified a minimum number of instances to launch.

    You cannot specify this option and the network interfaces option in the same request.

  • :kernel_id (String) —

    The ID of the kernel.

    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html

  • :key_name (String) —

    The name of the key pair. You can create a key pair using

    CreateKeyPair][1

    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.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html

  • :max_count (required, Integer) —

    The maximum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above the specified minimum count.

    Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see [Amazon EC2 instance type quotas].

    [1]: docs.aws.amazon.com/ec2/latest/instancetypes/ec2-instance-quotas.html

  • :min_count (required, Integer) —

    The minimum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does not launch any instances.

    Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see [Amazon EC2 instance type quotas].

    [1]: docs.aws.amazon.com/ec2/latest/instancetypes/ec2-instance-quotas.html

  • :monitoring (Types::RunInstancesMonitoringEnabled) —

    Specifies whether detailed monitoring is enabled for the instance.

  • :placement (Types::Placement) —

    The placement for the instance.

  • :ramdisk_id (String) —

    The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.

    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html

  • :security_group_ids (Array<String>) —

    The IDs of the security groups. You can create a security group using [CreateSecurityGroup].

    If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html

  • :security_groups (Array<String>) —

    [Default VPC] The names of the security groups.

    If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

    Default: Amazon EC2 uses the default security group.

  • :subnet_id (String) —

    The ID of the subnet to launch the instance into.

    If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.

  • :user_data (String) —

    The user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you’re using, the base64-encoding might be performed for you. For more information, see [Work with instance user data].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html

  • :elastic_gpu_specification (Array<Types::ElasticGpuSpecification>) —

    An elastic GPU to associate with the instance.

    <note markdown=“1”> Amazon Elastic Graphics reached end of life on January 8, 2024.

    </note>
  • :elastic_inference_accelerators (Array<Types::ElasticInferenceAccelerator>) —

    An elastic inference accelerator to associate with the instance.

    <note markdown=“1”> Amazon Elastic Inference is no longer available.

    </note>
  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the resources that are created during instance launch.

    You can specify tags for the following resources only:

    • Instances

    • Volumes

    • Spot Instance requests

    • Network interfaces

    To tag a resource after it has been created, see [CreateTags].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html

  • :launch_template (Types::LaunchTemplateSpecification) —

    The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.

  • :instance_market_options (Types::InstanceMarketOptionsRequest) —

    The market (purchasing) option for the instances.

    For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either ‘hibernate` or `stop`.

  • :credit_specification (Types::CreditSpecificationRequest) —

    The credit option for CPU usage of the burstable performance instance. Valid values are ‘standard` and `unlimited`. To change this attribute after launch, use [ ModifyInstanceCreditSpecification]. For more information, see [Burstable performance instances] in the *Amazon EC2 User Guide*.

    Default: ‘standard` (T2 instances) or `unlimited` (T3/T3a/T4g instances)

    For T3 instances with ‘host` tenancy, only `standard` is supported.

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html

  • :cpu_options (Types::CpuOptionsRequest) —

    The CPU options for the instance. For more information, see [Optimize CPU options] in the *Amazon EC2 User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html

  • :capacity_reservation_specification (Types::CapacityReservationSpecification) —

    Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance’s Capacity Reservation preference defaults to ‘open`, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • :hibernation_options (Types::HibernationOptionsRequest) —

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

    You can’t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html

  • :license_specifications (Array<Types::LicenseConfigurationRequest>) —

    The license configurations.

  • :metadata_options (Types::InstanceMetadataOptionsRequest) —

    The metadata options for the instance. For more information, see [Instance metadata and user data].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html

  • :enclave_options (Types::EnclaveOptionsRequest) —

    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.

    [1]: docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html

  • :private_dns_name_options (Types::PrivateDnsNameOptionsRequest) —

    The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.

  • :maintenance_options (Types::InstanceMaintenanceOptionsRequest) —

    The maintenance and recovery options for the instance.

  • :disable_api_stop (Boolean) —

    Indicates whether an instance is enabled for stop protection. For more information, see [Stop protection].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection

  • :enable_primary_ipv_6 (Boolean) —

    If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 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 an instance relies on its IPv6 address not changing. When you launch the instance, 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.

  • :dry_run (Boolean) —

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

  • :disable_api_termination (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.

    Default: ‘false`

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html

  • :instance_initiated_shutdown_behavior (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`

  • :private_ip_address (String) —

    The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

    Only one private IP address can be designated as primary. You can’t specify this option if you’ve specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you’re launching more than one instance in the request.

    You cannot specify this option and the network interfaces option in the same request.

  • :client_token (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].

    Constraints: Maximum 64 ASCII characters

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :additional_info (String) —

    Reserved.

  • :network_interfaces (Array<Types::InstanceNetworkInterfaceSpecification>) —

    The network interfaces to associate with the instance.

  • :iam_instance_profile (Types::IamInstanceProfileSpecification) —

    The name or Amazon Resource Name (ARN) of an IAM instance profile.

  • :ebs_optimized (Boolean) —

    Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

    Default: ‘false`

Returns:

See Also:



57986
57987
57988
57989
 
# File 'lib/aws-sdk-ec2/client.rb', line 57986

def run_instances(params = {}, options = {})
  req = build_request(:run_instances, params)
  req.send_request(options)
end

#run_scheduled_instances(params = {}) ⇒ Types::RunScheduledInstancesResult

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can’t stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes.

Examples:

Request syntax with placeholder values


resp = client.run_scheduled_instances({
  client_token: "String",
  dry_run: false,
  instance_count: 1,
  launch_specification: { # required
    block_device_mappings: [
      {
        device_name: "String",
        ebs: {
          delete_on_termination: false,
          encrypted: false,
          iops: 1,
          snapshot_id: "SnapshotId",
          volume_size: 1,
          volume_type: "String",
        },
        no_device: "String",
        virtual_name: "String",
      },
    ],
    ebs_optimized: false,
    iam_instance_profile: {
      arn: "String",
      name: "String",
    },
    image_id: "ImageId", # required
    instance_type: "String",
    kernel_id: "KernelId",
    key_name: "KeyPairName",
    monitoring: {
      enabled: false,
    },
    network_interfaces: [
      {
        associate_public_ip_address: false,
        delete_on_termination: false,
        description: "String",
        device_index: 1,
        groups: ["SecurityGroupId"],
        ipv_6_address_count: 1,
        ipv_6_addresses: [
          {
            ipv_6_address: "Ipv6Address",
          },
        ],
        network_interface_id: "NetworkInterfaceId",
        private_ip_address: "String",
        private_ip_address_configs: [
          {
            primary: false,
            private_ip_address: "String",
          },
        ],
        secondary_private_ip_address_count: 1,
        subnet_id: "SubnetId",
      },
    ],
    placement: {
      availability_zone: "String",
      group_name: "PlacementGroupName",
    },
    ramdisk_id: "RamdiskId",
    security_group_ids: ["SecurityGroupId"],
    subnet_id: "SubnetId",
    user_data: "String",
  },
  scheduled_instance_id: "ScheduledInstanceId", # required
})

Response structure


resp.instance_id_set #=> Array
resp.instance_id_set[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see [Ensuring Idempotency].

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

  • :dry_run (Boolean) —

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

  • :instance_count (Integer) —

    The number of instances.

    Default: 1

  • :launch_specification (required, Types::ScheduledInstancesLaunchSpecification) —

    The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.

  • :scheduled_instance_id (required, String) —

    The Scheduled Instance ID.

Returns:

See Also:



58116
58117
58118
58119
 
# File 'lib/aws-sdk-ec2/client.rb', line 58116

def run_scheduled_instances(params = {}, options = {})
  req = build_request(:run_scheduled_instances, params)
  req.send_request(options)
end

#search_local_gateway_routes(params = {}) ⇒ Types::SearchLocalGatewayRoutesResult

Searches for routes in the specified local gateway route table.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_local_gateway_routes({
  local_gateway_route_table_id: "LocalGatewayRoutetableId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.routes #=> Array
resp.routes[0].destination_cidr_block #=> String
resp.routes[0].local_gateway_virtual_interface_group_id #=> String
resp.routes[0].type #=> String, one of "static", "propagated"
resp.routes[0].state #=> String, one of "pending", "active", "blackhole", "deleting", "deleted"
resp.routes[0].local_gateway_route_table_id #=> String
resp.routes[0].local_gateway_route_table_arn #=> String
resp.routes[0].owner_id #=> String
resp.routes[0].subnet_id #=> String
resp.routes[0].coip_pool_id #=> String
resp.routes[0].network_interface_id #=> String
resp.routes[0].destination_prefix_list_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :local_gateway_route_table_id (required, String) —

    The ID of the local gateway route table.

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘prefix-list-id` - The ID of the prefix list.

    • ‘route-search.exact-match` - The exact match of the specified filter.

    • ‘route-search.longest-prefix-match` - The longest prefix that matches the route.

    • ‘route-search.subnet-of-match` - The routes with a subnet that match the specified CIDR filter.

    • ‘route-search.supernet-of-match` - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify `supernet-of-match` as 10.0.1.0/30, then the result returns 10.0.1.0/29.

    • ‘state` - The state of the route.

    • ‘type` - The route type.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



58206
58207
58208
58209
 
# File 'lib/aws-sdk-ec2/client.rb', line 58206

def search_local_gateway_routes(params = {}, options = {})
  req = build_request(:search_local_gateway_routes, params)
  req.send_request(options)
end

#search_transit_gateway_multicast_groups(params = {}) ⇒ Types::SearchTransitGatewayMulticastGroupsResult

Searches one or more transit gateway multicast groups and returns the group membership information.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_transit_gateway_multicast_groups({
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
})

Response structure


resp.multicast_groups #=> Array
resp.multicast_groups[0].group_ip_address #=> String
resp.multicast_groups[0].transit_gateway_attachment_id #=> String
resp.multicast_groups[0].subnet_id #=> String
resp.multicast_groups[0].resource_id #=> String
resp.multicast_groups[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.multicast_groups[0].resource_owner_id #=> String
resp.multicast_groups[0].network_interface_id #=> String
resp.multicast_groups[0].group_member #=> Boolean
resp.multicast_groups[0].group_source #=> Boolean
resp.multicast_groups[0].member_type #=> String, one of "static", "igmp"
resp.multicast_groups[0].source_type #=> String, one of "static", "igmp"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_multicast_domain_id (required, String) —

    The ID of the transit gateway multicast domain.

  • :filters (Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘group-ip-address` - The IP address of the transit gateway multicast group.

    • ‘is-group-member` - The resource is a group member. Valid values are `true` | `false`.

    • ‘is-group-source` - The resource is a group source. Valid values are `true` | `false`.

    • ‘member-type` - The member type. Valid values are `igmp` | `static`.

    • ‘resource-id` - The ID of the resource.

    • ‘resource-type` - The type of resource. Valid values are `vpc` | `vpn` | `direct-connect-gateway` | `tgw-peering`.

    • ‘source-type` - The source type. Valid values are `igmp` | `static`.

    • ‘subnet-id` - The ID of the subnet.

    • ‘transit-gateway-attachment-id` - The id of the transit gateway attachment.

  • :max_results (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.

  • :next_token (String) —

    The token for the next page of results.

  • :dry_run (Boolean) —

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

Returns:

See Also:



58301
58302
58303
58304
 
# File 'lib/aws-sdk-ec2/client.rb', line 58301

def search_transit_gateway_multicast_groups(params = {}, options = {})
  req = build_request(:search_transit_gateway_multicast_groups, params)
  req.send_request(options)
end

#search_transit_gateway_routes(params = {}) ⇒ Types::SearchTransitGatewayRoutesResult

Searches for routes in the specified transit gateway route table.

Examples:

Request syntax with placeholder values


resp = client.search_transit_gateway_routes({
  transit_gateway_route_table_id: "TransitGatewayRouteTableId", # required
  filters: [ # required
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  dry_run: false,
})

Response structure


resp.routes #=> Array
resp.routes[0].destination_cidr_block #=> String
resp.routes[0].prefix_list_id #=> String
resp.routes[0].transit_gateway_route_table_announcement_id #=> String
resp.routes[0].transit_gateway_attachments #=> Array
resp.routes[0].transit_gateway_attachments[0].resource_id #=> String
resp.routes[0].transit_gateway_attachments[0].transit_gateway_attachment_id #=> String
resp.routes[0].transit_gateway_attachments[0].resource_type #=> String, one of "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering"
resp.routes[0].type #=> String, one of "static", "propagated"
resp.routes[0].state #=> String, one of "pending", "active", "blackhole", "deleting", "deleted"
resp.additional_routes_available #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transit_gateway_route_table_id (required, String) —

    The ID of the transit gateway route table.

  • :filters (required, Array<Types::Filter>) —

    One or more filters. The possible values are:

    • ‘attachment.transit-gateway-attachment-id`- The id of the transit gateway attachment.

    • ‘attachment.resource-id` - The resource id of the transit gateway attachment.

    • ‘attachment.resource-type` - The attachment resource type. Valid values are `vpc` | `vpn` | `direct-connect-gateway` | `peering` | `connect`.

    • ‘prefix-list-id` - The ID of the prefix list.

    • ‘route-search.exact-match` - The exact match of the specified filter.

    • ‘route-search.longest-prefix-match` - The longest prefix that matches the route.

    • ‘route-search.subnet-of-match` - The routes with a subnet that match the specified CIDR filter.

    • ‘route-search.supernet-of-match` - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

    • ‘state` - The state of the route (`active` | `blackhole`).

    • ‘type` - The type of route (`propagated` | `static`).

  • :max_results (Integer) —

    The maximum number of routes to return. If a value is not provided, the default is 1000.

  • :dry_run (Boolean) —

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

Returns:

See Also:



58392
58393
58394
58395
 
# File 'lib/aws-sdk-ec2/client.rb', line 58392

def search_transit_gateway_routes(params = {}, options = {})
  req = build_request(:search_transit_gateway_routes, params)
  req.send_request(options)
end

#send_diagnostic_interrupt(params = {}) ⇒ Struct

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a *kernel panic* (on Linux instances), or a *blue screen*/*stop error* (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a *non-maskable interrupt* (NMI).

In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.

Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.

For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see

Send a diagnostic interrupt (for advanced users)][1

in the *Amazon

EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/diagnostic-interrupt.html

Examples:

Request syntax with placeholder values


resp = client.send_diagnostic_interrupt({
  instance_id: "InstanceId", # required
  dry_run: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the instance.

  • :dry_run (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



58443
58444
58445
58446
 
# File 'lib/aws-sdk-ec2/client.rb', line 58443

def send_diagnostic_interrupt(params = {}, options = {})
  req = build_request(:send_diagnostic_interrupt, params)
  req.send_request(options)
end

#start_instances(params = {}) ⇒ Types::StartInstancesResult

Starts an Amazon EBS-backed instance that you’ve previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

If you attempt to start a T3 instance with ‘host` tenancy and the `unlimited` CPU credit option, the request fails. The `unlimited` CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to `standard`, or change its tenancy to `default` or `dedicated`.

For more information, see [Stop and start Amazon EC2 instances] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html

Examples:

Example: To start a stopped EC2 instance


# This example starts the specified EC2 instance.

resp = client.start_instances({
  instance_ids: [
    "i-1234567890abcdef0", 
  ], 
})

resp.to_h outputs the following:
{
  starting_instances: [
    {
      current_state: {
        code: 0, 
        name: "pending", 
      }, 
      instance_id: "i-1234567890abcdef0", 
      previous_state: {
        code: 80, 
        name: "stopped", 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.start_instances({
  instance_ids: ["InstanceId"], # required
  additional_info: "String",
  dry_run: false,
})

Response structure


resp.starting_instances #=> Array
resp.starting_instances[0].instance_id #=> String
resp.starting_instances[0].current_state.code #=> Integer
resp.starting_instances[0].current_state.name #=> String, one of "pending", "running", "shutting-down", "terminated", "stopping", "stopped"
resp.starting_instances[0].previous_state.code #=> Integer
resp.starting_instances[0].previous_state.name #=> String, one of "pending", "running", "shutting-down", "terminated", "stopping", "stopped"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (required, Array<String>) —

    The IDs of the instances.

  • :additional_info (String) —

    Reserved.

  • :dry_run (Boolean) —

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

Returns:

See Also:



58544
58545
58546
58547
 
# File 'lib/aws-sdk-ec2/client.rb', line 58544

def start_instances(params = {}, options = {})
  req = build_request(:start_instances, params)
  req.send_request(options)
end

#start_network_insights_access_scope_analysis(params = {}) ⇒ Types::StartNetworkInsightsAccessScopeAnalysisResult

Starts analyzing the specified Network Access Scope.

Examples:

Request syntax with placeholder values


resp = client.start_network_insights_access_scope_analysis({
  network_insights_access_scope_id: "NetworkInsightsAccessScopeId", # required
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String", # required
})

Response structure


resp.network_insights_access_scope_analysis.network_insights_access_scope_analysis_id #=> String
resp.network_insights_access_scope_analysis.network_insights_access_scope_analysis_arn #=> String
resp.network_insights_access_scope_analysis.network_insights_access_scope_id #=> String
resp.network_insights_access_scope_analysis.status #=> String, one of "running", "succeeded", "failed"
resp.network_insights_access_scope_analysis.status_message #=> String
resp.network_insights_access_scope_analysis.warning_message #=> String
resp.network_insights_access_scope_analysis.start_date #=> Time
resp.network_insights_access_scope_analysis.end_date #=> Time
resp.network_insights_access_scope_analysis.findings_found #=> String, one of "true", "false", "unknown"
resp.network_insights_access_scope_analysis.analyzed_eni_count #=> Integer
resp.network_insights_access_scope_analysis.tags #=> Array
resp.network_insights_access_scope_analysis.tags[0].key #=> String
resp.network_insights_access_scope_analysis.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_insights_access_scope_id (required, String) —

    The ID of the Network Access Scope.

  • :dry_run (Boolean) —

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

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply.

  • :client_token (required, String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



58618
58619
58620
58621
 
# File 'lib/aws-sdk-ec2/client.rb', line 58618

def start_network_insights_access_scope_analysis(params = {}, options = {})
  req = build_request(:start_network_insights_access_scope_analysis, params)
  req.send_request(options)
end

#start_network_insights_analysis(params = {}) ⇒ Types::StartNetworkInsightsAnalysisResult

Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.

Examples:

Request syntax with placeholder values


resp = client.start_network_insights_analysis({
  network_insights_path_id: "NetworkInsightsPathId", # required
  additional_accounts: ["String"],
  filter_in_arns: ["ResourceArn"],
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts 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: "String",
        },
      ],
    },
  ],
  client_token: "String", # required
})

Response structure


resp.network_insights_analysis.network_insights_analysis_id #=> String
resp.network_insights_analysis.network_insights_analysis_arn #=> String
resp.network_insights_analysis.network_insights_path_id #=> String
resp.network_insights_analysis.additional_accounts #=> Array
resp.network_insights_analysis.additional_accounts[0] #=> String
resp.network_insights_analysis.filter_in_arns #=> Array
resp.network_insights_analysis.filter_in_arns[0] #=> String
resp.network_insights_analysis.start_date #=> Time
resp.network_insights_analysis.status #=> String, one of "running", "succeeded", "failed"
resp.network_insights_analysis.status_message #=> String
resp.network_insights_analysis.warning_message #=> String
resp.network_insights_analysis.network_path_found #=> Boolean
resp.network_insights_analysis.forward_path_components #=> Array
resp.network_insights_analysis.forward_path_components[0].sequence_number #=> Integer
resp.network_insights_analysis.forward_path_components[0].acl_rule.cidr #=> String
resp.network_insights_analysis.forward_path_components[0].acl_rule.egress #=> Boolean
resp.network_insights_analysis.forward_path_components[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analysis.forward_path_components[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analysis.forward_path_components[0].acl_rule.protocol #=> String
resp.network_insights_analysis.forward_path_components[0].acl_rule.rule_action #=> String
resp.network_insights_analysis.forward_path_components[0].acl_rule.rule_number #=> Integer
resp.network_insights_analysis.forward_path_components[0].attached_to.id #=> String
resp.network_insights_analysis.forward_path_components[0].attached_to.arn #=> String
resp.network_insights_analysis.forward_path_components[0].attached_to.name #=> String
resp.network_insights_analysis.forward_path_components[0].component.id #=> String
resp.network_insights_analysis.forward_path_components[0].component.arn #=> String
resp.network_insights_analysis.forward_path_components[0].component.name #=> String
resp.network_insights_analysis.forward_path_components[0].destination_vpc.id #=> String
resp.network_insights_analysis.forward_path_components[0].destination_vpc.arn #=> String
resp.network_insights_analysis.forward_path_components[0].destination_vpc.name #=> String
resp.network_insights_analysis.forward_path_components[0].outbound_header.destination_addresses #=> Array
resp.network_insights_analysis.forward_path_components[0].outbound_header.destination_addresses[0] #=> String
resp.network_insights_analysis.forward_path_components[0].outbound_header.destination_port_ranges #=> Array
resp.network_insights_analysis.forward_path_components[0].outbound_header.destination_port_ranges[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].outbound_header.destination_port_ranges[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].outbound_header.protocol #=> String
resp.network_insights_analysis.forward_path_components[0].outbound_header.source_addresses #=> Array
resp.network_insights_analysis.forward_path_components[0].outbound_header.source_addresses[0] #=> String
resp.network_insights_analysis.forward_path_components[0].outbound_header.source_port_ranges #=> Array
resp.network_insights_analysis.forward_path_components[0].outbound_header.source_port_ranges[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].outbound_header.source_port_ranges[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].inbound_header.destination_addresses #=> Array
resp.network_insights_analysis.forward_path_components[0].inbound_header.destination_addresses[0] #=> String
resp.network_insights_analysis.forward_path_components[0].inbound_header.destination_port_ranges #=> Array
resp.network_insights_analysis.forward_path_components[0].inbound_header.destination_port_ranges[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].inbound_header.destination_port_ranges[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].inbound_header.protocol #=> String
resp.network_insights_analysis.forward_path_components[0].inbound_header.source_addresses #=> Array
resp.network_insights_analysis.forward_path_components[0].inbound_header.source_addresses[0] #=> String
resp.network_insights_analysis.forward_path_components[0].inbound_header.source_port_ranges #=> Array
resp.network_insights_analysis.forward_path_components[0].inbound_header.source_port_ranges[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].inbound_header.source_port_ranges[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].route_table_route.destination_cidr #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.instance_id #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.network_interface_id #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.origin #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.state #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.core_network_arn #=> String
resp.network_insights_analysis.forward_path_components[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].security_group_rule.cidr #=> String
resp.network_insights_analysis.forward_path_components[0].security_group_rule.direction #=> String
resp.network_insights_analysis.forward_path_components[0].security_group_rule.security_group_id #=> String
resp.network_insights_analysis.forward_path_components[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analysis.forward_path_components[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analysis.forward_path_components[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analysis.forward_path_components[0].security_group_rule.protocol #=> String
resp.network_insights_analysis.forward_path_components[0].source_vpc.id #=> String
resp.network_insights_analysis.forward_path_components[0].source_vpc.arn #=> String
resp.network_insights_analysis.forward_path_components[0].source_vpc.name #=> String
resp.network_insights_analysis.forward_path_components[0].subnet.id #=> String
resp.network_insights_analysis.forward_path_components[0].subnet.arn #=> String
resp.network_insights_analysis.forward_path_components[0].subnet.name #=> String
resp.network_insights_analysis.forward_path_components[0].vpc.id #=> String
resp.network_insights_analysis.forward_path_components[0].vpc.arn #=> String
resp.network_insights_analysis.forward_path_components[0].vpc.name #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details #=> Array
resp.network_insights_analysis.forward_path_components[0].additional_details[0].additional_detail_type #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].component.id #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].component.arn #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].component.name #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].vpc_endpoint_service.id #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].vpc_endpoint_service.arn #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].vpc_endpoint_service.name #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_options #=> Array
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_options[0].keyword #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_options[0].settings #=> Array
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_options[0].settings[0] #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_group_type_pairs #=> Array
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_arn #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_type #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_group_rule_options_pairs #=> Array
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_group_arn #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options #=> Array
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].keyword #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings #=> Array
resp.network_insights_analysis.forward_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings[0] #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].service_name #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].load_balancers #=> Array
resp.network_insights_analysis.forward_path_components[0].additional_details[0].load_balancers[0].id #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].load_balancers[0].arn #=> String
resp.network_insights_analysis.forward_path_components[0].additional_details[0].load_balancers[0].name #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway.id #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway.arn #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway.name #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analysis.forward_path_components[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analysis.forward_path_components[0].explanations #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl_rule.cidr #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl_rule.egress #=> Boolean
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl_rule.protocol #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl_rule.rule_action #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].acl_rule.rule_number #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].address #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].addresses #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].addresses[0] #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].attached_to.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].attached_to.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].attached_to.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].availability_zones #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].availability_zones[0] #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].cidrs #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].cidrs[0] #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].component.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].component.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].component.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].customer_gateway.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].customer_gateway.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].customer_gateway.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].destination.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].destination.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].destination.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].destination_vpc.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].destination_vpc.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].destination_vpc.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].direction #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].explanation_code #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].ingress_route_table.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].ingress_route_table.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].ingress_route_table.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].internet_gateway.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].internet_gateway.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].internet_gateway.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].classic_load_balancer_listener.load_balancer_port #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].classic_load_balancer_listener.instance_port #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_listener_port #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target.address #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target.availability_zone #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target.instance.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target.instance.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target.instance.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target.port #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target_group.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target_group.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target_group.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target_groups #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target_groups[0].id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target_groups[0].arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target_groups[0].name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].load_balancer_target_port #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].missing_component #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].nat_gateway.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].nat_gateway.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].nat_gateway.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].network_interface.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].network_interface.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].network_interface.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].packet_field #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpc_peering_connection.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpc_peering_connection.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpc_peering_connection.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].port #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].port_ranges #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].port_ranges[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].port_ranges[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].prefix_list.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].prefix_list.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].prefix_list.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].protocols #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].protocols[0] #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.destination_cidr #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.instance_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.network_interface_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.origin #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.state #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.core_network_arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].route_table.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group_rule.cidr #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group_rule.direction #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group_rule.security_group_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_group_rule.protocol #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_groups #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_groups[0].id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_groups[0].arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].security_groups[0].name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].source_vpc.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].source_vpc.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].source_vpc.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].state #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].subnet.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].subnet.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].subnet.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].subnet_route_table.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].subnet_route_table.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].subnet_route_table.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpc.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpc.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpc.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpc_endpoint.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpc_endpoint.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpc_endpoint.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpn_connection.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpn_connection.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpn_connection.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpn_gateway.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpn_gateway.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].vpn_gateway.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_attachment.id #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_attachment.arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].transit_gateway_attachment.name #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0]. #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].component_region #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analysis.forward_path_components[0].explanations[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analysis.forward_path_components[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analysis.forward_path_components[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analysis.forward_path_components[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analysis.forward_path_components[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analysis.forward_path_components[0].service_name #=> String
resp.network_insights_analysis.return_path_components #=> Array
resp.network_insights_analysis.return_path_components[0].sequence_number #=> Integer
resp.network_insights_analysis.return_path_components[0].acl_rule.cidr #=> String
resp.network_insights_analysis.return_path_components[0].acl_rule.egress #=> Boolean
resp.network_insights_analysis.return_path_components[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analysis.return_path_components[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analysis.return_path_components[0].acl_rule.protocol #=> String
resp.network_insights_analysis.return_path_components[0].acl_rule.rule_action #=> String
resp.network_insights_analysis.return_path_components[0].acl_rule.rule_number #=> Integer
resp.network_insights_analysis.return_path_components[0].attached_to.id #=> String
resp.network_insights_analysis.return_path_components[0].attached_to.arn #=> String
resp.network_insights_analysis.return_path_components[0].attached_to.name #=> String
resp.network_insights_analysis.return_path_components[0].component.id #=> String
resp.network_insights_analysis.return_path_components[0].component.arn #=> String
resp.network_insights_analysis.return_path_components[0].component.name #=> String
resp.network_insights_analysis.return_path_components[0].destination_vpc.id #=> String
resp.network_insights_analysis.return_path_components[0].destination_vpc.arn #=> String
resp.network_insights_analysis.return_path_components[0].destination_vpc.name #=> String
resp.network_insights_analysis.return_path_components[0].outbound_header.destination_addresses #=> Array
resp.network_insights_analysis.return_path_components[0].outbound_header.destination_addresses[0] #=> String
resp.network_insights_analysis.return_path_components[0].outbound_header.destination_port_ranges #=> Array
resp.network_insights_analysis.return_path_components[0].outbound_header.destination_port_ranges[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].outbound_header.destination_port_ranges[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].outbound_header.protocol #=> String
resp.network_insights_analysis.return_path_components[0].outbound_header.source_addresses #=> Array
resp.network_insights_analysis.return_path_components[0].outbound_header.source_addresses[0] #=> String
resp.network_insights_analysis.return_path_components[0].outbound_header.source_port_ranges #=> Array
resp.network_insights_analysis.return_path_components[0].outbound_header.source_port_ranges[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].outbound_header.source_port_ranges[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].inbound_header.destination_addresses #=> Array
resp.network_insights_analysis.return_path_components[0].inbound_header.destination_addresses[0] #=> String
resp.network_insights_analysis.return_path_components[0].inbound_header.destination_port_ranges #=> Array
resp.network_insights_analysis.return_path_components[0].inbound_header.destination_port_ranges[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].inbound_header.destination_port_ranges[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].inbound_header.protocol #=> String
resp.network_insights_analysis.return_path_components[0].inbound_header.source_addresses #=> Array
resp.network_insights_analysis.return_path_components[0].inbound_header.source_addresses[0] #=> String
resp.network_insights_analysis.return_path_components[0].inbound_header.source_port_ranges #=> Array
resp.network_insights_analysis.return_path_components[0].inbound_header.source_port_ranges[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].inbound_header.source_port_ranges[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].route_table_route.destination_cidr #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.instance_id #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.network_interface_id #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.origin #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.state #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.core_network_arn #=> String
resp.network_insights_analysis.return_path_components[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].security_group_rule.cidr #=> String
resp.network_insights_analysis.return_path_components[0].security_group_rule.direction #=> String
resp.network_insights_analysis.return_path_components[0].security_group_rule.security_group_id #=> String
resp.network_insights_analysis.return_path_components[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analysis.return_path_components[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analysis.return_path_components[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analysis.return_path_components[0].security_group_rule.protocol #=> String
resp.network_insights_analysis.return_path_components[0].source_vpc.id #=> String
resp.network_insights_analysis.return_path_components[0].source_vpc.arn #=> String
resp.network_insights_analysis.return_path_components[0].source_vpc.name #=> String
resp.network_insights_analysis.return_path_components[0].subnet.id #=> String
resp.network_insights_analysis.return_path_components[0].subnet.arn #=> String
resp.network_insights_analysis.return_path_components[0].subnet.name #=> String
resp.network_insights_analysis.return_path_components[0].vpc.id #=> String
resp.network_insights_analysis.return_path_components[0].vpc.arn #=> String
resp.network_insights_analysis.return_path_components[0].vpc.name #=> String
resp.network_insights_analysis.return_path_components[0].additional_details #=> Array
resp.network_insights_analysis.return_path_components[0].additional_details[0].additional_detail_type #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].component.id #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].component.arn #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].component.name #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].vpc_endpoint_service.id #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].vpc_endpoint_service.arn #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].vpc_endpoint_service.name #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_options #=> Array
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_options[0].keyword #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_options[0].settings #=> Array
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_options[0].settings[0] #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_group_type_pairs #=> Array
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_arn #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_group_type_pairs[0].rule_group_type #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_group_rule_options_pairs #=> Array
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_group_arn #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options #=> Array
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].keyword #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings #=> Array
resp.network_insights_analysis.return_path_components[0].additional_details[0].rule_group_rule_options_pairs[0].rule_options[0].settings[0] #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].service_name #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].load_balancers #=> Array
resp.network_insights_analysis.return_path_components[0].additional_details[0].load_balancers[0].id #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].load_balancers[0].arn #=> String
resp.network_insights_analysis.return_path_components[0].additional_details[0].load_balancers[0].name #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway.id #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway.arn #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway.name #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analysis.return_path_components[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analysis.return_path_components[0].explanations #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].acl.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].acl.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].acl.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].acl_rule.cidr #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].acl_rule.egress #=> Boolean
resp.network_insights_analysis.return_path_components[0].explanations[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].acl_rule.protocol #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].acl_rule.rule_action #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].acl_rule.rule_number #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].address #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].addresses #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].addresses[0] #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].attached_to.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].attached_to.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].attached_to.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].availability_zones #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].availability_zones[0] #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].cidrs #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].cidrs[0] #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].component.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].component.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].component.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].customer_gateway.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].customer_gateway.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].customer_gateway.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].destination.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].destination.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].destination.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].destination_vpc.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].destination_vpc.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].destination_vpc.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].direction #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].explanation_code #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].ingress_route_table.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].ingress_route_table.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].ingress_route_table.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].internet_gateway.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].internet_gateway.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].internet_gateway.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].classic_load_balancer_listener.load_balancer_port #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].classic_load_balancer_listener.instance_port #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_listener_port #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target.address #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target.availability_zone #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target.instance.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target.instance.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target.instance.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target.port #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target_group.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target_group.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target_group.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target_groups #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target_groups[0].id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target_groups[0].arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target_groups[0].name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].load_balancer_target_port #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].missing_component #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].nat_gateway.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].nat_gateway.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].nat_gateway.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].network_interface.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].network_interface.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].network_interface.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].packet_field #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpc_peering_connection.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpc_peering_connection.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpc_peering_connection.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].port #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].port_ranges #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].port_ranges[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].port_ranges[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].prefix_list.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].prefix_list.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].prefix_list.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].protocols #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].protocols[0] #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.destination_cidr #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.instance_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.network_interface_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.origin #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.state #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.core_network_arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].route_table.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group_rule.cidr #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group_rule.direction #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group_rule.security_group_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_group_rule.protocol #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_groups #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].security_groups[0].id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_groups[0].arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].security_groups[0].name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].source_vpc.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].source_vpc.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].source_vpc.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].state #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].subnet.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].subnet.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].subnet.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].subnet_route_table.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].subnet_route_table.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].subnet_route_table.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpc.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpc.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpc.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpc_endpoint.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpc_endpoint.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpc_endpoint.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpn_connection.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpn_connection.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpn_connection.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpn_gateway.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpn_gateway.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].vpn_gateway.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_attachment.id #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_attachment.arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].transit_gateway_attachment.name #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0]. #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].component_region #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analysis.return_path_components[0].explanations[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analysis.return_path_components[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analysis.return_path_components[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analysis.return_path_components[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analysis.return_path_components[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analysis.return_path_components[0].service_name #=> String
resp.network_insights_analysis.explanations #=> Array
resp.network_insights_analysis.explanations[0].acl.id #=> String
resp.network_insights_analysis.explanations[0].acl.arn #=> String
resp.network_insights_analysis.explanations[0].acl.name #=> String
resp.network_insights_analysis.explanations[0].acl_rule.cidr #=> String
resp.network_insights_analysis.explanations[0].acl_rule.egress #=> Boolean
resp.network_insights_analysis.explanations[0].acl_rule.port_range.from #=> Integer
resp.network_insights_analysis.explanations[0].acl_rule.port_range.to #=> Integer
resp.network_insights_analysis.explanations[0].acl_rule.protocol #=> String
resp.network_insights_analysis.explanations[0].acl_rule.rule_action #=> String
resp.network_insights_analysis.explanations[0].acl_rule.rule_number #=> Integer
resp.network_insights_analysis.explanations[0].address #=> String
resp.network_insights_analysis.explanations[0].addresses #=> Array
resp.network_insights_analysis.explanations[0].addresses[0] #=> String
resp.network_insights_analysis.explanations[0].attached_to.id #=> String
resp.network_insights_analysis.explanations[0].attached_to.arn #=> String
resp.network_insights_analysis.explanations[0].attached_to.name #=> String
resp.network_insights_analysis.explanations[0].availability_zones #=> Array
resp.network_insights_analysis.explanations[0].availability_zones[0] #=> String
resp.network_insights_analysis.explanations[0].cidrs #=> Array
resp.network_insights_analysis.explanations[0].cidrs[0] #=> String
resp.network_insights_analysis.explanations[0].component.id #=> String
resp.network_insights_analysis.explanations[0].component.arn #=> String
resp.network_insights_analysis.explanations[0].component.name #=> String
resp.network_insights_analysis.explanations[0].customer_gateway.id #=> String
resp.network_insights_analysis.explanations[0].customer_gateway.arn #=> String
resp.network_insights_analysis.explanations[0].customer_gateway.name #=> String
resp.network_insights_analysis.explanations[0].destination.id #=> String
resp.network_insights_analysis.explanations[0].destination.arn #=> String
resp.network_insights_analysis.explanations[0].destination.name #=> String
resp.network_insights_analysis.explanations[0].destination_vpc.id #=> String
resp.network_insights_analysis.explanations[0].destination_vpc.arn #=> String
resp.network_insights_analysis.explanations[0].destination_vpc.name #=> String
resp.network_insights_analysis.explanations[0].direction #=> String
resp.network_insights_analysis.explanations[0].explanation_code #=> String
resp.network_insights_analysis.explanations[0].ingress_route_table.id #=> String
resp.network_insights_analysis.explanations[0].ingress_route_table.arn #=> String
resp.network_insights_analysis.explanations[0].ingress_route_table.name #=> String
resp.network_insights_analysis.explanations[0].internet_gateway.id #=> String
resp.network_insights_analysis.explanations[0].internet_gateway.arn #=> String
resp.network_insights_analysis.explanations[0].internet_gateway.name #=> String
resp.network_insights_analysis.explanations[0].load_balancer_arn #=> String
resp.network_insights_analysis.explanations[0].classic_load_balancer_listener.load_balancer_port #=> Integer
resp.network_insights_analysis.explanations[0].classic_load_balancer_listener.instance_port #=> Integer
resp.network_insights_analysis.explanations[0].load_balancer_listener_port #=> Integer
resp.network_insights_analysis.explanations[0].load_balancer_target.address #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target.availability_zone #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target.instance.id #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target.instance.arn #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target.instance.name #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target.port #=> Integer
resp.network_insights_analysis.explanations[0].load_balancer_target_group.id #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target_group.arn #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target_group.name #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target_groups #=> Array
resp.network_insights_analysis.explanations[0].load_balancer_target_groups[0].id #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target_groups[0].arn #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target_groups[0].name #=> String
resp.network_insights_analysis.explanations[0].load_balancer_target_port #=> Integer
resp.network_insights_analysis.explanations[0].elastic_load_balancer_listener.id #=> String
resp.network_insights_analysis.explanations[0].elastic_load_balancer_listener.arn #=> String
resp.network_insights_analysis.explanations[0].elastic_load_balancer_listener.name #=> String
resp.network_insights_analysis.explanations[0].missing_component #=> String
resp.network_insights_analysis.explanations[0].nat_gateway.id #=> String
resp.network_insights_analysis.explanations[0].nat_gateway.arn #=> String
resp.network_insights_analysis.explanations[0].nat_gateway.name #=> String
resp.network_insights_analysis.explanations[0].network_interface.id #=> String
resp.network_insights_analysis.explanations[0].network_interface.arn #=> String
resp.network_insights_analysis.explanations[0].network_interface.name #=> String
resp.network_insights_analysis.explanations[0].packet_field #=> String
resp.network_insights_analysis.explanations[0].vpc_peering_connection.id #=> String
resp.network_insights_analysis.explanations[0].vpc_peering_connection.arn #=> String
resp.network_insights_analysis.explanations[0].vpc_peering_connection.name #=> String
resp.network_insights_analysis.explanations[0].port #=> Integer
resp.network_insights_analysis.explanations[0].port_ranges #=> Array
resp.network_insights_analysis.explanations[0].port_ranges[0].from #=> Integer
resp.network_insights_analysis.explanations[0].port_ranges[0].to #=> Integer
resp.network_insights_analysis.explanations[0].prefix_list.id #=> String
resp.network_insights_analysis.explanations[0].prefix_list.arn #=> String
resp.network_insights_analysis.explanations[0].prefix_list.name #=> String
resp.network_insights_analysis.explanations[0].protocols #=> Array
resp.network_insights_analysis.explanations[0].protocols[0] #=> String
resp.network_insights_analysis.explanations[0].route_table_route.destination_cidr #=> String
resp.network_insights_analysis.explanations[0].route_table_route.destination_prefix_list_id #=> String
resp.network_insights_analysis.explanations[0].route_table_route.egress_only_internet_gateway_id #=> String
resp.network_insights_analysis.explanations[0].route_table_route.gateway_id #=> String
resp.network_insights_analysis.explanations[0].route_table_route.instance_id #=> String
resp.network_insights_analysis.explanations[0].route_table_route.nat_gateway_id #=> String
resp.network_insights_analysis.explanations[0].route_table_route.network_interface_id #=> String
resp.network_insights_analysis.explanations[0].route_table_route.origin #=> String
resp.network_insights_analysis.explanations[0].route_table_route.transit_gateway_id #=> String
resp.network_insights_analysis.explanations[0].route_table_route.vpc_peering_connection_id #=> String
resp.network_insights_analysis.explanations[0].route_table_route.state #=> String
resp.network_insights_analysis.explanations[0].route_table_route.carrier_gateway_id #=> String
resp.network_insights_analysis.explanations[0].route_table_route.core_network_arn #=> String
resp.network_insights_analysis.explanations[0].route_table_route.local_gateway_id #=> String
resp.network_insights_analysis.explanations[0].route_table.id #=> String
resp.network_insights_analysis.explanations[0].route_table.arn #=> String
resp.network_insights_analysis.explanations[0].route_table.name #=> String
resp.network_insights_analysis.explanations[0].security_group.id #=> String
resp.network_insights_analysis.explanations[0].security_group.arn #=> String
resp.network_insights_analysis.explanations[0].security_group.name #=> String
resp.network_insights_analysis.explanations[0].security_group_rule.cidr #=> String
resp.network_insights_analysis.explanations[0].security_group_rule.direction #=> String
resp.network_insights_analysis.explanations[0].security_group_rule.security_group_id #=> String
resp.network_insights_analysis.explanations[0].security_group_rule.port_range.from #=> Integer
resp.network_insights_analysis.explanations[0].security_group_rule.port_range.to #=> Integer
resp.network_insights_analysis.explanations[0].security_group_rule.prefix_list_id #=> String
resp.network_insights_analysis.explanations[0].security_group_rule.protocol #=> String
resp.network_insights_analysis.explanations[0].security_groups #=> Array
resp.network_insights_analysis.explanations[0].security_groups[0].id #=> String
resp.network_insights_analysis.explanations[0].security_groups[0].arn #=> String
resp.network_insights_analysis.explanations[0].security_groups[0].name #=> String
resp.network_insights_analysis.explanations[0].source_vpc.id #=> String
resp.network_insights_analysis.explanations[0].source_vpc.arn #=> String
resp.network_insights_analysis.explanations[0].source_vpc.name #=> String
resp.network_insights_analysis.explanations[0].state #=> String
resp.network_insights_analysis.explanations[0].subnet.id #=> String
resp.network_insights_analysis.explanations[0].subnet.arn #=> String
resp.network_insights_analysis.explanations[0].subnet.name #=> String
resp.network_insights_analysis.explanations[0].subnet_route_table.id #=> String
resp.network_insights_analysis.explanations[0].subnet_route_table.arn #=> String
resp.network_insights_analysis.explanations[0].subnet_route_table.name #=> String
resp.network_insights_analysis.explanations[0].vpc.id #=> String
resp.network_insights_analysis.explanations[0].vpc.arn #=> String
resp.network_insights_analysis.explanations[0].vpc.name #=> String
resp.network_insights_analysis.explanations[0].vpc_endpoint.id #=> String
resp.network_insights_analysis.explanations[0].vpc_endpoint.arn #=> String
resp.network_insights_analysis.explanations[0].vpc_endpoint.name #=> String
resp.network_insights_analysis.explanations[0].vpn_connection.id #=> String
resp.network_insights_analysis.explanations[0].vpn_connection.arn #=> String
resp.network_insights_analysis.explanations[0].vpn_connection.name #=> String
resp.network_insights_analysis.explanations[0].vpn_gateway.id #=> String
resp.network_insights_analysis.explanations[0].vpn_gateway.arn #=> String
resp.network_insights_analysis.explanations[0].vpn_gateway.name #=> String
resp.network_insights_analysis.explanations[0].transit_gateway.id #=> String
resp.network_insights_analysis.explanations[0].transit_gateway.arn #=> String
resp.network_insights_analysis.explanations[0].transit_gateway.name #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table.id #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table.arn #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table.name #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table_route.destination_cidr #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table_route.state #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table_route.route_origin #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table_route.prefix_list_id #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table_route.attachment_id #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table_route.resource_id #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_route_table_route.resource_type #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_attachment.id #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_attachment.arn #=> String
resp.network_insights_analysis.explanations[0].transit_gateway_attachment.name #=> String
resp.network_insights_analysis.explanations[0]. #=> String
resp.network_insights_analysis.explanations[0].component_region #=> String
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.rule_group_arn #=> String
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.sources #=> Array
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.sources[0] #=> String
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.destinations #=> Array
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.destinations[0] #=> String
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.source_ports #=> Array
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.destination_ports #=> Array
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.protocols #=> Array
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.protocols[0] #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.rule_action #=> String
resp.network_insights_analysis.explanations[0].firewall_stateless_rule.priority #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.rule_group_arn #=> String
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.sources #=> Array
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.sources[0] #=> String
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.destinations #=> Array
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.destinations[0] #=> String
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.source_ports #=> Array
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.source_ports[0].from #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.source_ports[0].to #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.destination_ports #=> Array
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.destination_ports[0].from #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.destination_ports[0].to #=> Integer
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.protocol #=> String
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.rule_action #=> String
resp.network_insights_analysis.explanations[0].firewall_stateful_rule.direction #=> String
resp.network_insights_analysis.alternate_path_hints #=> Array
resp.network_insights_analysis.alternate_path_hints[0].component_id #=> String
resp.network_insights_analysis.alternate_path_hints[0].component_arn #=> String
resp.network_insights_analysis.suggested_accounts #=> Array
resp.network_insights_analysis.suggested_accounts[0] #=> String
resp.network_insights_analysis.tags #=> Array
resp.network_insights_analysis.tags[0].key #=> String
resp.network_insights_analysis.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_insights_path_id (required, String) —

    The ID of the path.

  • :additional_accounts (Array<String>) —

    The member accounts that contain resources that the path can traverse.

  • :filter_in_arns (Array<String>) —

    The Amazon Resource Names (ARN) of the resources that the path must traverse.

  • :dry_run (Boolean) —

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

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply.

  • :client_token (required, String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

See Also:



59533
59534
59535
59536
 
# File 'lib/aws-sdk-ec2/client.rb', line 59533

def start_network_insights_analysis(params = {}, options = {})
  req = build_request(:start_network_insights_analysis, params)
  req.send_request(options)
end

#start_vpc_endpoint_service_private_dns_verification(params = {}) ⇒ Types::StartVpcEndpointServicePrivateDnsVerificationResult

Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.

The service provider must successfully perform the verification before the consumer can use the name to access the service.

Before the service provider runs this command, they must add a record to the DNS server.

Examples:

Request syntax with placeholder values


resp = client.start_vpc_endpoint_service_private_dns_verification({
  dry_run: false,
  service_id: "VpcEndpointServiceId", # required
})

Response structure


resp.return_value #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :service_id (required, String) —

    The ID of the endpoint service.

Returns:

See Also:



59575
59576
59577
59578
 
# File 'lib/aws-sdk-ec2/client.rb', line 59575

def start_vpc_endpoint_service_private_dns_verification(params = {}, options = {})
  req = build_request(:start_vpc_endpoint_service_private_dns_verification, params)
  req.send_request(options)
end

#stop_instances(params = {}) ⇒ Types::StopInstancesResult

Stops an Amazon EBS-backed instance. For more information, see [Stop and start Amazon EC2 instances] in the *Amazon EC2 User Guide*.

You can use the Stop action to hibernate an instance if the instance is [enabled for hibernation] and it meets the [hibernation prerequisites]. For more information, see [Hibernate your Amazon EC2 instance] in the *Amazon EC2 User Guide*.

We don’t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can’t stop or hibernate instance store-backed instances. You can’t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see [Hibernating interrupted Spot Instances] in the *Amazon EC2 User Guide*.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see [Instance lifecycle] in the *Amazon EC2 User Guide*.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see [Troubleshoot stopping your instance] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/enabling-hibernation.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html [4]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html [5]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html#hibernate-spot-instances [6]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html [7]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html

Examples:

Example: To stop a running EC2 instance


# This example stops the specified EC2 instance.

resp = client.stop_instances({
  instance_ids: [
    "i-1234567890abcdef0", 
  ], 
})

resp.to_h outputs the following:
{
  stopping_instances: [
    {
      current_state: {
        code: 64, 
        name: "stopping", 
      }, 
      instance_id: "i-1234567890abcdef0", 
      previous_state: {
        code: 16, 
        name: "running", 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.stop_instances({
  instance_ids: ["InstanceId"], # required
  hibernate: false,
  dry_run: false,
  force: false,
})

Response structure


resp.stopping_instances #=> Array
resp.stopping_instances[0].instance_id #=> String
resp.stopping_instances[0].current_state.code #=> Integer
resp.stopping_instances[0].current_state.name #=> String, one of "pending", "running", "shutting-down", "terminated", "stopping", "stopped"
resp.stopping_instances[0].previous_state.code #=> Integer
resp.stopping_instances[0].previous_state.name #=> String, one of "pending", "running", "shutting-down", "terminated", "stopping", "stopped"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (required, Array<String>) —

    The IDs of the instances.

  • :hibernate (Boolean) —

    Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see [Hibernate your instance] in the *Amazon EC2 User Guide*.

    Default: ‘false`

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html

  • :dry_run (Boolean) —

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

  • :force (Boolean) —

    Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

    Default: ‘false`

Returns:

See Also:



59716
59717
59718
59719
 
# File 'lib/aws-sdk-ec2/client.rb', line 59716

def stop_instances(params = {}, options = {})
  req = build_request(:stop_instances, params)
  req.send_request(options)
end

#terminate_client_vpn_connections(params = {}) ⇒ Types::TerminateClientVpnConnectionsResult

Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.

Examples:

Request syntax with placeholder values


resp = client.terminate_client_vpn_connections({
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  connection_id: "String",
  username: "String",
  dry_run: false,
})

Response structure


resp.client_vpn_endpoint_id #=> String
resp.username #=> String
resp.connection_statuses #=> Array
resp.connection_statuses[0].connection_id #=> String
resp.connection_statuses[0].previous_status.code #=> String, one of "active", "failed-to-terminate", "terminating", "terminated"
resp.connection_statuses[0].previous_status.message #=> String
resp.connection_statuses[0].current_status.code #=> String, one of "active", "failed-to-terminate", "terminating", "terminated"
resp.connection_statuses[0].current_status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_vpn_endpoint_id (required, String) —

    The ID of the Client VPN endpoint to which the client is connected.

  • :connection_id (String) —

    The ID of the client connection to be terminated.

  • :username (String) —

    The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.

  • :dry_run (Boolean) —

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

Returns:

See Also:



59772
59773
59774
59775
 
# File 'lib/aws-sdk-ec2/client.rb', line 59772

def terminate_client_vpn_connections(params = {}, options = {})
  req = build_request(:terminate_client_vpn_connections, params)
  req.send_request(options)
end

#terminate_instances(params = {}) ⇒ Types::TerminateInstancesResult

Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:

  • The specified instances that are in the same Availability Zone as the protected instance are not terminated.

  • The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.

For example, say you have the following instances:

  • Instance A: ‘us-east-1a`; Not protected

  • Instance B: ‘us-east-1a`; Not protected

  • Instance C: ‘us-east-1b`; Protected

  • Instance D: ‘us-east-1b`; not protected

If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:

  • Instance A and Instance B are successfully terminated because none of the specified instances in ‘us-east-1a` are enabled for termination protection.

  • Instance C and Instance D fail to terminate because at least one of the specified instances in ‘us-east-1b` (Instance C) is enabled for termination protection.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the ‘DeleteOnTermination` block device mapping parameter set to `true` are automatically deleted. For more information about the differences between stopping and terminating instances, see

Instance lifecycle][1

in the *Amazon EC2 User Guide*.

For more information about troubleshooting, see [Troubleshooting terminating your instance] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html

Examples:

Example: To terminate an EC2 instance


# This example terminates the specified EC2 instance.

resp = client.terminate_instances({
  instance_ids: [
    "i-1234567890abcdef0", 
  ], 
})

resp.to_h outputs the following:
{
  terminating_instances: [
    {
      current_state: {
        code: 32, 
        name: "shutting-down", 
      }, 
      instance_id: "i-1234567890abcdef0", 
      previous_state: {
        code: 16, 
        name: "running", 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.terminate_instances({
  instance_ids: ["InstanceId"], # required
  dry_run: false,
})

Response structure


resp.terminating_instances #=> Array
resp.terminating_instances[0].instance_id #=> String
resp.terminating_instances[0].current_state.code #=> Integer
resp.terminating_instances[0].current_state.name #=> String, one of "pending", "running", "shutting-down", "terminated", "stopping", "stopped"
resp.terminating_instances[0].previous_state.code #=> Integer
resp.terminating_instances[0].previous_state.name #=> String, one of "pending", "running", "shutting-down", "terminated", "stopping", "stopped"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (required, Array<String>) —

    The IDs of the instances.

    Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.

  • :dry_run (Boolean) —

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

Returns:

See Also:



59905
59906
59907
59908
 
# File 'lib/aws-sdk-ec2/client.rb', line 59905

def terminate_instances(params = {}, options = {})
  req = build_request(:terminate_instances, params)
  req.send_request(options)
end

#unassign_ipv_6_addresses(params = {}) ⇒ Types::UnassignIpv6AddressesResult

Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.

Examples:

Request syntax with placeholder values


resp = client.unassign_ipv_6_addresses({
  ipv_6_prefixes: ["String"],
  network_interface_id: "NetworkInterfaceId", # required
  ipv_6_addresses: ["String"],
})

Response structure


resp.network_interface_id #=> String
resp.unassigned_ipv_6_addresses #=> Array
resp.unassigned_ipv_6_addresses[0] #=> String
resp.unassigned_ipv_6_prefixes #=> Array
resp.unassigned_ipv_6_prefixes[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ipv_6_prefixes (Array<String>) —

    The IPv6 prefixes to unassign from the network interface.

  • :network_interface_id (required, String) —

    The ID of the network interface.

  • :ipv_6_addresses (Array<String>) —

    The IPv6 addresses to unassign from the network interface.

Returns:

See Also:



59948
59949
59950
59951
 
# File 'lib/aws-sdk-ec2/client.rb', line 59948

def unassign_ipv_6_addresses(params = {}, options = {})
  req = build_request(:unassign_ipv_6_addresses, params)
  req.send_request(options)
end

#unassign_private_ip_addresses(params = {}) ⇒ Struct

Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.

Examples:

Example: To unassign a secondary private IP address from a network interface


# This example unassigns the specified private IP address from the specified network interface.

resp = client.unassign_private_ip_addresses({
  network_interface_id: "eni-e5aa89a3", 
  private_ip_addresses: [
    "10.0.0.82", 
  ], 
})

Request syntax with placeholder values


resp = client.unassign_private_ip_addresses({
  ipv_4_prefixes: ["String"],
  network_interface_id: "NetworkInterfaceId", # required
  private_ip_addresses: ["String"],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ipv_4_prefixes (Array<String>) —

    The IPv4 prefixes to unassign from the network interface.

  • :network_interface_id (required, String) —

    The ID of the network interface.

  • :private_ip_addresses (Array<String>) —

    The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



59993
59994
59995
59996
 
# File 'lib/aws-sdk-ec2/client.rb', line 59993

def unassign_private_ip_addresses(params = {}, options = {})
  req = build_request(:unassign_private_ip_addresses, params)
  req.send_request(options)
end

#unassign_private_nat_gateway_address(params = {}) ⇒ Types::UnassignPrivateNatGatewayAddressResult

Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see

Edit secondary IP address associations][1

in the *Amazon VPC User

Guide*.

While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.

A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections, but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses are released.

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-edit-secondary

Examples:

Request syntax with placeholder values


resp = client.unassign_private_nat_gateway_address({
  nat_gateway_id: "NatGatewayId", # required
  private_ip_addresses: ["String"], # required
  max_drain_duration_seconds: 1,
  dry_run: false,
})

Response structure


resp.nat_gateway_id #=> String
resp.nat_gateway_addresses #=> Array
resp.nat_gateway_addresses[0].allocation_id #=> String
resp.nat_gateway_addresses[0].network_interface_id #=> String
resp.nat_gateway_addresses[0].private_ip #=> String
resp.nat_gateway_addresses[0].public_ip #=> String
resp.nat_gateway_addresses[0].association_id #=> String
resp.nat_gateway_addresses[0].is_primary #=> Boolean
resp.nat_gateway_addresses[0].failure_message #=> String
resp.nat_gateway_addresses[0].status #=> String, one of "assigning", "unassigning", "associating", "disassociating", "succeeded", "failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :nat_gateway_id (required, String) —

    The ID of the NAT gateway.

  • :private_ip_addresses (required, Array<String>) —

    The private IPv4 addresses you want to unassign.

  • :max_drain_duration_seconds (Integer) —

    The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

  • :dry_run (Boolean) —

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

Returns:

See Also:



60070
60071
60072
60073
 
# File 'lib/aws-sdk-ec2/client.rb', line 60070

def unassign_private_nat_gateway_address(params = {}, options = {})
  req = build_request(:unassign_private_nat_gateway_address, params)
  req.send_request(options)
end

#unlock_snapshot(params = {}) ⇒ Types::UnlockSnapshotResult

Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period. You can’t unlock a snapshot that is locked in compliance mode after the cooling-off period has expired.

Examples:

Request syntax with placeholder values


resp = client.unlock_snapshot({
  snapshot_id: "SnapshotId", # required
  dry_run: false,
})

Response structure


resp.snapshot_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The ID of the snapshot to unlock.

  • :dry_run (Boolean) —

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

Returns:

See Also:



60108
60109
60110
60111
 
# File 'lib/aws-sdk-ec2/client.rb', line 60108

def unlock_snapshot(params = {}, options = {})
  req = build_request(:unlock_snapshot, params)
  req.send_request(options)
end

#unmonitor_instances(params = {}) ⇒ Types::UnmonitorInstancesResult

Disables detailed monitoring for a running instance. For more information, see [Monitoring your instances and volumes] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html

Examples:

Request syntax with placeholder values


resp = client.unmonitor_instances({
  instance_ids: ["InstanceId"], # required
  dry_run: false,
})

Response structure


resp.instance_monitorings #=> Array
resp.instance_monitorings[0].instance_id #=> String
resp.instance_monitorings[0].monitoring.state #=> String, one of "disabled", "disabling", "enabled", "pending"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_ids (required, Array<String>) —

    The IDs of the instances.

  • :dry_run (Boolean) —

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

Returns:

See Also:



60151
60152
60153
60154
 
# File 'lib/aws-sdk-ec2/client.rb', line 60151

def unmonitor_instances(params = {}, options = {})
  req = build_request(:unmonitor_instances, params)
  req.send_request(options)
end

#update_security_group_rule_descriptions_egress(params = {}) ⇒ Types::UpdateSecurityGroupRuleDescriptionsEgressResult

Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.

Examples:

Example: To update an outbound security group rule description


# This example updates the description for the specified security group rule.

resp = client.update_security_group_rule_descriptions_egress({
  group_id: "sg-123abc12", 
  ip_permissions: [
    {
      from_port: 80, 
      ip_protocol: "tcp", 
      ip_ranges: [
        {
          cidr_ip: "203.0.113.0/24", 
          description: "Outbound HTTP access to server 2", 
        }, 
      ], 
      to_port: 80, 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.update_security_group_rule_descriptions_egress({
  dry_run: false,
  group_id: "SecurityGroupId",
  group_name: "SecurityGroupName",
  ip_permissions: [
    {
      ip_protocol: "String",
      from_port: 1,
      to_port: 1,
      user_id_group_pairs: [
        {
          description: "String",
          user_id: "String",
          group_name: "String",
          group_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
          peering_status: "String",
        },
      ],
      ip_ranges: [
        {
          description: "String",
          cidr_ip: "String",
        },
      ],
      ipv_6_ranges: [
        {
          description: "String",
          cidr_ipv_6: "String",
        },
      ],
      prefix_list_ids: [
        {
          description: "String",
          prefix_list_id: "String",
        },
      ],
    },
  ],
  security_group_rule_descriptions: [
    {
      security_group_rule_id: "String",
      description: "String",
    },
  ],
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :group_id (String) —

    The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

  • :group_name (String) —

    [Default VPC] The name of the security group. You must specify either the security group ID or the security group name.

  • :ip_permissions (Array<Types::IpPermission>) —

    The IP permissions for the security group rule. You must specify either the IP permissions or the description.

  • :security_group_rule_descriptions (Array<Types::SecurityGroupRuleDescription>) —

    The description for the egress security group rules. You must specify either the description or the IP permissions.

Returns:

See Also:



60273
60274
60275
60276
 
# File 'lib/aws-sdk-ec2/client.rb', line 60273

def update_security_group_rule_descriptions_egress(params = {}, options = {})
  req = build_request(:update_security_group_rule_descriptions_egress, params)
  req.send_request(options)
end

#update_security_group_rule_descriptions_ingress(params = {}) ⇒ Types::UpdateSecurityGroupRuleDescriptionsIngressResult

Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.

Examples:

Example: To update an inbound security group rule description


# This example updates the description for the specified security group rule.

resp = client.update_security_group_rule_descriptions_ingress({
  group_id: "sg-123abc12", 
  ip_permissions: [
    {
      from_port: 22, 
      ip_protocol: "tcp", 
      ip_ranges: [
        {
          cidr_ip: "203.0.113.0/16", 
          description: "SSH access from the LA office", 
        }, 
      ], 
      to_port: 22, 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.update_security_group_rule_descriptions_ingress({
  dry_run: false,
  group_id: "SecurityGroupId",
  group_name: "SecurityGroupName",
  ip_permissions: [
    {
      ip_protocol: "String",
      from_port: 1,
      to_port: 1,
      user_id_group_pairs: [
        {
          description: "String",
          user_id: "String",
          group_name: "String",
          group_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
          peering_status: "String",
        },
      ],
      ip_ranges: [
        {
          description: "String",
          cidr_ip: "String",
        },
      ],
      ipv_6_ranges: [
        {
          description: "String",
          cidr_ipv_6: "String",
        },
      ],
      prefix_list_ids: [
        {
          description: "String",
          prefix_list_id: "String",
        },
      ],
    },
  ],
  security_group_rule_descriptions: [
    {
      security_group_rule_id: "String",
      description: "String",
    },
  ],
})

Response structure


resp.return #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean) —

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

  • :group_id (String) —

    The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

  • :group_name (String) —

    [Default VPC] The name of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.

  • :ip_permissions (Array<Types::IpPermission>) —

    The IP permissions for the security group rule. You must specify either IP permissions or a description.

  • :security_group_rule_descriptions (Array<Types::SecurityGroupRuleDescription>) —

    The description for the ingress security group rules. You must specify either a description or IP permissions.

Returns:

See Also:



60396
60397
60398
60399
 
# File 'lib/aws-sdk-ec2/client.rb', line 60396

def update_security_group_rule_descriptions_ingress(params = {}, options = {})
  req = build_request(:update_security_group_rule_descriptions_ingress, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

## Basic Usage

A waiter will call an API operation until:

  • It is successful

  • It enters a terminal state

  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

## Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

## Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.

| waiter_name | params | :delay | :max_attempts | | ——————————- | —————————————– | ——– | ————- | | bundle_task_complete | #describe_bundle_tasks | 15 | 40 | | conversion_task_cancelled | #describe_conversion_tasks | 15 | 40 | | conversion_task_completed | #describe_conversion_tasks | 15 | 40 | | conversion_task_deleted | #describe_conversion_tasks | 15 | 40 | | customer_gateway_available | #describe_customer_gateways | 15 | 40 | | export_task_cancelled | #describe_export_tasks | 15 | 40 | | export_task_completed | #describe_export_tasks | 15 | 40 | | image_available | #describe_images | 15 | 40 | | image_exists | #describe_images | 15 | 40 | | instance_exists | #describe_instances | 5 | 40 | | instance_running | #describe_instances | 15 | 40 | | instance_status_ok | #describe_instance_status | 15 | 40 | | instance_stopped | #describe_instances | 15 | 40 | | instance_terminated | #describe_instances | 15 | 40 | | internet_gateway_exists | #describe_internet_gateways | 5 | 6 | | key_pair_exists | #describe_key_pairs | 5 | 6 | | nat_gateway_available | #describe_nat_gateways | 15 | 40 | | nat_gateway_deleted | #describe_nat_gateways | 15 | 40 | | network_interface_available | #describe_network_interfaces | 20 | 10 | | password_data_available | #get_password_data | 15 | 40 | | security_group_exists | #describe_security_groups | 5 | 6 | | snapshot_completed | #describe_snapshots | 15 | 40 | | snapshot_imported | #describe_import_snapshot_tasks | 15 | 40 | | spot_instance_request_fulfilled | #describe_spot_instance_requests | 15 | 40 | | store_image_task_complete | #describe_store_image_tasks | 5 | 40 | | subnet_available | #describe_subnets | 15 | 40 | | system_status_ok | #describe_instance_status | 15 | 40 | | volume_available | #describe_volumes | 15 | 40 | | volume_deleted | #describe_volumes | 15 | 40 | | volume_in_use | #describe_volumes | 15 | 40 | | vpc_available | #describe_vpcs | 15 | 40 | | vpc_exists | #describe_vpcs | 1 | 5 | | vpc_peering_connection_deleted | #describe_vpc_peering_connections | 15 | 40 | | vpc_peering_connection_exists | #describe_vpc_peering_connections | 15 | 40 | | vpn_connection_available | #describe_vpn_connections | 15 | 40 | | vpn_connection_deleted | #describe_vpn_connections | 15 | 40 |

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns ‘true` if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



60598
60599
60600
60601
60602
 
# File 'lib/aws-sdk-ec2/client.rb', line 60598

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


60606
60607
60608
 
# File 'lib/aws-sdk-ec2/client.rb', line 60606

def waiter_names
  waiters.keys
end

#withdraw_byoip_cidr(params = {}) ⇒ Types::WithdrawByoipCidrResult

Stops advertising an address range that is provisioned as an address pool.

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

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

Examples:

Request syntax with placeholder values


resp = client.withdraw_byoip_cidr({
  cidr: "String", # required
  dry_run: false,
})

Response structure


resp.byoip_cidr.cidr #=> String
resp.byoip_cidr.description #=> String
resp.byoip_cidr.asn_associations #=> Array
resp.byoip_cidr.asn_associations[0].asn #=> String
resp.byoip_cidr.asn_associations[0].cidr #=> String
resp.byoip_cidr.asn_associations[0].status_message #=> String
resp.byoip_cidr.asn_associations[0].state #=> String, one of "disassociated", "failed-disassociation", "failed-association", "pending-disassociation", "pending-association", "associated"
resp.byoip_cidr.status_message #=> String
resp.byoip_cidr.state #=> String, one of "advertised", "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned", "provisioned-not-publicly-advertisable"
resp.byoip_cidr.network_border_group #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cidr (required, String) —

    The address range, in CIDR notation.

  • :dry_run (Boolean) —

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

Returns:

See Also:



60448
60449
60450
60451
 
# File 'lib/aws-sdk-ec2/client.rb', line 60448

def withdraw_byoip_cidr(params = {}, options = {})
  req = build_request(:withdraw_byoip_cidr, params)
  req.send_request(options)
end