aws-sdk-outposts 1.54.0 → 1.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0124dcd80ab472b63b6eae8c5cf9af9b337d25001bd4dc4eff895eaaa919c30e
-  data.tar.gz: 2c6c46e8452180b234adfb3d2b1887a1aeef44902f3ba134fe7b0b31199fe8da
+  metadata.gz: cf4142a94cf8ba419a9445d1788bb27d51fb0d4c302ee00a84bb94a323b0cacc
+  data.tar.gz: 27a67fecab387aba2b0370a991954581e68c5ff0604ada13a903f4f06505fcbe
 SHA512:
-  metadata.gz: a4cf0ac976709d82a5842b96e12565b278e79c6baf14454f295cdceafad7375da21bf2f35fd265c1eadf988f200ac9754d9f42fb6752b25b4ffbbfea5b632f67
-  data.tar.gz: 021b6b2af74ada7d203c709b2f634d43e75bb5c03b6f798ac481f52b751dc1c37657fad7e567cbaef53c4cb6e350953311599076600f35e37ed65551a9d6caf0
+  metadata.gz: eda077cb087ddbb7c157ac2b16e65777e74c673401379064a23a9fd6258fbb1e1e70f6460634172c49f62f63749436ad1bfb50b963ac407e02c2e1c191e9ef6d
+  data.tar.gz: 170aaed1ab5b8e81ec535fe9730841a8781c631854511e1e3286264b212216937e6804fd1c6c272d7fb58538d289fe1ddfa0e5f6c90b1b86fd649fd472e22032

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.55.0 (2024-04-16)
+------------------
+
+* Feature - This release adds new APIs to allow customers to configure their Outpost capacity at order-time.
+
 1.54.0 (2024-04-12)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.54.0
+1.55.0

data/lib/aws-sdk-outposts/client.rb

@@ -388,6 +388,33 @@ module Aws::Outposts
 
     # @!group API Operations
 
+    # Cancels the capacity task.
+    #
+    # @option params [required, String] :capacity_task_id
+    #   ID of the capacity task that you want to cancel.
+    #
+    # @option params [required, String] :outpost_identifier
+    #   ID or ARN of the Outpost associated with the capacity task that you
+    #   want to cancel.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.cancel_capacity_task({
+    #     capacity_task_id: "CapacityTaskId", # required
+    #     outpost_identifier: "OutpostIdentifier", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/CancelCapacityTask AWS API Documentation
+    #
+    # @overload cancel_capacity_task(params = {})
+    # @param [Hash] params ({})
+    def cancel_capacity_task(params = {}, options = {})
+      req = build_request(:cancel_capacity_task, params)
+      req.send_request(options)
+    end
+
     # Cancels the specified order for an Outpost.
     #
     # @option params [required, String] :order_id
@@ -665,7 +692,7 @@ module Aws::Outposts
     # Deletes the specified Outpost.
     #
     # @option params [required, String] :outpost_id
-    #   The ID or the Amazon Resource Name (ARN) of the Outpost.
+    #   The ID or ARN of the Outpost.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -706,6 +733,59 @@ module Aws::Outposts
       req.send_request(options)
     end
 
+    # Gets details of the specified capacity task.
+    #
+    # @option params [required, String] :capacity_task_id
+    #   ID of the capacity task.
+    #
+    # @option params [required, String] :outpost_identifier
+    #   ID or ARN of the Outpost associated with the specified capacity task.
+    #
+    # @return [Types::GetCapacityTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetCapacityTaskOutput#capacity_task_id #capacity_task_id} => String
+    #   * {Types::GetCapacityTaskOutput#outpost_id #outpost_id} => String
+    #   * {Types::GetCapacityTaskOutput#order_id #order_id} => String
+    #   * {Types::GetCapacityTaskOutput#requested_instance_pools #requested_instance_pools} => Array<Types::InstanceTypeCapacity>
+    #   * {Types::GetCapacityTaskOutput#dry_run #dry_run} => Boolean
+    #   * {Types::GetCapacityTaskOutput#capacity_task_status #capacity_task_status} => String
+    #   * {Types::GetCapacityTaskOutput#failed #failed} => Types::CapacityTaskFailure
+    #   * {Types::GetCapacityTaskOutput#creation_date #creation_date} => Time
+    #   * {Types::GetCapacityTaskOutput#completion_date #completion_date} => Time
+    #   * {Types::GetCapacityTaskOutput#last_modified_date #last_modified_date} => Time
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_capacity_task({
+    #     capacity_task_id: "CapacityTaskId", # required
+    #     outpost_identifier: "OutpostIdentifier", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.capacity_task_id #=> String
+    #   resp.outpost_id #=> String
+    #   resp.order_id #=> String
+    #   resp.requested_instance_pools #=> Array
+    #   resp.requested_instance_pools[0].instance_type #=> String
+    #   resp.requested_instance_pools[0].count #=> Integer
+    #   resp.dry_run #=> Boolean
+    #   resp.capacity_task_status #=> String, one of "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "CANCELLED"
+    #   resp.failed.reason #=> String
+    #   resp.failed.type #=> String, one of "UNSUPPORTED_CAPACITY_CONFIGURATION"
+    #   resp.creation_date #=> Time
+    #   resp.completion_date #=> Time
+    #   resp.last_modified_date #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetCapacityTask AWS API Documentation
+    #
+    # @overload get_capacity_task(params = {})
+    # @param [Hash] params ({})
+    def get_capacity_task(params = {}, options = {})
+      req = build_request(:get_capacity_task, params)
+      req.send_request(options)
+    end
+
     # Gets information about the specified catalog item.
     #
     # @option params [required, String] :catalog_item_id
@@ -848,7 +928,7 @@ module Aws::Outposts
     # Gets information about the specified Outpost.
     #
     # @option params [required, String] :outpost_id
-    #   The ID or the Amazon Resource Name (ARN) of the Outpost.
+    #   The ID or ARN of the Outpost.
     #
     # @return [Types::GetOutpostOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -888,7 +968,7 @@ module Aws::Outposts
     # Gets the instance types for the specified Outpost.
     #
     # @option params [required, String] :outpost_id
-    #   The ID or the Amazon Resource Name (ARN) of the Outpost.
+    #   The ID or ARN of the Outpost.
     #
     # @option params [String] :next_token
     #   The pagination token.
@@ -930,6 +1010,54 @@ module Aws::Outposts
       req.send_request(options)
     end
 
+    # 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.
+    #
+    # @option params [required, String] :outpost_identifier
+    #   The ID or ARN of the Outpost.
+    #
+    # @option params [required, String] :order_id
+    #   The ID for the Amazon Web Services Outposts order.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum page size.
+    #
+    # @option params [String] :next_token
+    #   The pagination token.
+    #
+    # @return [Types::GetOutpostSupportedInstanceTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetOutpostSupportedInstanceTypesOutput#instance_types #instance_types} => Array<Types::InstanceTypeItem>
+    #   * {Types::GetOutpostSupportedInstanceTypesOutput#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_outpost_supported_instance_types({
+    #     outpost_identifier: "OutpostIdentifier", # required
+    #     order_id: "OrderId", # required
+    #     max_results: 1,
+    #     next_token: "Token",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.instance_types #=> Array
+    #   resp.instance_types[0].instance_type #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetOutpostSupportedInstanceTypes AWS API Documentation
+    #
+    # @overload get_outpost_supported_instance_types(params = {})
+    # @param [Hash] params ({})
+    def get_outpost_supported_instance_types(params = {}, options = {})
+      req = build_request(:get_outpost_supported_instance_types, params)
+      req.send_request(options)
+    end
+
     # Gets information about the specified Outpost site.
     #
     # @option params [required, String] :site_id
@@ -1085,6 +1213,64 @@ module Aws::Outposts
       req.send_request(options)
     end
 
+    # 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.
+    #
+    # @option params [String] :outpost_identifier_filter
+    #   Filters the results by an Outpost ID or an Outpost ARN.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum page size.
+    #
+    # @option params [String] :next_token
+    #   The pagination token.
+    #
+    # @option params [Array<String>] :capacity_task_status_filter
+    #   A list of statuses. For example, `REQUESTED` or
+    #   `WAITING_FOR_EVACUATION`.
+    #
+    # @return [Types::ListCapacityTasksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListCapacityTasksOutput#capacity_tasks #capacity_tasks} => Array&lt;Types::CapacityTaskSummary&gt;
+    #   * {Types::ListCapacityTasksOutput#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example 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, CANCELLED
+    #   })
+    #
+    # @example 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].capacity_task_status #=> String, one of "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "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
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListCapacityTasks AWS API Documentation
+    #
+    # @overload list_capacity_tasks(params = {})
+    # @param [Hash] params ({})
+    def list_capacity_tasks(params = {}, options = {})
+      req = build_request(:list_capacity_tasks, params)
+      req.send_request(options)
+    end
+
     # Lists the items in the catalog.
     #
     # Use filters to return specific results. If you specify multiple
@@ -1370,6 +1556,77 @@ module Aws::Outposts
       req.send_request(options)
     end
 
+    # Starts the specified capacity task. You can have one active capacity
+    # task for an order.
+    #
+    # @option params [required, String] :outpost_identifier
+    #   The ID or ARN of the Outposts associated with the specified capacity
+    #   task.
+    #
+    # @option params [required, String] :order_id
+    #   The ID of the Amazon Web Services Outposts order associated with the
+    #   specified capacity task.
+    #
+    # @option params [required, Array<Types::InstanceTypeCapacity>] :instance_pools
+    #   The instance pools specified in the capacity task.
+    #
+    # @option params [Boolean] :dry_run
+    #   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.
+    #
+    # @return [Types::StartCapacityTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartCapacityTaskOutput#capacity_task_id #capacity_task_id} => String
+    #   * {Types::StartCapacityTaskOutput#outpost_id #outpost_id} => String
+    #   * {Types::StartCapacityTaskOutput#order_id #order_id} => String
+    #   * {Types::StartCapacityTaskOutput#requested_instance_pools #requested_instance_pools} => Array&lt;Types::InstanceTypeCapacity&gt;
+    #   * {Types::StartCapacityTaskOutput#dry_run #dry_run} => Boolean
+    #   * {Types::StartCapacityTaskOutput#capacity_task_status #capacity_task_status} => String
+    #   * {Types::StartCapacityTaskOutput#failed #failed} => Types::CapacityTaskFailure
+    #   * {Types::StartCapacityTaskOutput#creation_date #creation_date} => Time
+    #   * {Types::StartCapacityTaskOutput#completion_date #completion_date} => Time
+    #   * {Types::StartCapacityTaskOutput#last_modified_date #last_modified_date} => Time
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_capacity_task({
+    #     outpost_identifier: "OutpostIdentifier", # required
+    #     order_id: "OrderId", # required
+    #     instance_pools: [ # required
+    #       {
+    #         instance_type: "InstanceTypeName", # required
+    #         count: 1, # required
+    #       },
+    #     ],
+    #     dry_run: false,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.capacity_task_id #=> String
+    #   resp.outpost_id #=> String
+    #   resp.order_id #=> String
+    #   resp.requested_instance_pools #=> Array
+    #   resp.requested_instance_pools[0].instance_type #=> String
+    #   resp.requested_instance_pools[0].count #=> Integer
+    #   resp.dry_run #=> Boolean
+    #   resp.capacity_task_status #=> String, one of "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "CANCELLED"
+    #   resp.failed.reason #=> String
+    #   resp.failed.type #=> String, one of "UNSUPPORTED_CAPACITY_CONFIGURATION"
+    #   resp.creation_date #=> Time
+    #   resp.completion_date #=> Time
+    #   resp.last_modified_date #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/StartCapacityTask AWS API Documentation
+    #
+    # @overload start_capacity_task(params = {})
+    # @param [Hash] params ({})
+    def start_capacity_task(params = {}, options = {})
+      req = build_request(:start_capacity_task, params)
+      req.send_request(options)
+    end
+
     # <note markdown="1"> Amazon Web Services uses this action to install Outpost servers.
     #
     #  </note>
@@ -1485,7 +1742,7 @@ module Aws::Outposts
     # Updates an Outpost.
     #
     # @option params [required, String] :outpost_id
-    #   The ID or the Amazon Resource Name (ARN) of the Outpost.
+    #   The ID or ARN of the Outpost.
     #
     # @option params [String] :name
     #   The name of the Outpost.
@@ -1833,7 +2090,7 @@ module Aws::Outposts
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-outposts'
-      context[:gem_version] = '1.54.0'
+      context[:gem_version] = '1.55.0'
       Seahorse::Client::Request.new(handlers, context)
     end