com.amazonaws.services.outposts.AWSOutposts Maven / Gradle / Ivy
Show all versions of aws-java-sdk-outposts Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.outposts;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.outposts.model.*;
/**
* Interface for accessing Outposts.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.outposts.AbstractAWSOutposts} instead.
*
*
*
* Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and
* tools to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web
* Services Outposts enables customers to build and run applications on premises using the same programming interfaces
* as in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local data
* processing needs.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSOutposts {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "outposts";
/**
*
* Cancels the capacity task.
*
*
* @param cancelCapacityTaskRequest
* @return Result of the CancelCapacityTask operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.CancelCapacityTask
* @see AWS
* API Documentation
*/
CancelCapacityTaskResult cancelCapacityTask(CancelCapacityTaskRequest cancelCapacityTaskRequest);
/**
*
* Cancels the specified order for an Outpost.
*
*
* @param cancelOrderRequest
* @return Result of the CancelOrder operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.CancelOrder
* @see AWS API
* Documentation
*/
CancelOrderResult cancelOrder(CancelOrderRequest cancelOrderRequest);
/**
*
* Creates an order for an Outpost.
*
*
* @param createOrderRequest
* @return Result of the CreateOrder operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @throws ServiceQuotaExceededException
* You have exceeded a service quota.
* @sample AWSOutposts.CreateOrder
* @see AWS API
* Documentation
*/
CreateOrderResult createOrder(CreateOrderRequest createOrderRequest);
/**
*
* Creates an Outpost.
*
*
* You can specify either an Availability one or an AZ ID.
*
*
* @param createOutpostRequest
* @return Result of the CreateOutpost operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @throws ServiceQuotaExceededException
* You have exceeded a service quota.
* @sample AWSOutposts.CreateOutpost
* @see AWS API
* Documentation
*/
CreateOutpostResult createOutpost(CreateOutpostRequest createOutpostRequest);
/**
*
* Creates a site for an Outpost.
*
*
* @param createSiteRequest
* @return Result of the CreateSite operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @throws ServiceQuotaExceededException
* You have exceeded a service quota.
* @sample AWSOutposts.CreateSite
* @see AWS API
* Documentation
*/
CreateSiteResult createSite(CreateSiteRequest createSiteRequest);
/**
*
* Deletes the specified Outpost.
*
*
* @param deleteOutpostRequest
* @return Result of the DeleteOutpost operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.DeleteOutpost
* @see AWS API
* Documentation
*/
DeleteOutpostResult deleteOutpost(DeleteOutpostRequest deleteOutpostRequest);
/**
*
* Deletes the specified site.
*
*
* @param deleteSiteRequest
* @return Result of the DeleteSite operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.DeleteSite
* @see AWS API
* Documentation
*/
DeleteSiteResult deleteSite(DeleteSiteRequest deleteSiteRequest);
/**
*
* Gets details of the specified capacity task.
*
*
* @param getCapacityTaskRequest
* @return Result of the GetCapacityTask operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.GetCapacityTask
* @see AWS API
* Documentation
*/
GetCapacityTaskResult getCapacityTask(GetCapacityTaskRequest getCapacityTaskRequest);
/**
*
* Gets information about the specified catalog item.
*
*
* @param getCatalogItemRequest
* @return Result of the GetCatalogItem operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.GetCatalogItem
* @see AWS API
* Documentation
*/
GetCatalogItemResult getCatalogItem(GetCatalogItemRequest getCatalogItemRequest);
/**
*
*
* 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.
*
*
* @param getConnectionRequest
* @return Result of the GetConnection operation returned by the service.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.GetConnection
* @see AWS API
* Documentation
*/
GetConnectionResult getConnection(GetConnectionRequest getConnectionRequest);
/**
*
* Gets information about the specified order.
*
*
* @param getOrderRequest
* @return Result of the GetOrder operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.GetOrder
* @see AWS API
* Documentation
*/
GetOrderResult getOrder(GetOrderRequest getOrderRequest);
/**
*
* Gets information about the specified Outpost.
*
*
* @param getOutpostRequest
* @return Result of the GetOutpost operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.GetOutpost
* @see AWS API
* Documentation
*/
GetOutpostResult getOutpost(GetOutpostRequest getOutpostRequest);
/**
*
* Gets the instance types for the specified Outpost.
*
*
* @param getOutpostInstanceTypesRequest
* @return Result of the GetOutpostInstanceTypes operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.GetOutpostInstanceTypes
* @see AWS API Documentation
*/
GetOutpostInstanceTypesResult getOutpostInstanceTypes(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest);
/**
*
* 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.
*
*
* @param getOutpostSupportedInstanceTypesRequest
* @return Result of the GetOutpostSupportedInstanceTypes operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.GetOutpostSupportedInstanceTypes
* @see AWS API Documentation
*/
GetOutpostSupportedInstanceTypesResult getOutpostSupportedInstanceTypes(GetOutpostSupportedInstanceTypesRequest getOutpostSupportedInstanceTypesRequest);
/**
*
* Gets information about the specified Outpost site.
*
*
* @param getSiteRequest
* @return Result of the GetSite operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.GetSite
* @see AWS API
* Documentation
*/
GetSiteResult getSite(GetSiteRequest getSiteRequest);
/**
*
* Gets the site address of the specified site.
*
*
* @param getSiteAddressRequest
* @return Result of the GetSiteAddress operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.GetSiteAddress
* @see AWS API
* Documentation
*/
GetSiteAddressResult getSiteAddress(GetSiteAddressRequest getSiteAddressRequest);
/**
*
* 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.
*
*
* @param listAssetsRequest
* @return Result of the ListAssets operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.ListAssets
* @see AWS API
* Documentation
*/
ListAssetsResult listAssets(ListAssetsRequest listAssetsRequest);
/**
*
* 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.
*
*
* @param listCapacityTasksRequest
* @return Result of the ListCapacityTasks operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.ListCapacityTasks
* @see AWS API
* Documentation
*/
ListCapacityTasksResult listCapacityTasks(ListCapacityTasksRequest listCapacityTasksRequest);
/**
*
* 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.
*
*
* @param listCatalogItemsRequest
* @return Result of the ListCatalogItems operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.ListCatalogItems
* @see AWS API
* Documentation
*/
ListCatalogItemsResult listCatalogItems(ListCatalogItemsRequest listCatalogItemsRequest);
/**
*
* Lists the Outpost orders for your Amazon Web Services account.
*
*
* @param listOrdersRequest
* @return Result of the ListOrders operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.ListOrders
* @see AWS API
* Documentation
*/
ListOrdersResult listOrders(ListOrdersRequest listOrdersRequest);
/**
*
* 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.
*
*
* @param listOutpostsRequest
* @return Result of the ListOutposts operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.ListOutposts
* @see AWS API
* Documentation
*/
ListOutpostsResult listOutposts(ListOutpostsRequest listOutpostsRequest);
/**
*
* 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.
*
*
* @param listSitesRequest
* @return Result of the ListSites operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.ListSites
* @see AWS API
* Documentation
*/
ListSitesResult listSites(ListSitesRequest listSitesRequest);
/**
*
* Lists the tags for the specified resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* An internal error has occurred.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @sample AWSOutposts.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Starts the specified capacity task. You can have one active capacity task for an order.
*
*
* @param startCapacityTaskRequest
* @return Result of the StartCapacityTask operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @sample AWSOutposts.StartCapacityTask
* @see AWS API
* Documentation
*/
StartCapacityTaskResult startCapacityTask(StartCapacityTaskRequest startCapacityTaskRequest);
/**
*
*
* 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.
*
*
* @param startConnectionRequest
* @return Result of the StartConnection operation returned by the service.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.StartConnection
* @see AWS API
* Documentation
*/
StartConnectionResult startConnection(StartConnectionRequest startConnectionRequest);
/**
*
* Adds tags to the specified resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* An internal error has occurred.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @sample AWSOutposts.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes tags from the specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* An internal error has occurred.
* @throws ValidationException
* A parameter is not valid.
* @throws NotFoundException
* The specified request is not valid.
* @sample AWSOutposts.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates an Outpost.
*
*
* @param updateOutpostRequest
* @return Result of the UpdateOutpost operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.UpdateOutpost
* @see AWS API
* Documentation
*/
UpdateOutpostResult updateOutpost(UpdateOutpostRequest updateOutpostRequest);
/**
*
* Updates the specified site.
*
*
* @param updateSiteRequest
* @return Result of the UpdateSite operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.UpdateSite
* @see AWS API
* Documentation
*/
UpdateSiteResult updateSite(UpdateSiteRequest updateSiteRequest);
/**
*
* 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.
*
*
* @param updateSiteAddressRequest
* @return Result of the UpdateSiteAddress operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws NotFoundException
* The specified request is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.UpdateSiteAddress
* @see AWS API
* Documentation
*/
UpdateSiteAddressResult updateSiteAddress(UpdateSiteAddressRequest updateSiteAddressRequest);
/**
*
* 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.
*
*
* @param updateSiteRackPhysicalPropertiesRequest
* @return Result of the UpdateSiteRackPhysicalProperties operation returned by the service.
* @throws ValidationException
* A parameter is not valid.
* @throws ConflictException
* Updating or deleting this resource can cause an inconsistent state.
* @throws NotFoundException
* The specified request is not valid.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSOutposts.UpdateSiteRackPhysicalProperties
* @see AWS API Documentation
*/
UpdateSiteRackPhysicalPropertiesResult updateSiteRackPhysicalProperties(UpdateSiteRackPhysicalPropertiesRequest updateSiteRackPhysicalPropertiesRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}