Class: Aws::Outposts::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

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 used for authentication. 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[:credentials]

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

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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['AWS_EC2_METADATA_DISABLED'] 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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 https://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:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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) —

    Your Bearer token used for authentication. 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::Outposts::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Outposts::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 'http://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.



476
477
478
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 476

def initialize(*args)
  super
end

Instance Method Details

#cancel_capacity_task(params = {}) ⇒ Struct

Cancels the capacity task.

Examples:

Request syntax with placeholder values


resp = client.cancel_capacity_task({
  capacity_task_id: "CapacityTaskId", # required
  outpost_identifier: "OutpostIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :capacity_task_id (required, String) —

    ID of the capacity task that you want to cancel.

  • :outpost_identifier (required, String) —

    ID or ARN of the Outpost associated with the capacity task that you want to cancel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



504
505
506
507
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 504

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

#cancel_order(params = {}) ⇒ Struct

Cancels the specified order for an Outpost.

Examples:

Request syntax with placeholder values


resp = client.cancel_order({
  order_id: "OrderId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :order_id (required, String) —

    The ID of the order.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



526
527
528
529
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 526

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

#create_order(params = {}) ⇒ Types::CreateOrderOutput

Creates an order for an Outpost.

Examples:

Request syntax with placeholder values


resp = client.create_order({
  outpost_identifier: "OutpostIdentifier", # required
  line_items: [ # required
    {
      catalog_item_id: "SkuCode",
      quantity: 1,
    },
  ],
  payment_option: "ALL_UPFRONT", # required, accepts ALL_UPFRONT, NO_UPFRONT, PARTIAL_UPFRONT
  payment_term: "THREE_YEARS", # accepts THREE_YEARS, ONE_YEAR, FIVE_YEARS
})

Response structure


resp.order.outpost_id #=> String
resp.order.order_id #=> String
resp.order.status #=> String, one of "RECEIVED", "PENDING", "PROCESSING", "INSTALLING", "FULFILLED", "CANCELLED", "PREPARING", "IN_PROGRESS", "DELIVERED", "COMPLETED", "ERROR"
resp.order.line_items #=> Array
resp.order.line_items[0].catalog_item_id #=> String
resp.order.line_items[0].line_item_id #=> String
resp.order.line_items[0].quantity #=> Integer
resp.order.line_items[0].status #=> String, one of "PREPARING", "BUILDING", "SHIPPED", "DELIVERED", "INSTALLING", "INSTALLED", "ERROR", "CANCELLED", "REPLACED"
resp.order.line_items[0].shipment_information.shipment_tracking_number #=> String
resp.order.line_items[0].shipment_information.shipment_carrier #=> String, one of "DHL", "DBS", "FEDEX", "UPS", "EXPEDITORS"
resp.order.line_items[0].asset_information_list #=> Array
resp.order.line_items[0].asset_information_list[0].asset_id #=> String
resp.order.line_items[0].asset_information_list[0].mac_address_list #=> Array
resp.order.line_items[0].asset_information_list[0].mac_address_list[0] #=> String
resp.order.line_items[0].previous_line_item_id #=> String
resp.order.line_items[0].previous_order_id #=> String
resp.order.payment_option #=> String, one of "ALL_UPFRONT", "NO_UPFRONT", "PARTIAL_UPFRONT"
resp.order.order_submission_date #=> Time
resp.order.order_fulfilled_date #=> Time
resp.order.payment_term #=> String, one of "THREE_YEARS", "ONE_YEAR", "FIVE_YEARS"
resp.order.order_type #=> String, one of "OUTPOST", "REPLACEMENT"

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_identifier (required, String) —

    The ID or the Amazon Resource Name (ARN) of the Outpost.

  • :line_items (required, Array<Types::LineItemRequest>) —

    The line items that make up the order.

  • :payment_option (required, String) —

    The payment option.

  • :payment_term (String) —

    The payment terms.

Returns:

See Also:



591
592
593
594
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 591

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

#create_outpost(params = {}) ⇒ Types::CreateOutpostOutput

Creates an Outpost.

You can specify either an Availability one or an AZ ID.

Examples:

Request syntax with placeholder values


resp = client.create_outpost({
  name: "OutpostName", # required
  description: "OutpostDescription",
  site_id: "SiteId", # required
  availability_zone: "AvailabilityZone",
  availability_zone_id: "AvailabilityZoneId",
  tags: {
    "TagKey" => "TagValue",
  },
  supported_hardware_type: "RACK", # accepts RACK, SERVER
})

Response structure


resp.outpost.outpost_id #=> String
resp.outpost.owner_id #=> String
resp.outpost.outpost_arn #=> String
resp.outpost.site_id #=> String
resp.outpost.name #=> String
resp.outpost.description #=> String
resp.outpost.life_cycle_status #=> String
resp.outpost.availability_zone #=> String
resp.outpost.availability_zone_id #=> String
resp.outpost.tags #=> Hash
resp.outpost.tags["TagKey"] #=> String
resp.outpost.site_arn #=> String
resp.outpost.supported_hardware_type #=> String, one of "RACK", "SERVER"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Outpost.

  • :description (String) —

    The description of the Outpost.

  • :site_id (required, String) —

    The ID or the Amazon Resource Name (ARN) of the site.

  • :availability_zone (String) —

    The Availability Zone.

  • :availability_zone_id (String) —

    The ID of the Availability Zone.

  • :tags (Hash<String,String>) —

    The tags to apply to the Outpost.

  • :supported_hardware_type (String) —

    The type of hardware for this Outpost.

Returns:

See Also:



659
660
661
662
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 659

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

#create_site(params = {}) ⇒ Types::CreateSiteOutput

Creates a site for an Outpost.

Examples:

Request syntax with placeholder values


resp = client.create_site({
  name: "SiteName", # required
  description: "SiteDescription",
  notes: "SiteNotes",
  tags: {
    "TagKey" => "TagValue",
  },
  operating_address: {
    contact_name: "ContactName", # required
    contact_phone_number: "ContactPhoneNumber", # required
    address_line_1: "AddressLine1", # required
    address_line_2: "AddressLine2",
    address_line_3: "AddressLine3",
    city: "City", # required
    state_or_region: "StateOrRegion", # required
    district_or_county: "DistrictOrCounty",
    postal_code: "PostalCode", # required
    country_code: "CountryCode", # required
    municipality: "Municipality",
  },
  shipping_address: {
    contact_name: "ContactName", # required
    contact_phone_number: "ContactPhoneNumber", # required
    address_line_1: "AddressLine1", # required
    address_line_2: "AddressLine2",
    address_line_3: "AddressLine3",
    city: "City", # required
    state_or_region: "StateOrRegion", # required
    district_or_county: "DistrictOrCounty",
    postal_code: "PostalCode", # required
    country_code: "CountryCode", # required
    municipality: "Municipality",
  },
  rack_physical_properties: {
    power_draw_kva: "POWER_5_KVA", # accepts POWER_5_KVA, POWER_10_KVA, POWER_15_KVA, POWER_30_KVA
    power_phase: "SINGLE_PHASE", # accepts SINGLE_PHASE, THREE_PHASE
    power_connector: "L6_30P", # accepts L6_30P, IEC309, AH530P7W, AH532P6W, CS8365C
    power_feed_drop: "ABOVE_RACK", # accepts ABOVE_RACK, BELOW_RACK
    uplink_gbps: "UPLINK_1G", # accepts UPLINK_1G, UPLINK_10G, UPLINK_40G, UPLINK_100G
    uplink_count: "UPLINK_COUNT_1", # accepts UPLINK_COUNT_1, UPLINK_COUNT_2, UPLINK_COUNT_3, UPLINK_COUNT_4, UPLINK_COUNT_5, UPLINK_COUNT_6, UPLINK_COUNT_7, UPLINK_COUNT_8, UPLINK_COUNT_12, UPLINK_COUNT_16
    fiber_optic_cable_type: "SINGLE_MODE", # accepts SINGLE_MODE, MULTI_MODE
    optical_standard: "OPTIC_10GBASE_SR", # accepts OPTIC_10GBASE_SR, OPTIC_10GBASE_IR, OPTIC_10GBASE_LR, OPTIC_40GBASE_SR, OPTIC_40GBASE_ESR, OPTIC_40GBASE_IR4_LR4L, OPTIC_40GBASE_LR4, OPTIC_100GBASE_SR4, OPTIC_100GBASE_CWDM4, OPTIC_100GBASE_LR4, OPTIC_100G_PSM4_MSA, OPTIC_1000BASE_LX, OPTIC_1000BASE_SX
    maximum_supported_weight_lbs: "NO_LIMIT", # accepts NO_LIMIT, MAX_1400_LBS, MAX_1600_LBS, MAX_1800_LBS, MAX_2000_LBS
  },
})

Response structure


resp.site.site_id #=> String
resp.site. #=> String
resp.site.name #=> String
resp.site.description #=> String
resp.site.tags #=> Hash
resp.site.tags["TagKey"] #=> String
resp.site.site_arn #=> String
resp.site.notes #=> String
resp.site.operating_address_country_code #=> String
resp.site.operating_address_state_or_region #=> String
resp.site.operating_address_city #=> String
resp.site.rack_physical_properties.power_draw_kva #=> String, one of "POWER_5_KVA", "POWER_10_KVA", "POWER_15_KVA", "POWER_30_KVA"
resp.site.rack_physical_properties.power_phase #=> String, one of "SINGLE_PHASE", "THREE_PHASE"
resp.site.rack_physical_properties.power_connector #=> String, one of "L6_30P", "IEC309", "AH530P7W", "AH532P6W", "CS8365C"
resp.site.rack_physical_properties.power_feed_drop #=> String, one of "ABOVE_RACK", "BELOW_RACK"
resp.site.rack_physical_properties.uplink_gbps #=> String, one of "UPLINK_1G", "UPLINK_10G", "UPLINK_40G", "UPLINK_100G"
resp.site.rack_physical_properties.uplink_count #=> String, one of "UPLINK_COUNT_1", "UPLINK_COUNT_2", "UPLINK_COUNT_3", "UPLINK_COUNT_4", "UPLINK_COUNT_5", "UPLINK_COUNT_6", "UPLINK_COUNT_7", "UPLINK_COUNT_8", "UPLINK_COUNT_12", "UPLINK_COUNT_16"
resp.site.rack_physical_properties.fiber_optic_cable_type #=> String, one of "SINGLE_MODE", "MULTI_MODE"
resp.site.rack_physical_properties.optical_standard #=> String, one of "OPTIC_10GBASE_SR", "OPTIC_10GBASE_IR", "OPTIC_10GBASE_LR", "OPTIC_40GBASE_SR", "OPTIC_40GBASE_ESR", "OPTIC_40GBASE_IR4_LR4L", "OPTIC_40GBASE_LR4", "OPTIC_100GBASE_SR4", "OPTIC_100GBASE_CWDM4", "OPTIC_100GBASE_LR4", "OPTIC_100G_PSM4_MSA", "OPTIC_1000BASE_LX", "OPTIC_1000BASE_SX"
resp.site.rack_physical_properties.maximum_supported_weight_lbs #=> String, one of "NO_LIMIT", "MAX_1400_LBS", "MAX_1600_LBS", "MAX_1800_LBS", "MAX_2000_LBS"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the site.

  • :description (String) —

    The description of the site.

  • :notes (String) —

    Additional information that you provide about site access requirements, electrician scheduling, personal protective equipment, or regulation of equipment materials that could affect your installation process.

  • :tags (Hash<String,String>) —

    The tags to apply to a site.

  • :operating_address (Types::Address) —

    The location to install and power on the hardware. This address might be different from the shipping address.

  • :shipping_address (Types::Address) —

    The location to ship the hardware. This address might be different from the operating address.

  • :rack_physical_properties (Types::RackPhysicalProperties) —

    Information about the physical and logistical details for the rack at this site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

Returns:

See Also:



778
779
780
781
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 778

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

#delete_outpost(params = {}) ⇒ Struct

Deletes the specified Outpost.

Examples:

Request syntax with placeholder values


resp = client.delete_outpost({
  outpost_id: "OutpostId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_id (required, String) —

    The ID or ARN of the Outpost.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



800
801
802
803
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 800

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

#delete_site(params = {}) ⇒ Struct

Deletes the specified site.

Examples:

Request syntax with placeholder values


resp = client.delete_site({
  site_id: "SiteId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :site_id (required, String) —

    The ID or the Amazon Resource Name (ARN) of the site.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



822
823
824
825
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 822

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

#get_capacity_task(params = {}) ⇒ Types::GetCapacityTaskOutput

Gets details of the specified capacity task.

Examples:

Request syntax with placeholder values


resp = client.get_capacity_task({
  capacity_task_id: "CapacityTaskId", # required
  outpost_identifier: "OutpostIdentifier", # required
})

Response structure


resp.capacity_task_id #=> String
resp.outpost_id #=> String
resp.order_id #=> String
resp.asset_id #=> String
resp.requested_instance_pools #=> Array
resp.requested_instance_pools[0].instance_type #=> String
resp.requested_instance_pools[0].count #=> Integer
resp.instances_to_exclude.instances #=> Array
resp.instances_to_exclude.instances[0] #=> String
resp.instances_to_exclude. #=> Array
resp.instances_to_exclude.[0] #=> String
resp.instances_to_exclude.services #=> Array
resp.instances_to_exclude.services[0] #=> String, one of "AWS", "EC2", "ELASTICACHE", "ELB", "RDS", "ROUTE53"
resp.dry_run #=> Boolean
resp.capacity_task_status #=> String, one of "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "WAITING_FOR_EVACUATION", "CANCELLATION_IN_PROGRESS", "CANCELLED"
resp.failed.reason #=> String
resp.failed.type #=> String, one of "UNSUPPORTED_CAPACITY_CONFIGURATION", "UNEXPECTED_ASSET_STATE", "BLOCKING_INSTANCES_NOT_EVACUATED", "INTERNAL_SERVER_ERROR", "RESOURCE_NOT_FOUND"
resp.creation_date #=> Time
resp.completion_date #=> Time
resp.last_modified_date #=> Time
resp.task_action_on_blocking_instances #=> String, one of "WAIT_FOR_EVACUATION", "FAIL_TASK"

Parameters:

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

    ({})

Options Hash (params):

  • :capacity_task_id (required, String) —

    ID of the capacity task.

  • :outpost_identifier (required, String) —

    ID or ARN of the Outpost associated with the specified capacity task.

Returns:

See Also:



886
887
888
889
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 886

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

#get_catalog_item(params = {}) ⇒ Types::GetCatalogItemOutput

Gets information about the specified catalog item.

Examples:

Request syntax with placeholder values


resp = client.get_catalog_item({
  catalog_item_id: "SkuCode", # required
})

Response structure


resp.catalog_item.catalog_item_id #=> String
resp.catalog_item.item_status #=> String, one of "AVAILABLE", "DISCONTINUED"
resp.catalog_item.ec2_capacities #=> Array
resp.catalog_item.ec2_capacities[0].family #=> String
resp.catalog_item.ec2_capacities[0].max_size #=> String
resp.catalog_item.ec2_capacities[0].quantity #=> String
resp.catalog_item.power_kva #=> Float
resp.catalog_item.weight_lbs #=> Integer
resp.catalog_item.supported_uplink_gbps #=> Array
resp.catalog_item.supported_uplink_gbps[0] #=> Integer
resp.catalog_item.supported_storage #=> Array
resp.catalog_item.supported_storage[0] #=> String, one of "EBS", "S3"

Parameters:

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

    ({})

Options Hash (params):

  • :catalog_item_id (required, String) —

    The ID of the catalog item.

Returns:

See Also:



925
926
927
928
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 925

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

#get_connection(params = {}) ⇒ Types::GetConnectionResponse

Amazon Web Services uses this action to install Outpost servers.

Gets information about the specified connection.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_connection({
  connection_id: "ConnectionId", # required
})

Response structure


resp.connection_id #=> String
resp.connection_details.client_public_key #=> String
resp.connection_details.server_public_key #=> String
resp.connection_details.server_endpoint #=> String
resp.connection_details.client_tunnel_address #=> String
resp.connection_details.server_tunnel_address #=> String
resp.connection_details.allowed_ips #=> Array
resp.connection_details.allowed_ips[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String) —

    The ID of the connection.

Returns:

See Also:



977
978
979
980
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 977

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

#get_order(params = {}) ⇒ Types::GetOrderOutput

Gets information about the specified order.

Examples:

Request syntax with placeholder values


resp = client.get_order({
  order_id: "OrderId", # required
})

Response structure


resp.order.outpost_id #=> String
resp.order.order_id #=> String
resp.order.status #=> String, one of "RECEIVED", "PENDING", "PROCESSING", "INSTALLING", "FULFILLED", "CANCELLED", "PREPARING", "IN_PROGRESS", "DELIVERED", "COMPLETED", "ERROR"
resp.order.line_items #=> Array
resp.order.line_items[0].catalog_item_id #=> String
resp.order.line_items[0].line_item_id #=> String
resp.order.line_items[0].quantity #=> Integer
resp.order.line_items[0].status #=> String, one of "PREPARING", "BUILDING", "SHIPPED", "DELIVERED", "INSTALLING", "INSTALLED", "ERROR", "CANCELLED", "REPLACED"
resp.order.line_items[0].shipment_information.shipment_tracking_number #=> String
resp.order.line_items[0].shipment_information.shipment_carrier #=> String, one of "DHL", "DBS", "FEDEX", "UPS", "EXPEDITORS"
resp.order.line_items[0].asset_information_list #=> Array
resp.order.line_items[0].asset_information_list[0].asset_id #=> String
resp.order.line_items[0].asset_information_list[0].mac_address_list #=> Array
resp.order.line_items[0].asset_information_list[0].mac_address_list[0] #=> String
resp.order.line_items[0].previous_line_item_id #=> String
resp.order.line_items[0].previous_order_id #=> String
resp.order.payment_option #=> String, one of "ALL_UPFRONT", "NO_UPFRONT", "PARTIAL_UPFRONT"
resp.order.order_submission_date #=> Time
resp.order.order_fulfilled_date #=> Time
resp.order.payment_term #=> String, one of "THREE_YEARS", "ONE_YEAR", "FIVE_YEARS"
resp.order.order_type #=> String, one of "OUTPOST", "REPLACEMENT"

Parameters:

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

    ({})

Options Hash (params):

  • :order_id (required, String) —

    The ID of the order.

Returns:

See Also:



1025
1026
1027
1028
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1025

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

#get_outpost(params = {}) ⇒ Types::GetOutpostOutput

Gets information about the specified Outpost.

Examples:

Request syntax with placeholder values


resp = client.get_outpost({
  outpost_id: "OutpostId", # required
})

Response structure


resp.outpost.outpost_id #=> String
resp.outpost.owner_id #=> String
resp.outpost.outpost_arn #=> String
resp.outpost.site_id #=> String
resp.outpost.name #=> String
resp.outpost.description #=> String
resp.outpost.life_cycle_status #=> String
resp.outpost.availability_zone #=> String
resp.outpost.availability_zone_id #=> String
resp.outpost.tags #=> Hash
resp.outpost.tags["TagKey"] #=> String
resp.outpost.site_arn #=> String
resp.outpost.supported_hardware_type #=> String, one of "RACK", "SERVER"

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_id (required, String) —

    The ID or ARN of the Outpost.

Returns:

See Also:



1065
1066
1067
1068
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1065

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

#get_outpost_billing_information(params = {}) ⇒ Types::GetOutpostBillingInformationOutput

Gets current and historical billing information about the specified Outpost.

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_outpost_billing_information({
  next_token: "Token",
  max_results: 1,
  outpost_identifier: "OutpostIdentifier", # required
})

Response structure


resp.next_token #=> String
resp.subscriptions #=> Array
resp.subscriptions[0].subscription_id #=> String
resp.subscriptions[0].subscription_type #=> String, one of "ORIGINAL", "RENEWAL", "CAPACITY_INCREASE"
resp.subscriptions[0].subscription_status #=> String, one of "ACTIVE", "INACTIVE", "CANCELLED"
resp.subscriptions[0].order_ids #=> Array
resp.subscriptions[0].order_ids[0] #=> String
resp.subscriptions[0].begin_date #=> Time
resp.subscriptions[0].end_date #=> Time
resp.subscriptions[0].monthly_recurring_price #=> Float
resp.subscriptions[0].upfront_price #=> Float
resp.contract_end_date #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token.

  • :max_results (Integer) —

    The maximum page size.

  • :outpost_identifier (required, String) —

    The ID or ARN of the Outpost.

Returns:

See Also:



1117
1118
1119
1120
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1117

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

#get_outpost_instance_types(params = {}) ⇒ Types::GetOutpostInstanceTypesOutput

Gets the instance types for the specified Outpost.

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_outpost_instance_types({
  outpost_id: "OutpostId", # required
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.instance_types #=> Array
resp.instance_types[0].instance_type #=> String
resp.instance_types[0].vcp_us #=> Integer
resp.next_token #=> String
resp.outpost_id #=> String
resp.outpost_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_id (required, String) —

    The ID or ARN of the Outpost.

  • :next_token (String) —

    The pagination token.

  • :max_results (Integer) —

    The maximum page size.

Returns:

See Also:



1163
1164
1165
1166
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1163

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

#get_outpost_supported_instance_types(params = {}) ⇒ Types::GetOutpostSupportedInstanceTypesOutput

Gets the instance types that an Outpost can support in InstanceTypeCapacity. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.

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_outpost_supported_instance_types({
  outpost_identifier: "OutpostIdentifier", # required
  order_id: "OrderId",
  asset_id: "AssetIdInput",
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.instance_types #=> Array
resp.instance_types[0].instance_type #=> String
resp.instance_types[0].vcp_us #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_identifier (required, String) —

    The ID or ARN of the Outpost.

  • :order_id (String) —

    The ID for the Amazon Web Services Outposts order.

  • :asset_id (String) —

    The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

  • :max_results (Integer) —

    The maximum page size.

  • :next_token (String) —

    The pagination token.

Returns:

See Also:



1217
1218
1219
1220
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1217

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

#get_site(params = {}) ⇒ Types::GetSiteOutput

Gets information about the specified Outpost site.

Examples:

Request syntax with placeholder values


resp = client.get_site({
  site_id: "SiteId", # required
})

Response structure


resp.site.site_id #=> String
resp.site. #=> String
resp.site.name #=> String
resp.site.description #=> String
resp.site.tags #=> Hash
resp.site.tags["TagKey"] #=> String
resp.site.site_arn #=> String
resp.site.notes #=> String
resp.site.operating_address_country_code #=> String
resp.site.operating_address_state_or_region #=> String
resp.site.operating_address_city #=> String
resp.site.rack_physical_properties.power_draw_kva #=> String, one of "POWER_5_KVA", "POWER_10_KVA", "POWER_15_KVA", "POWER_30_KVA"
resp.site.rack_physical_properties.power_phase #=> String, one of "SINGLE_PHASE", "THREE_PHASE"
resp.site.rack_physical_properties.power_connector #=> String, one of "L6_30P", "IEC309", "AH530P7W", "AH532P6W", "CS8365C"
resp.site.rack_physical_properties.power_feed_drop #=> String, one of "ABOVE_RACK", "BELOW_RACK"
resp.site.rack_physical_properties.uplink_gbps #=> String, one of "UPLINK_1G", "UPLINK_10G", "UPLINK_40G", "UPLINK_100G"
resp.site.rack_physical_properties.uplink_count #=> String, one of "UPLINK_COUNT_1", "UPLINK_COUNT_2", "UPLINK_COUNT_3", "UPLINK_COUNT_4", "UPLINK_COUNT_5", "UPLINK_COUNT_6", "UPLINK_COUNT_7", "UPLINK_COUNT_8", "UPLINK_COUNT_12", "UPLINK_COUNT_16"
resp.site.rack_physical_properties.fiber_optic_cable_type #=> String, one of "SINGLE_MODE", "MULTI_MODE"
resp.site.rack_physical_properties.optical_standard #=> String, one of "OPTIC_10GBASE_SR", "OPTIC_10GBASE_IR", "OPTIC_10GBASE_LR", "OPTIC_40GBASE_SR", "OPTIC_40GBASE_ESR", "OPTIC_40GBASE_IR4_LR4L", "OPTIC_40GBASE_LR4", "OPTIC_100GBASE_SR4", "OPTIC_100GBASE_CWDM4", "OPTIC_100GBASE_LR4", "OPTIC_100G_PSM4_MSA", "OPTIC_1000BASE_LX", "OPTIC_1000BASE_SX"
resp.site.rack_physical_properties.maximum_supported_weight_lbs #=> String, one of "NO_LIMIT", "MAX_1400_LBS", "MAX_1600_LBS", "MAX_1800_LBS", "MAX_2000_LBS"

Parameters:

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

    ({})

Options Hash (params):

  • :site_id (required, String) —

    The ID or the Amazon Resource Name (ARN) of the site.

Returns:

See Also:



1264
1265
1266
1267
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1264

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

#get_site_address(params = {}) ⇒ Types::GetSiteAddressOutput

Gets the site address of the specified site.

Examples:

Request syntax with placeholder values


resp = client.get_site_address({
  site_id: "SiteId", # required
  address_type: "SHIPPING_ADDRESS", # required, accepts SHIPPING_ADDRESS, OPERATING_ADDRESS
})

Response structure


resp.site_id #=> String
resp.address_type #=> String, one of "SHIPPING_ADDRESS", "OPERATING_ADDRESS"
resp.address.contact_name #=> String
resp.address.contact_phone_number #=> String
resp.address.address_line_1 #=> String
resp.address.address_line_2 #=> String
resp.address.address_line_3 #=> String
resp.address.city #=> String
resp.address.state_or_region #=> String
resp.address.district_or_county #=> String
resp.address.postal_code #=> String
resp.address.country_code #=> String
resp.address.municipality #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :site_id (required, String) —

    The ID or the Amazon Resource Name (ARN) of the site.

  • :address_type (required, String) —

    The type of the address you request.

Returns:

See Also:



1310
1311
1312
1313
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1310

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

#list_asset_instances(params = {}) ⇒ Types::ListAssetInstancesOutput

A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost. Does not include Amazon EBS or Amazon S3 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.list_asset_instances({
  outpost_identifier: "OutpostIdentifier", # required
  asset_id_filter: ["AssetId"],
  instance_type_filter: ["OutpostInstanceType"],
  account_id_filter: ["AccountId"],
  aws_service_filter: ["AWS"], # accepts AWS, EC2, ELASTICACHE, ELB, RDS, ROUTE53
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.asset_instances #=> Array
resp.asset_instances[0].instance_id #=> String
resp.asset_instances[0].instance_type #=> String
resp.asset_instances[0].asset_id #=> String
resp.asset_instances[0]. #=> String
resp.asset_instances[0].aws_service_name #=> String, one of "AWS", "EC2", "ELASTICACHE", "ELB", "RDS", "ROUTE53"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_identifier (required, String) —

    The ID of the Outpost.

  • :asset_id_filter (Array<String>) —

    Filters the results by asset ID.

  • :instance_type_filter (Array<String>) —

    Filters the results by instance ID.

  • :account_id_filter (Array<String>) —

    Filters the results by account ID.

  • :aws_service_filter (Array<String>) —

    Filters the results by Amazon Web Services service.

  • :max_results (Integer) —

    The maximum page size.

  • :next_token (String) —

    The pagination token.

Returns:

See Also:



1373
1374
1375
1376
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1373

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

#list_assets(params = {}) ⇒ Types::ListAssetsOutput

Lists the hardware assets for the specified Outpost.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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_assets({
  outpost_identifier: "OutpostIdentifier", # required
  host_id_filter: ["HostId"],
  max_results: 1,
  next_token: "Token",
  status_filter: ["ACTIVE"], # accepts ACTIVE, RETIRING, ISOLATED
})

Response structure


resp.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].rack_id #=> String
resp.assets[0].asset_type #=> String, one of "COMPUTE"
resp.assets[0].compute_attributes.host_id #=> String
resp.assets[0].compute_attributes.state #=> String, one of "ACTIVE", "ISOLATED", "RETIRING"
resp.assets[0].compute_attributes.instance_families #=> Array
resp.assets[0].compute_attributes.instance_families[0] #=> String
resp.assets[0].compute_attributes.instance_type_capacities #=> Array
resp.assets[0].compute_attributes.instance_type_capacities[0].instance_type #=> String
resp.assets[0].compute_attributes.instance_type_capacities[0].count #=> Integer
resp.assets[0].compute_attributes.max_vcpus #=> Integer
resp.assets[0].asset_location.rack_elevation #=> Float
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_identifier (required, String) —

    The ID or the Amazon Resource Name (ARN) of the Outpost.

  • :host_id_filter (Array<String>) —

    Filters the results by the host ID of a Dedicated Host.

  • :max_results (Integer) —

    The maximum page size.

  • :next_token (String) —

    The pagination token.

  • :status_filter (Array<String>) —

    Filters the results by state.

Returns:

See Also:



1439
1440
1441
1442
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1439

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

#list_blocking_instances_for_capacity_task(params = {}) ⇒ Types::ListBlockingInstancesForCapacityTaskOutput

A list of Amazon EC2 instances running on the Outpost and belonging to the account that initiated the capacity task. Use this list to specify the instances you cannot stop to free up capacity to run the capacity task.

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_blocking_instances_for_capacity_task({
  outpost_identifier: "OutpostIdentifier", # required
  capacity_task_id: "CapacityTaskId", # required
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.blocking_instances #=> Array
resp.blocking_instances[0].instance_id #=> String
resp.blocking_instances[0]. #=> String
resp.blocking_instances[0].aws_service_name #=> String, one of "AWS", "EC2", "ELASTICACHE", "ELB", "RDS", "ROUTE53"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_identifier (required, String) —

    The ID or ARN of the Outpost associated with the specified capacity task.

  • :capacity_task_id (required, String) —

    The ID of the capacity task.

  • :max_results (Integer) —

    The maximum page size.

  • :next_token (String) —

    The pagination token.

Returns:

See Also:



1490
1491
1492
1493
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1490

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

#list_capacity_tasks(params = {}) ⇒ Types::ListCapacityTasksOutput

Lists the capacity tasks for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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_capacity_tasks({
  outpost_identifier_filter: "OutpostIdentifier",
  max_results: 1,
  next_token: "Token",
  capacity_task_status_filter: ["REQUESTED"], # accepts REQUESTED, IN_PROGRESS, FAILED, COMPLETED, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, CANCELLED
})

Response structure


resp.capacity_tasks #=> Array
resp.capacity_tasks[0].capacity_task_id #=> String
resp.capacity_tasks[0].outpost_id #=> String
resp.capacity_tasks[0].order_id #=> String
resp.capacity_tasks[0].asset_id #=> String
resp.capacity_tasks[0].capacity_task_status #=> String, one of "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "WAITING_FOR_EVACUATION", "CANCELLATION_IN_PROGRESS", "CANCELLED"
resp.capacity_tasks[0].creation_date #=> Time
resp.capacity_tasks[0].completion_date #=> Time
resp.capacity_tasks[0].last_modified_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_identifier_filter (String) —

    Filters the results by an Outpost ID or an Outpost ARN.

  • :max_results (Integer) —

    The maximum page size.

  • :next_token (String) —

    The pagination token.

  • :capacity_task_status_filter (Array<String>) —

    A list of statuses. For example, REQUESTED or WAITING_FOR_EVACUATION.

Returns:

See Also:



1549
1550
1551
1552
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1549

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

#list_catalog_items(params = {}) ⇒ Types::ListCatalogItemsOutput

Lists the items in the catalog.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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_catalog_items({
  next_token: "Token",
  max_results: 1,
  item_class_filter: ["RACK"], # accepts RACK, SERVER
  supported_storage_filter: ["EBS"], # accepts EBS, S3
  ec2_family_filter: ["Family"],
})

Response structure


resp.catalog_items #=> Array
resp.catalog_items[0].catalog_item_id #=> String
resp.catalog_items[0].item_status #=> String, one of "AVAILABLE", "DISCONTINUED"
resp.catalog_items[0].ec2_capacities #=> Array
resp.catalog_items[0].ec2_capacities[0].family #=> String
resp.catalog_items[0].ec2_capacities[0].max_size #=> String
resp.catalog_items[0].ec2_capacities[0].quantity #=> String
resp.catalog_items[0].power_kva #=> Float
resp.catalog_items[0].weight_lbs #=> Integer
resp.catalog_items[0].supported_uplink_gbps #=> Array
resp.catalog_items[0].supported_uplink_gbps[0] #=> Integer
resp.catalog_items[0].supported_storage #=> Array
resp.catalog_items[0].supported_storage[0] #=> String, one of "EBS", "S3"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token.

  • :max_results (Integer) —

    The maximum page size.

  • :item_class_filter (Array<String>) —

    Filters the results by item class.

  • :supported_storage_filter (Array<String>) —

    Filters the results by storage option.

  • :ec2_family_filter (Array<String>) —

    Filters the results by EC2 family (for example, M5).

Returns:

See Also:



1615
1616
1617
1618
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1615

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

#list_orders(params = {}) ⇒ Types::ListOrdersOutput

Lists the Outpost orders for your Amazon Web Services 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.list_orders({
  outpost_identifier_filter: "OutpostIdentifier",
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.orders #=> Array
resp.orders[0].outpost_id #=> String
resp.orders[0].order_id #=> String
resp.orders[0].order_type #=> String, one of "OUTPOST", "REPLACEMENT"
resp.orders[0].status #=> String, one of "RECEIVED", "PENDING", "PROCESSING", "INSTALLING", "FULFILLED", "CANCELLED", "PREPARING", "IN_PROGRESS", "DELIVERED", "COMPLETED", "ERROR"
resp.orders[0].line_item_counts_by_status #=> Hash
resp.orders[0].line_item_counts_by_status["LineItemStatus"] #=> Integer
resp.orders[0].order_submission_date #=> Time
resp.orders[0].order_fulfilled_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_identifier_filter (String) —

    The ID or the Amazon Resource Name (ARN) of the Outpost.

  • :next_token (String) —

    The pagination token.

  • :max_results (Integer) —

    The maximum page size.

Returns:

See Also:



1663
1664
1665
1666
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1663

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

#list_outposts(params = {}) ⇒ Types::ListOutpostsOutput

Lists the Outposts for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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_outposts({
  next_token: "Token",
  max_results: 1,
  life_cycle_status_filter: ["LifeCycleStatus"],
  availability_zone_filter: ["AvailabilityZone"],
  availability_zone_id_filter: ["AvailabilityZoneId"],
})

Response structure


resp.outposts #=> Array
resp.outposts[0].outpost_id #=> String
resp.outposts[0].owner_id #=> String
resp.outposts[0].outpost_arn #=> String
resp.outposts[0].site_id #=> String
resp.outposts[0].name #=> String
resp.outposts[0].description #=> String
resp.outposts[0].life_cycle_status #=> String
resp.outposts[0].availability_zone #=> String
resp.outposts[0].availability_zone_id #=> String
resp.outposts[0].tags #=> Hash
resp.outposts[0].tags["TagKey"] #=> String
resp.outposts[0].site_arn #=> String
resp.outposts[0].supported_hardware_type #=> String, one of "RACK", "SERVER"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token.

  • :max_results (Integer) —

    The maximum page size.

  • :life_cycle_status_filter (Array<String>) —

    Filters the results by the lifecycle status.

  • :availability_zone_filter (Array<String>) —

    Filters the results by Availability Zone (for example, us-east-1a).

  • :availability_zone_id_filter (Array<String>) —

    Filters the results by AZ ID (for example, use1-az1).

Returns:

See Also:



1730
1731
1732
1733
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1730

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

#list_sites(params = {}) ⇒ Types::ListSitesOutput

Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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_sites({
  next_token: "Token",
  max_results: 1,
  operating_address_country_code_filter: ["CountryCode"],
  operating_address_state_or_region_filter: ["StateOrRegion"],
  operating_address_city_filter: ["City"],
})

Response structure


resp.sites #=> Array
resp.sites[0].site_id #=> String
resp.sites[0]. #=> String
resp.sites[0].name #=> String
resp.sites[0].description #=> String
resp.sites[0].tags #=> Hash
resp.sites[0].tags["TagKey"] #=> String
resp.sites[0].site_arn #=> String
resp.sites[0].notes #=> String
resp.sites[0].operating_address_country_code #=> String
resp.sites[0].operating_address_state_or_region #=> String
resp.sites[0].operating_address_city #=> String
resp.sites[0].rack_physical_properties.power_draw_kva #=> String, one of "POWER_5_KVA", "POWER_10_KVA", "POWER_15_KVA", "POWER_30_KVA"
resp.sites[0].rack_physical_properties.power_phase #=> String, one of "SINGLE_PHASE", "THREE_PHASE"
resp.sites[0].rack_physical_properties.power_connector #=> String, one of "L6_30P", "IEC309", "AH530P7W", "AH532P6W", "CS8365C"
resp.sites[0].rack_physical_properties.power_feed_drop #=> String, one of "ABOVE_RACK", "BELOW_RACK"
resp.sites[0].rack_physical_properties.uplink_gbps #=> String, one of "UPLINK_1G", "UPLINK_10G", "UPLINK_40G", "UPLINK_100G"
resp.sites[0].rack_physical_properties.uplink_count #=> String, one of "UPLINK_COUNT_1", "UPLINK_COUNT_2", "UPLINK_COUNT_3", "UPLINK_COUNT_4", "UPLINK_COUNT_5", "UPLINK_COUNT_6", "UPLINK_COUNT_7", "UPLINK_COUNT_8", "UPLINK_COUNT_12", "UPLINK_COUNT_16"
resp.sites[0].rack_physical_properties.fiber_optic_cable_type #=> String, one of "SINGLE_MODE", "MULTI_MODE"
resp.sites[0].rack_physical_properties.optical_standard #=> String, one of "OPTIC_10GBASE_SR", "OPTIC_10GBASE_IR", "OPTIC_10GBASE_LR", "OPTIC_40GBASE_SR", "OPTIC_40GBASE_ESR", "OPTIC_40GBASE_IR4_LR4L", "OPTIC_40GBASE_LR4", "OPTIC_100GBASE_SR4", "OPTIC_100GBASE_CWDM4", "OPTIC_100GBASE_LR4", "OPTIC_100G_PSM4_MSA", "OPTIC_1000BASE_LX", "OPTIC_1000BASE_SX"
resp.sites[0].rack_physical_properties.maximum_supported_weight_lbs #=> String, one of "NO_LIMIT", "MAX_1400_LBS", "MAX_1600_LBS", "MAX_1800_LBS", "MAX_2000_LBS"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token.

  • :max_results (Integer) —

    The maximum page size.

  • :operating_address_country_code_filter (Array<String>) —

    Filters the results by country code.

  • :operating_address_state_or_region_filter (Array<String>) —

    Filters the results by state or region.

  • :operating_address_city_filter (Array<String>) —

    Filters the results by city.

Returns:

See Also:



1805
1806
1807
1808
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1805

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1834
1835
1836
1837
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1834

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

#start_capacity_task(params = {}) ⇒ Types::StartCapacityTaskOutput

Starts the specified capacity task. You can have one active capacity task for each order and each Outpost.

Examples:

Request syntax with placeholder values


resp = client.start_capacity_task({
  outpost_identifier: "OutpostIdentifier", # required
  order_id: "OrderId",
  asset_id: "AssetIdInput",
  instance_pools: [ # required
    {
      instance_type: "InstanceTypeName", # required
      count: 1, # required
    },
  ],
  instances_to_exclude: {
    instances: ["InstanceId"],
    account_ids: ["AccountId"],
    services: ["AWS"], # accepts AWS, EC2, ELASTICACHE, ELB, RDS, ROUTE53
  },
  dry_run: false,
  task_action_on_blocking_instances: "WAIT_FOR_EVACUATION", # accepts WAIT_FOR_EVACUATION, FAIL_TASK
})

Response structure


resp.capacity_task_id #=> String
resp.outpost_id #=> String
resp.order_id #=> String
resp.asset_id #=> String
resp.requested_instance_pools #=> Array
resp.requested_instance_pools[0].instance_type #=> String
resp.requested_instance_pools[0].count #=> Integer
resp.instances_to_exclude.instances #=> Array
resp.instances_to_exclude.instances[0] #=> String
resp.instances_to_exclude. #=> Array
resp.instances_to_exclude.[0] #=> String
resp.instances_to_exclude.services #=> Array
resp.instances_to_exclude.services[0] #=> String, one of "AWS", "EC2", "ELASTICACHE", "ELB", "RDS", "ROUTE53"
resp.dry_run #=> Boolean
resp.capacity_task_status #=> String, one of "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "WAITING_FOR_EVACUATION", "CANCELLATION_IN_PROGRESS", "CANCELLED"
resp.failed.reason #=> String
resp.failed.type #=> String, one of "UNSUPPORTED_CAPACITY_CONFIGURATION", "UNEXPECTED_ASSET_STATE", "BLOCKING_INSTANCES_NOT_EVACUATED", "INTERNAL_SERVER_ERROR", "RESOURCE_NOT_FOUND"
resp.creation_date #=> Time
resp.completion_date #=> Time
resp.last_modified_date #=> Time
resp.task_action_on_blocking_instances #=> String, one of "WAIT_FOR_EVACUATION", "FAIL_TASK"

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_identifier (required, String) —

    The ID or ARN of the Outposts associated with the specified capacity task.

  • :order_id (String) —

    The ID of the Amazon Web Services Outposts order associated with the specified capacity task.

  • :asset_id (String) —

    The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

  • :instance_pools (required, Array<Types::InstanceTypeCapacity>) —

    The instance pools specified in the capacity task.

  • :instances_to_exclude (Types::InstancesToExclude) —

    List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.

  • :dry_run (Boolean) —

    You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.

  • :task_action_on_blocking_instances (String) —

    Specify one of the following options in case an instance is blocking the capacity task from running.

    • WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

    • FAIL_TASK - The capacity task fails.

Returns:

See Also:



1941
1942
1943
1944
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1941

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

#start_connection(params = {}) ⇒ Types::StartConnectionResponse

Amazon Web Services uses this action to install Outpost servers.

Starts the connection required for Outpost server installation.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

Examples:

Request syntax with placeholder values


resp = client.start_connection({
  device_serial_number: "DeviceSerialNumber",
  asset_id: "AssetId", # required
  client_public_key: "WireGuardPublicKey", # required
  network_interface_device_index: 1, # required
})

Response structure


resp.connection_id #=> String
resp.underlay_ip_address #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :device_serial_number (String) —

    The serial number of the dongle.

  • :asset_id (required, String) —

    The ID of the Outpost server.

  • :client_public_key (required, String) —

    The public key of the client.

  • :network_interface_device_index (required, Integer) —

    The device index of the network interface on the Outpost server.

Returns:

See Also:



1999
2000
2001
2002
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1999

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

    The tags to add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2027
2028
2029
2030
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 2027

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

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

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2053
2054
2055
2056
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 2053

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

#update_outpost(params = {}) ⇒ Types::UpdateOutpostOutput

Updates an Outpost.

Examples:

Request syntax with placeholder values


resp = client.update_outpost({
  outpost_id: "OutpostId", # required
  name: "OutpostName",
  description: "OutpostDescription",
  supported_hardware_type: "RACK", # accepts RACK, SERVER
})

Response structure


resp.outpost.outpost_id #=> String
resp.outpost.owner_id #=> String
resp.outpost.outpost_arn #=> String
resp.outpost.site_id #=> String
resp.outpost.name #=> String
resp.outpost.description #=> String
resp.outpost.life_cycle_status #=> String
resp.outpost.availability_zone #=> String
resp.outpost.availability_zone_id #=> String
resp.outpost.tags #=> Hash
resp.outpost.tags["TagKey"] #=> String
resp.outpost.site_arn #=> String
resp.outpost.supported_hardware_type #=> String, one of "RACK", "SERVER"

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_id (required, String) —

    The ID or ARN of the Outpost.

  • :name (String) —

    The name of the Outpost.

  • :description (String) —

    The description of the Outpost.

  • :supported_hardware_type (String) —

    The type of hardware for this Outpost.

Returns:

See Also:



2105
2106
2107
2108
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 2105

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

#update_site(params = {}) ⇒ Types::UpdateSiteOutput

Updates the specified site.

Examples:

Request syntax with placeholder values


resp = client.update_site({
  site_id: "SiteId", # required
  name: "SiteName",
  description: "SiteDescription",
  notes: "SiteNotes",
})

Response structure


resp.site.site_id #=> String
resp.site. #=> String
resp.site.name #=> String
resp.site.description #=> String
resp.site.tags #=> Hash
resp.site.tags["TagKey"] #=> String
resp.site.site_arn #=> String
resp.site.notes #=> String
resp.site.operating_address_country_code #=> String
resp.site.operating_address_state_or_region #=> String
resp.site.operating_address_city #=> String
resp.site.rack_physical_properties.power_draw_kva #=> String, one of "POWER_5_KVA", "POWER_10_KVA", "POWER_15_KVA", "POWER_30_KVA"
resp.site.rack_physical_properties.power_phase #=> String, one of "SINGLE_PHASE", "THREE_PHASE"
resp.site.rack_physical_properties.power_connector #=> String, one of "L6_30P", "IEC309", "AH530P7W", "AH532P6W", "CS8365C"
resp.site.rack_physical_properties.power_feed_drop #=> String, one of "ABOVE_RACK", "BELOW_RACK"
resp.site.rack_physical_properties.uplink_gbps #=> String, one of "UPLINK_1G", "UPLINK_10G", "UPLINK_40G", "UPLINK_100G"
resp.site.rack_physical_properties.uplink_count #=> String, one of "UPLINK_COUNT_1", "UPLINK_COUNT_2", "UPLINK_COUNT_3", "UPLINK_COUNT_4", "UPLINK_COUNT_5", "UPLINK_COUNT_6", "UPLINK_COUNT_7", "UPLINK_COUNT_8", "UPLINK_COUNT_12", "UPLINK_COUNT_16"
resp.site.rack_physical_properties.fiber_optic_cable_type #=> String, one of "SINGLE_MODE", "MULTI_MODE"
resp.site.rack_physical_properties.optical_standard #=> String, one of "OPTIC_10GBASE_SR", "OPTIC_10GBASE_IR", "OPTIC_10GBASE_LR", "OPTIC_40GBASE_SR", "OPTIC_40GBASE_ESR", "OPTIC_40GBASE_IR4_LR4L", "OPTIC_40GBASE_LR4", "OPTIC_100GBASE_SR4", "OPTIC_100GBASE_CWDM4", "OPTIC_100GBASE_LR4", "OPTIC_100G_PSM4_MSA", "OPTIC_1000BASE_LX", "OPTIC_1000BASE_SX"
resp.site.rack_physical_properties.maximum_supported_weight_lbs #=> String, one of "NO_LIMIT", "MAX_1400_LBS", "MAX_1600_LBS", "MAX_1800_LBS", "MAX_2000_LBS"

Parameters:

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

    ({})

Options Hash (params):

  • :site_id (required, String) —

    The ID or the Amazon Resource Name (ARN) of the site.

  • :name (String) —

    The name of the site.

  • :description (String) —

    The description of the site.

  • :notes (String) —

    Notes about a site.

Returns:

See Also:



2164
2165
2166
2167
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 2164

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

#update_site_address(params = {}) ⇒ Types::UpdateSiteAddressOutput

Updates the address of the specified site.

You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order.

You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.

Examples:

Request syntax with placeholder values


resp = client.update_site_address({
  site_id: "SiteId", # required
  address_type: "SHIPPING_ADDRESS", # required, accepts SHIPPING_ADDRESS, OPERATING_ADDRESS
  address: { # required
    contact_name: "ContactName", # required
    contact_phone_number: "ContactPhoneNumber", # required
    address_line_1: "AddressLine1", # required
    address_line_2: "AddressLine2",
    address_line_3: "AddressLine3",
    city: "City", # required
    state_or_region: "StateOrRegion", # required
    district_or_county: "DistrictOrCounty",
    postal_code: "PostalCode", # required
    country_code: "CountryCode", # required
    municipality: "Municipality",
  },
})

Response structure


resp.address_type #=> String, one of "SHIPPING_ADDRESS", "OPERATING_ADDRESS"
resp.address.contact_name #=> String
resp.address.contact_phone_number #=> String
resp.address.address_line_1 #=> String
resp.address.address_line_2 #=> String
resp.address.address_line_3 #=> String
resp.address.city #=> String
resp.address.state_or_region #=> String
resp.address.district_or_county #=> String
resp.address.postal_code #=> String
resp.address.country_code #=> String
resp.address.municipality #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :site_id (required, String) —

    The ID or the Amazon Resource Name (ARN) of the site.

  • :address_type (required, String) —

    The type of the address.

  • :address (required, Types::Address) —

    The address for the site.

Returns:

See Also:



2231
2232
2233
2234
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 2231

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

#update_site_rack_physical_properties(params = {}) ⇒ Types::UpdateSiteRackPhysicalPropertiesOutput

Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.

Examples:

Request syntax with placeholder values


resp = client.update_site_rack_physical_properties({
  site_id: "SiteId", # required
  power_draw_kva: "POWER_5_KVA", # accepts POWER_5_KVA, POWER_10_KVA, POWER_15_KVA, POWER_30_KVA
  power_phase: "SINGLE_PHASE", # accepts SINGLE_PHASE, THREE_PHASE
  power_connector: "L6_30P", # accepts L6_30P, IEC309, AH530P7W, AH532P6W, CS8365C
  power_feed_drop: "ABOVE_RACK", # accepts ABOVE_RACK, BELOW_RACK
  uplink_gbps: "UPLINK_1G", # accepts UPLINK_1G, UPLINK_10G, UPLINK_40G, UPLINK_100G
  uplink_count: "UPLINK_COUNT_1", # accepts UPLINK_COUNT_1, UPLINK_COUNT_2, UPLINK_COUNT_3, UPLINK_COUNT_4, UPLINK_COUNT_5, UPLINK_COUNT_6, UPLINK_COUNT_7, UPLINK_COUNT_8, UPLINK_COUNT_12, UPLINK_COUNT_16
  fiber_optic_cable_type: "SINGLE_MODE", # accepts SINGLE_MODE, MULTI_MODE
  optical_standard: "OPTIC_10GBASE_SR", # accepts OPTIC_10GBASE_SR, OPTIC_10GBASE_IR, OPTIC_10GBASE_LR, OPTIC_40GBASE_SR, OPTIC_40GBASE_ESR, OPTIC_40GBASE_IR4_LR4L, OPTIC_40GBASE_LR4, OPTIC_100GBASE_SR4, OPTIC_100GBASE_CWDM4, OPTIC_100GBASE_LR4, OPTIC_100G_PSM4_MSA, OPTIC_1000BASE_LX, OPTIC_1000BASE_SX
  maximum_supported_weight_lbs: "NO_LIMIT", # accepts NO_LIMIT, MAX_1400_LBS, MAX_1600_LBS, MAX_1800_LBS, MAX_2000_LBS
})

Response structure


resp.site.site_id #=> String
resp.site. #=> String
resp.site.name #=> String
resp.site.description #=> String
resp.site.tags #=> Hash
resp.site.tags["TagKey"] #=> String
resp.site.site_arn #=> String
resp.site.notes #=> String
resp.site.operating_address_country_code #=> String
resp.site.operating_address_state_or_region #=> String
resp.site.operating_address_city #=> String
resp.site.rack_physical_properties.power_draw_kva #=> String, one of "POWER_5_KVA", "POWER_10_KVA", "POWER_15_KVA", "POWER_30_KVA"
resp.site.rack_physical_properties.power_phase #=> String, one of "SINGLE_PHASE", "THREE_PHASE"
resp.site.rack_physical_properties.power_connector #=> String, one of "L6_30P", "IEC309", "AH530P7W", "AH532P6W", "CS8365C"
resp.site.rack_physical_properties.power_feed_drop #=> String, one of "ABOVE_RACK", "BELOW_RACK"
resp.site.rack_physical_properties.uplink_gbps #=> String, one of "UPLINK_1G", "UPLINK_10G", "UPLINK_40G", "UPLINK_100G"
resp.site.rack_physical_properties.uplink_count #=> String, one of "UPLINK_COUNT_1", "UPLINK_COUNT_2", "UPLINK_COUNT_3", "UPLINK_COUNT_4", "UPLINK_COUNT_5", "UPLINK_COUNT_6", "UPLINK_COUNT_7", "UPLINK_COUNT_8", "UPLINK_COUNT_12", "UPLINK_COUNT_16"
resp.site.rack_physical_properties.fiber_optic_cable_type #=> String, one of "SINGLE_MODE", "MULTI_MODE"
resp.site.rack_physical_properties.optical_standard #=> String, one of "OPTIC_10GBASE_SR", "OPTIC_10GBASE_IR", "OPTIC_10GBASE_LR", "OPTIC_40GBASE_SR", "OPTIC_40GBASE_ESR", "OPTIC_40GBASE_IR4_LR4L", "OPTIC_40GBASE_LR4", "OPTIC_100GBASE_SR4", "OPTIC_100GBASE_CWDM4", "OPTIC_100GBASE_LR4", "OPTIC_100G_PSM4_MSA", "OPTIC_1000BASE_LX", "OPTIC_1000BASE_SX"
resp.site.rack_physical_properties.maximum_supported_weight_lbs #=> String, one of "NO_LIMIT", "MAX_1400_LBS", "MAX_1600_LBS", "MAX_1800_LBS", "MAX_2000_LBS"

Parameters:

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

    ({})

Options Hash (params):

  • :site_id (required, String) —

    The ID or the Amazon Resource Name (ARN) of the site.

  • :power_draw_kva (String) —

    The power draw, in kVA, available at the hardware placement position for the rack.

  • :power_phase (String) —

    The power option that you can provide for hardware.

    • Single-phase AC feed: 200 V to 277 V, 50 Hz or 60 Hz

    • Three-phase AC feed: 346 V to 480 V, 50 Hz or 60 Hz

  • :power_connector (String) —

    The power connector that Amazon Web Services should plan to provide for connections to the hardware. Note the correlation between PowerPhase and PowerConnector.

    • Single-phase AC feed

      • L6-30P – (common in US); 30A; single phase

      • IEC309 (blue) – P+N+E, 6hr; 32 A; single phase

    • Three-phase AC feed

      • AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase

      • AH532P6W (red) – 3P+N+E, 6hr; 32A; three phase

      • CS8365C – (common in US); 3P+E, 50A; three phase

  • :power_feed_drop (String) —

    Indicates whether the power feed comes above or below the rack.

  • :uplink_gbps (String) —

    The uplink speed the rack should support for the connection to the Region.

  • :uplink_count (String) —

    Racks come with two Outpost network devices. Depending on the supported uplink speed at the site, the Outpost network devices provide a variable number of uplinks. Specify the number of uplinks for each Outpost network device that you intend to use to connect the rack to your network. Note the correlation between UplinkGbps and UplinkCount.

    • 1Gbps - Uplinks available: 1, 2, 4, 6, 8

    • 10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16

    • 40 and 100 Gbps- Uplinks available: 1, 2, 4

  • :fiber_optic_cable_type (String) —

    The type of fiber that you will use to attach the Outpost to your network.

  • :optical_standard (String) —

    The type of optical standard that you will use to attach the Outpost to your network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.

    • OPTIC_10GBASE_SR: 10GBASE-SR

    • OPTIC_10GBASE_IR: 10GBASE-IR

    • OPTIC_10GBASE_LR: 10GBASE-LR

    • OPTIC_40GBASE_SR: 40GBASE-SR

    • OPTIC_40GBASE_ESR: 40GBASE-ESR

    • OPTIC_40GBASE_IR4_LR4L: 40GBASE-IR (LR4L)

    • OPTIC_40GBASE_LR4: 40GBASE-LR4

    • OPTIC_100GBASE_SR4: 100GBASE-SR4

    • OPTIC_100GBASE_CWDM4: 100GBASE-CWDM4

    • OPTIC_100GBASE_LR4: 100GBASE-LR4

    • OPTIC_100G_PSM4_MSA: 100G PSM4 MSA

    • OPTIC_1000BASE_LX: 1000Base-LX

    • OPTIC_1000BASE_SX : 1000Base-SX

  • :maximum_supported_weight_lbs (String) —

    The maximum rack weight that this site can support. NO_LIMIT is over 2000lbs.

Returns:

See Also:



2392
2393
2394
2395
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 2392

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