outposts/aws.sdk.kotlin.services.outposts

Package-level declarations

Types

Link copied to clipboard
interface OutpostsClient : SdkClient

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun OutpostsClient.cancelCapacityTask(crossinline block: CancelCapacityTaskRequest.Builder.() -> Unit): CancelCapacityTaskResponse

Cancels the capacity task.

Link copied to clipboard
inline suspend fun OutpostsClient.cancelOrder(crossinline block: CancelOrderRequest.Builder.() -> Unit): CancelOrderResponse

Cancels the specified order for an Outpost.

Link copied to clipboard
inline suspend fun OutpostsClient.createOrder(crossinline block: CreateOrderRequest.Builder.() -> Unit): CreateOrderResponse

Creates an order for an Outpost.

Link copied to clipboard
inline suspend fun OutpostsClient.createOutpost(crossinline block: CreateOutpostRequest.Builder.() -> Unit): CreateOutpostResponse

Creates an Outpost.

Link copied to clipboard
inline suspend fun OutpostsClient.createSite(crossinline block: CreateSiteRequest.Builder.() -> Unit): CreateSiteResponse

Creates a site for an Outpost.

Link copied to clipboard
inline suspend fun OutpostsClient.deleteOutpost(crossinline block: DeleteOutpostRequest.Builder.() -> Unit): DeleteOutpostResponse

Deletes the specified Outpost.

Link copied to clipboard
inline suspend fun OutpostsClient.deleteSite(crossinline block: DeleteSiteRequest.Builder.() -> Unit): DeleteSiteResponse

Deletes the specified site.

Link copied to clipboard
inline suspend fun OutpostsClient.getCapacityTask(crossinline block: GetCapacityTaskRequest.Builder.() -> Unit): GetCapacityTaskResponse

Gets details of the specified capacity task.

Link copied to clipboard
inline suspend fun OutpostsClient.getCatalogItem(crossinline block: GetCatalogItemRequest.Builder.() -> Unit): GetCatalogItemResponse

Gets information about the specified catalog item.

Link copied to clipboard
inline suspend fun OutpostsClient.getConnection(crossinline block: GetConnectionRequest.Builder.() -> Unit): GetConnectionResponse

Amazon Web Services uses this action to install Outpost servers.

Link copied to clipboard
inline suspend fun OutpostsClient.getOrder(crossinline block: GetOrderRequest.Builder.() -> Unit): GetOrderResponse

Gets information about the specified order.

Link copied to clipboard
inline suspend fun OutpostsClient.getOutpost(crossinline block: GetOutpostRequest.Builder.() -> Unit): GetOutpostResponse

Gets information about the specified Outpost.

Link copied to clipboard
inline suspend fun OutpostsClient.getOutpostInstanceTypes(crossinline block: GetOutpostInstanceTypesRequest.Builder.() -> Unit): GetOutpostInstanceTypesResponse

Gets the instance types for the specified Outpost.

Link copied to clipboard
inline suspend fun OutpostsClient.getOutpostSupportedInstanceTypes(crossinline block: GetOutpostSupportedInstanceTypesRequest.Builder.() -> Unit): GetOutpostSupportedInstanceTypesResponse

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.

Link copied to clipboard
inline suspend fun OutpostsClient.getSite(crossinline block: GetSiteRequest.Builder.() -> Unit): GetSiteResponse

Gets information about the specified Outpost site.

Link copied to clipboard
inline suspend fun OutpostsClient.getSiteAddress(crossinline block: GetSiteAddressRequest.Builder.() -> Unit): GetSiteAddressResponse

Gets the site address of the specified site.

Link copied to clipboard
inline suspend fun OutpostsClient.listAssetInstances(crossinline block: ListAssetInstancesRequest.Builder.() -> Unit): ListAssetInstancesResponse

A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost. Does not include Amazon EBS or Amazon S3 instances.

Link copied to clipboard
inline suspend fun OutpostsClient.listAssets(crossinline block: ListAssetsRequest.Builder.() -> Unit): ListAssetsResponse

Lists the hardware assets for the specified Outpost.

Link copied to clipboard
inline suspend fun OutpostsClient.listBlockingInstancesForCapacityTask(crossinline block: ListBlockingInstancesForCapacityTaskRequest.Builder.() -> Unit): ListBlockingInstancesForCapacityTaskResponse

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

Link copied to clipboard
inline suspend fun OutpostsClient.listCapacityTasks(crossinline block: ListCapacityTasksRequest.Builder.() -> Unit): ListCapacityTasksResponse

Lists the capacity tasks for your Amazon Web Services account.

Link copied to clipboard
inline suspend fun OutpostsClient.listCatalogItems(crossinline block: ListCatalogItemsRequest.Builder.() -> Unit): ListCatalogItemsResponse

Lists the items in the catalog.

Link copied to clipboard
inline suspend fun OutpostsClient.listOrders(crossinline block: ListOrdersRequest.Builder.() -> Unit): ListOrdersResponse

Lists the Outpost orders for your Amazon Web Services account.

Link copied to clipboard
inline suspend fun OutpostsClient.listOutposts(crossinline block: ListOutpostsRequest.Builder.() -> Unit): ListOutpostsResponse

Lists the Outposts for your Amazon Web Services account.

Link copied to clipboard
inline suspend fun OutpostsClient.listSites(crossinline block: ListSitesRequest.Builder.() -> Unit): ListSitesResponse

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

Link copied to clipboard
inline suspend fun OutpostsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags for the specified resource.

Link copied to clipboard
inline suspend fun OutpostsClient.startCapacityTask(crossinline block: StartCapacityTaskRequest.Builder.() -> Unit): StartCapacityTaskResponse

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

Link copied to clipboard
inline suspend fun OutpostsClient.startConnection(crossinline block: StartConnectionRequest.Builder.() -> Unit): StartConnectionResponse

Amazon Web Services uses this action to install Outpost servers.

Link copied to clipboard
inline suspend fun OutpostsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds tags to the specified resource.

Link copied to clipboard
inline suspend fun OutpostsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from the specified resource.

Link copied to clipboard
inline suspend fun OutpostsClient.updateOutpost(crossinline block: UpdateOutpostRequest.Builder.() -> Unit): UpdateOutpostResponse

Updates an Outpost.

Link copied to clipboard
inline suspend fun OutpostsClient.updateSite(crossinline block: UpdateSiteRequest.Builder.() -> Unit): UpdateSiteResponse

Updates the specified site.

Link copied to clipboard
inline suspend fun OutpostsClient.updateSiteAddress(crossinline block: UpdateSiteAddressRequest.Builder.() -> Unit): UpdateSiteAddressResponse

Updates the address of the specified site.

Link copied to clipboard
inline suspend fun OutpostsClient.updateSiteRackPhysicalProperties(crossinline block: UpdateSiteRackPhysicalPropertiesRequest.Builder.() -> Unit): UpdateSiteRackPhysicalPropertiesResponse

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.

Link copied to clipboard
fun OutpostsClient.withConfig(block: OutpostsClient.Config.Builder.() -> Unit): OutpostsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.