outposts/aws.sdk.kotlin.services.outposts/OutpostsClient

OutpostsClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<OutpostsClient.Config, OutpostsClient.Config.Builder, OutpostsClient>

Companion

object Companion : AbstractAwsSdkClientFactory<OutpostsClient.Config, OutpostsClient.Config.Builder, OutpostsClient, OutpostsClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: OutpostsClient.Config

OutpostsClient's configuration

Functions

cancelOrder

abstract suspend fun cancelOrder(input: CancelOrderRequest): CancelOrderResponse

Cancels the specified order for an Outpost.

createOrder

abstract suspend fun createOrder(input: CreateOrderRequest): CreateOrderResponse

Creates an order for an Outpost.

createOutpost

abstract suspend fun createOutpost(input: CreateOutpostRequest): CreateOutpostResponse

Creates an Outpost.

createSite

abstract suspend fun createSite(input: CreateSiteRequest): CreateSiteResponse

Creates a site for an Outpost.

deleteOutpost

abstract suspend fun deleteOutpost(input: DeleteOutpostRequest): DeleteOutpostResponse

Deletes the specified Outpost.

deleteSite

abstract suspend fun deleteSite(input: DeleteSiteRequest): DeleteSiteResponse

Deletes the specified site.

getCatalogItem

abstract suspend fun getCatalogItem(input: GetCatalogItemRequest): GetCatalogItemResponse

Gets information about the specified catalog item.

getConnection

abstract suspend fun getConnection(input: GetConnectionRequest): GetConnectionResponse

Amazon Web Services uses this action to install Outpost servers.

getOrder

abstract suspend fun getOrder(input: GetOrderRequest): GetOrderResponse

Gets information about the specified order.

getOutpost

abstract suspend fun getOutpost(input: GetOutpostRequest): GetOutpostResponse

Gets information about the specified Outpost.

getOutpostInstanceTypes

abstract suspend fun getOutpostInstanceTypes(input: GetOutpostInstanceTypesRequest): GetOutpostInstanceTypesResponse

Gets the instance types for the specified Outpost.

getSite

abstract suspend fun getSite(input: GetSiteRequest): GetSiteResponse

Gets information about the specified Outpost site.

getSiteAddress

abstract suspend fun getSiteAddress(input: GetSiteAddressRequest): GetSiteAddressResponse

Gets the site address of the specified site.

listAssets

abstract suspend fun listAssets(input: ListAssetsRequest): ListAssetsResponse

Lists the hardware assets for the specified Outpost.

listCatalogItems

abstract suspend fun listCatalogItems(input: ListCatalogItemsRequest = ListCatalogItemsRequest { }): ListCatalogItemsResponse

Lists the items in the catalog.

listOrders

abstract suspend fun listOrders(input: ListOrdersRequest = ListOrdersRequest { }): ListOrdersResponse

Lists the Outpost orders for your Amazon Web Services account.

listOutposts

abstract suspend fun listOutposts(input: ListOutpostsRequest = ListOutpostsRequest { }): ListOutpostsResponse

Lists the Outposts for your Amazon Web Services account.

listSites

abstract suspend fun listSites(input: ListSitesRequest = ListSitesRequest { }): ListSitesResponse

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

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags for the specified resource.

startConnection

abstract suspend fun startConnection(input: StartConnectionRequest): StartConnectionResponse

Amazon Web Services uses this action to install Outpost servers.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds tags to the specified resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from the specified resource.

updateOutpost

abstract suspend fun updateOutpost(input: UpdateOutpostRequest): UpdateOutpostResponse

Updates an Outpost.

updateSite

abstract suspend fun updateSite(input: UpdateSiteRequest): UpdateSiteResponse

Updates the specified site.

updateSiteAddress

abstract suspend fun updateSiteAddress(input: UpdateSiteAddressRequest): UpdateSiteAddressResponse

Updates the address of the specified site.

updateSiteRackPhysicalProperties

abstract suspend fun updateSiteRackPhysicalProperties(input: UpdateSiteRackPhysicalPropertiesRequest): 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.

Inherited functions

cancelOrder

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

Cancels the specified order for an Outpost.

expect abstract fun close()

createOrder

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

Creates an order for an Outpost.

createOutpost

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

Creates an Outpost.

createSite

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

Creates a site for an Outpost.

deleteOutpost

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

Deletes the specified Outpost.

deleteSite

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

Deletes the specified site.

getCatalogItem

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

Gets information about the specified catalog item.

getConnection

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

Amazon Web Services uses this action to install Outpost servers.

getOrder

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

Gets information about the specified order.

getOutpost

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

Gets information about the specified Outpost.

getOutpostInstanceTypes

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

Gets the instance types for the specified Outpost.

getOutpostInstanceTypesPaginated

fun OutpostsClient.getOutpostInstanceTypesPaginated(initialRequest: GetOutpostInstanceTypesRequest): Flow<GetOutpostInstanceTypesResponse>

fun OutpostsClient.getOutpostInstanceTypesPaginated(block: GetOutpostInstanceTypesRequest.Builder.() -> Unit): Flow<GetOutpostInstanceTypesResponse>

Paginate over GetOutpostInstanceTypesResponse results.

getSite

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

Gets information about the specified Outpost site.

getSiteAddress

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

Gets the site address of the specified site.

listAssets

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

Lists the hardware assets for the specified Outpost.

listAssetsPaginated

fun OutpostsClient.listAssetsPaginated(initialRequest: ListAssetsRequest): Flow<ListAssetsResponse>

fun OutpostsClient.listAssetsPaginated(block: ListAssetsRequest.Builder.() -> Unit): Flow<ListAssetsResponse>

Paginate over ListAssetsResponse results.

listCatalogItems

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

Lists the items in the catalog.

listCatalogItemsPaginated

fun OutpostsClient.listCatalogItemsPaginated(initialRequest: ListCatalogItemsRequest = ListCatalogItemsRequest { }): Flow<ListCatalogItemsResponse>

fun OutpostsClient.listCatalogItemsPaginated(block: ListCatalogItemsRequest.Builder.() -> Unit): Flow<ListCatalogItemsResponse>

Paginate over ListCatalogItemsResponse results.

listOrders

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

Lists the Outpost orders for your Amazon Web Services account.

listOrdersPaginated

fun OutpostsClient.listOrdersPaginated(initialRequest: ListOrdersRequest = ListOrdersRequest { }): Flow<ListOrdersResponse>

fun OutpostsClient.listOrdersPaginated(block: ListOrdersRequest.Builder.() -> Unit): Flow<ListOrdersResponse>

Paginate over ListOrdersResponse results.

listOutposts

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

Lists the Outposts for your Amazon Web Services account.

listOutpostsPaginated

fun OutpostsClient.listOutpostsPaginated(initialRequest: ListOutpostsRequest = ListOutpostsRequest { }): Flow<ListOutpostsResponse>

fun OutpostsClient.listOutpostsPaginated(block: ListOutpostsRequest.Builder.() -> Unit): Flow<ListOutpostsResponse>

Paginate over ListOutpostsResponse results.

listSites

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.

listSitesPaginated

fun OutpostsClient.listSitesPaginated(initialRequest: ListSitesRequest = ListSitesRequest { }): Flow<ListSitesResponse>

fun OutpostsClient.listSitesPaginated(block: ListSitesRequest.Builder.() -> Unit): Flow<ListSitesResponse>

Paginate over ListSitesResponse results.

listTagsForResource

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

Lists the tags for the specified resource.

startConnection

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

Amazon Web Services uses this action to install Outpost servers.

tagResource

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

Adds tags to the specified resource.

untagResource

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

Removes tags from the specified resource.

updateOutpost

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

Updates an Outpost.

updateSite

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

Updates the specified site.

updateSiteAddress

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

Updates the address of the specified site.

updateSiteRackPhysicalProperties

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

withConfig

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.