Class: Aws::Outposts::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/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):

  • :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`, and `:session_token` options.

    • ENV, 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::InstanceProfileCredentails` 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)
  • :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.

  • :endpoint (String) —

    The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

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

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

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

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

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

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

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`.

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

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



346
347
348
 
# File 'lib/aws-sdk-outposts/client.rb', line 346

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. 



1624
1625
1626
 
# File 'lib/aws-sdk-outposts/client.rb', line 1624

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. 



1627
1628
1629
 
# File 'lib/aws-sdk-outposts/client.rb', line 1627

def errors_module
  Errors
end

Instance Method Details

#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: {}) 


1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'lib/aws-sdk-outposts/client.rb', line 1602

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-outposts'
  context[:gem_version] = '1.28.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_order(params = {}) ⇒ Struct

Cancels an 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 to cancel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



369
370
371
372
 
# File 'lib/aws-sdk-outposts/client.rb', line 369

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

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", "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"
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

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 for the order.

  • :payment_term (String) —

    The payment terms for the order.

Returns:

See Also:



424
425
426
427
 
# File 'lib/aws-sdk-outposts/client.rb', line 424

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 `AvailabilityZone` or `AvailabilityZoneId`.

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:



492
493
494
495
 
# File 'lib/aws-sdk-outposts/client.rb', line 492

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",
    contact_phone_number: "ContactPhoneNumber",
    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",
    contact_phone_number: "ContactPhoneNumber",
    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_phase: "SINGLE_PHASE", # accepts SINGLE_PHASE, THREE_PHASE
    power_connector: "L6_30P", # accepts L6_30P, IEC309, AH530P7W, AH532P6W
    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"
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"
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.

    [1]: docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist

Returns:

See Also:



611
612
613
614
 
# File 'lib/aws-sdk-outposts/client.rb', line 611

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

#delete_outpost(params = {}) ⇒ Struct

Deletes the 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 the Amazon Resource Name (ARN) of the Outpost.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



633
634
635
636
 
# File 'lib/aws-sdk-outposts/client.rb', line 633

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

#delete_site(params = {}) ⇒ Struct

Deletes the 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:



655
656
657
658
 
# File 'lib/aws-sdk-outposts/client.rb', line 655

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

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

Gets information about a 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:



694
695
696
697
 
# File 'lib/aws-sdk-outposts/client.rb', line 694

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

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

Gets an 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", "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"
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

Parameters:

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

    ({})

Options Hash (params):

  • :order_id (required, String) —

    The ID of the order.

Returns:

See Also:



732
733
734
735
 
# File 'lib/aws-sdk-outposts/client.rb', line 732

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 the Amazon Resource Name (ARN) of the Outpost.

Returns:

See Also:



772
773
774
775
 
# File 'lib/aws-sdk-outposts/client.rb', line 772

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

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

Lists the instance types for the specified Outpost.

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.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 the Amazon Resource Name (ARN) of the Outpost.

  • :next_token (String) —

    The pagination token.

  • :max_results (Integer) —

    The maximum page size.

Returns:

See Also:



815
816
817
818
 
# File 'lib/aws-sdk-outposts/client.rb', line 815

def get_outpost_instance_types(params = {}, options = {})
  req = build_request(:get_outpost_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"
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"
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:



862
863
864
865
 
# File 'lib/aws-sdk-outposts/client.rb', line 862

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.

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:



908
909
910
911
 
# File 'lib/aws-sdk-outposts/client.rb', line 908

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

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

Use to create a list of every item in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.

If you specify multiple filters, the filters are joined with an `AND`, and the request returns only results that match all of the specified filters.

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

    A filter for the class of items in the catalog.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an `OR`, and the request returns all results that match any of the specified values.

  • :supported_storage_filter (Array<String>) —

    A filter for the storage options of items in the catalog.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an `OR`, and the request returns all results that match any of the specified values.

  • :ec2_family_filter (Array<String>) —

    A filter for EC2 family options for items in the catalog.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an `OR`, and the request returns all results that match any of the specified values.

Returns:

See Also:



986
987
988
989
 
# File 'lib/aws-sdk-outposts/client.rb', line 986

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

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

Create a list of the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to return a more specific list of 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.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", "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:



1036
1037
1038
1039
 
# File 'lib/aws-sdk-outposts/client.rb', line 1036

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

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

Create a list of the Outposts for your Amazon Web Services account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone (`us-east-1a`), and AZ ID (`use1-az1`).

If you specify multiple filters, the filters are joined with an `AND`, and the request returns only results that match all of the specified filters.

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

    A filter for the lifecycle status of the Outpost.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an `OR`, and the request returns all results that match any of the specified values.

  • :availability_zone_filter (Array<String>) —

    A filter for the Availability Zone (`us-east-1a`) of the Outpost.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an `OR`, and the request returns all results that match any of the specified values.

  • :availability_zone_id_filter (Array<String>) —

    A filter for the AZ IDs (`use1-az1`) of the Outpost.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an `OR`, and the request returns all results that match any of the specified values.

Returns:

See Also:



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

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

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

Lists the sites 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_sites({
  next_token: "Token",
  max_results: 1,
})

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

Returns:

See Also:



1172
1173
1174
1175
 
# File 'lib/aws-sdk-outposts/client.rb', line 1172

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:



1201
1202
1203
1204
 
# File 'lib/aws-sdk-outposts/client.rb', line 1201

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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:



1229
1230
1231
1232
 
# File 'lib/aws-sdk-outposts/client.rb', line 1229

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:



1255
1256
1257
1258
 
# File 'lib/aws-sdk-outposts/client.rb', line 1255

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 the Amazon Resource Name (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:



1307
1308
1309
1310
 
# File 'lib/aws-sdk-outposts/client.rb', line 1307

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

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

Updates the 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"
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"
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:



1366
1367
1368
1369
 
# File 'lib/aws-sdk-outposts/client.rb', line 1366

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

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

Updates the site address.

To update a site address with 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",
    contact_phone_number: "ContactPhoneNumber",
    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:



1433
1434
1435
1436
 
# File 'lib/aws-sdk-outposts/client.rb', line 1433

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.

[1]: docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist

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_phase: "SINGLE_PHASE", # accepts SINGLE_PHASE, THREE_PHASE
  power_connector: "L6_30P", # accepts L6_30P, IEC309, AH530P7W, AH532P6W
  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"
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"
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) —

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

  • :power_phase (String) —

    Specify 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) —

    Specify 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

  • :power_feed_drop (String) —

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

  • :uplink_gbps (String) —

    Specify 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) —

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

  • :optical_standard (String) —

    Specify 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

    [1]: docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking

  • :maximum_supported_weight_lbs (String) —

    Specify the maximum rack weight that this site can support. `NO_LIMIT` is over 2000lbs.

Returns:

See Also:



1593
1594
1595
1596
 
# File 'lib/aws-sdk-outposts/client.rb', line 1593

def update_site_rack_physical_properties(params = {}, options = {})
  req = build_request(:update_site_rack_physical_properties, params)
  req.send_request(options)
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. 


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

def waiter_names
  []
end