evs/aws.sdk.kotlin.services.evs/EvsClient

EvsClient

Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).

Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.

Types

Builder

class Builder

Companion

object Companion

Config

class Config

Properties

config

abstract val config: EvsClient.Config

EvsClient's configuration

Functions

associateEipToVlan

abstract suspend fun associateEipToVlan(input: AssociateEipToVlanRequest): AssociateEipToVlanResponse

Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

createEntitlement

abstract suspend fun createEntitlement(input: CreateEntitlementRequest): CreateEntitlementResponse

Creates a Windows Server License entitlement for virtual machines in an Amazon EVS environment using the provided vCenter Server connector. This is an asynchronous operation. Amazon EVS validates the specified virtual machines before starting usage tracking.

createEnvironment

abstract suspend fun createEnvironment(input: CreateEnvironmentRequest): CreateEnvironmentResponse

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

createEnvironmentConnector

abstract suspend fun createEnvironmentConnector(input: CreateEnvironmentConnectorRequest): CreateEnvironmentConnectorResponse

Creates a connector for an Amazon EVS environment. A connector establishes a connection to a VCF appliance, such as vCenter, using a fully qualified domain name and an Amazon Web Services Secrets Manager secret that stores the appliance credentials.

createEnvironmentHost

abstract suspend fun createEnvironmentHost(input: CreateEnvironmentHostRequest): CreateEnvironmentHostResponse

Creates an ESX host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

deleteEntitlement

abstract suspend fun deleteEntitlement(input: DeleteEntitlementRequest): DeleteEntitlementResponse

Deletes a Windows Server License entitlement for virtual machines in an Amazon EVS environment. Deleting an entitlement stops usage tracking for the specified virtual machines.

deleteEnvironment

abstract suspend fun deleteEnvironment(input: DeleteEnvironmentRequest): DeleteEnvironmentResponse

Deletes an Amazon EVS environment.

deleteEnvironmentConnector

abstract suspend fun deleteEnvironmentConnector(input: DeleteEnvironmentConnectorRequest): DeleteEnvironmentConnectorResponse

Deletes a connector from an Amazon EVS environment.

deleteEnvironmentHost

abstract suspend fun deleteEnvironmentHost(input: DeleteEnvironmentHostRequest): DeleteEnvironmentHostResponse

Deletes a host from an Amazon EVS environment.

disassociateEipFromVlan

abstract suspend fun disassociateEipFromVlan(input: DisassociateEipFromVlanRequest): DisassociateEipFromVlanResponse

Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

getEnvironment

abstract suspend fun getEnvironment(input: GetEnvironmentRequest): GetEnvironmentResponse

Returns a description of the specified environment.

getVersions

abstract suspend fun getVersions(input: GetVersionsRequest = GetVersionsRequest { }): GetVersionsResponse

Returns information about VCF versions, ESX versions and EC2 instance types provided by Amazon EVS. For each VCF version, the response also includes the default ESX version and provided EC2 instance types.

listEnvironmentConnectors

abstract suspend fun listEnvironmentConnectors(input: ListEnvironmentConnectorsRequest): ListEnvironmentConnectorsResponse

Lists the connectors within an environment. Returns the status of each connector and its applicable checks, among other connector details.

listEnvironmentHosts

abstract suspend fun listEnvironmentHosts(input: ListEnvironmentHostsRequest): ListEnvironmentHostsResponse

List the hosts within an environment.

listEnvironments

abstract suspend fun listEnvironments(input: ListEnvironmentsRequest = ListEnvironmentsRequest { }): ListEnvironmentsResponse

Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.

listEnvironmentVlans

abstract suspend fun listEnvironmentVlans(input: ListEnvironmentVlansRequest): ListEnvironmentVlansResponse

Lists environment VLANs that are associated with the specified environment.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags for an Amazon EVS resource.

listVmEntitlements

abstract suspend fun listVmEntitlements(input: ListVmEntitlementsRequest): ListVmEntitlementsResponse

Lists the Windows Server License entitlements for virtual machines in an Amazon EVS environment. Returns existing entitlements for virtual machines associated with the specified environment and connector.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Associates the specified tags to an Amazon EVS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLAN subnets and hosts associated with the environment.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Deletes specified tags from an Amazon EVS resource.

updateEnvironmentConnector

abstract suspend fun updateEnvironmentConnector(input: UpdateEnvironmentConnectorRequest): UpdateEnvironmentConnectorResponse

Updates a connector for an Amazon EVS environment. You can update the Amazon Web Services Secrets Manager secret ARN or the appliance FQDN to reconfigure the connector metadata.

Inherited functions

associateEipToVlan

inline suspend fun EvsClient.associateEipToVlan(crossinline block: AssociateEipToVlanRequest.Builder.() -> Unit): AssociateEipToVlanResponse

Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

createEntitlement

inline suspend fun EvsClient.createEntitlement(crossinline block: CreateEntitlementRequest.Builder.() -> Unit): CreateEntitlementResponse

createEnvironment

inline suspend fun EvsClient.createEnvironment(crossinline block: CreateEnvironmentRequest.Builder.() -> Unit): CreateEnvironmentResponse

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

createEnvironmentConnector

inline suspend fun EvsClient.createEnvironmentConnector(crossinline block: CreateEnvironmentConnectorRequest.Builder.() -> Unit): CreateEnvironmentConnectorResponse

createEnvironmentHost

inline suspend fun EvsClient.createEnvironmentHost(crossinline block: CreateEnvironmentHostRequest.Builder.() -> Unit): CreateEnvironmentHostResponse

Creates an ESX host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

deleteEntitlement

inline suspend fun EvsClient.deleteEntitlement(crossinline block: DeleteEntitlementRequest.Builder.() -> Unit): DeleteEntitlementResponse

Deletes a Windows Server License entitlement for virtual machines in an Amazon EVS environment. Deleting an entitlement stops usage tracking for the specified virtual machines.

deleteEnvironment

inline suspend fun EvsClient.deleteEnvironment(crossinline block: DeleteEnvironmentRequest.Builder.() -> Unit): DeleteEnvironmentResponse

Deletes an Amazon EVS environment.

deleteEnvironmentConnector

inline suspend fun EvsClient.deleteEnvironmentConnector(crossinline block: DeleteEnvironmentConnectorRequest.Builder.() -> Unit): DeleteEnvironmentConnectorResponse

Deletes a connector from an Amazon EVS environment.

deleteEnvironmentHost

inline suspend fun EvsClient.deleteEnvironmentHost(crossinline block: DeleteEnvironmentHostRequest.Builder.() -> Unit): DeleteEnvironmentHostResponse

Deletes a host from an Amazon EVS environment.

disassociateEipFromVlan

inline suspend fun EvsClient.disassociateEipFromVlan(crossinline block: DisassociateEipFromVlanRequest.Builder.() -> Unit): DisassociateEipFromVlanResponse

Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

getEnvironment

inline suspend fun EvsClient.getEnvironment(crossinline block: GetEnvironmentRequest.Builder.() -> Unit): GetEnvironmentResponse

Returns a description of the specified environment.

getVersions

inline suspend fun EvsClient.getVersions(crossinline block: GetVersionsRequest.Builder.() -> Unit): GetVersionsResponse

listEnvironmentConnectors

inline suspend fun EvsClient.listEnvironmentConnectors(crossinline block: ListEnvironmentConnectorsRequest.Builder.() -> Unit): ListEnvironmentConnectorsResponse

Lists the connectors within an environment. Returns the status of each connector and its applicable checks, among other connector details.

listEnvironmentConnectorsPaginated

fun EvsClient.listEnvironmentConnectorsPaginated(initialRequest: ListEnvironmentConnectorsRequest): Flow<ListEnvironmentConnectorsResponse>

fun EvsClient.listEnvironmentConnectorsPaginated(block: ListEnvironmentConnectorsRequest.Builder.() -> Unit): Flow<ListEnvironmentConnectorsResponse>

Paginate over ListEnvironmentConnectorsResponse results.

listEnvironmentHosts

inline suspend fun EvsClient.listEnvironmentHosts(crossinline block: ListEnvironmentHostsRequest.Builder.() -> Unit): ListEnvironmentHostsResponse

List the hosts within an environment.

listEnvironmentHostsPaginated

fun EvsClient.listEnvironmentHostsPaginated(initialRequest: ListEnvironmentHostsRequest): Flow<ListEnvironmentHostsResponse>

fun EvsClient.listEnvironmentHostsPaginated(block: ListEnvironmentHostsRequest.Builder.() -> Unit): Flow<ListEnvironmentHostsResponse>

Paginate over ListEnvironmentHostsResponse results.

listEnvironments

inline suspend fun EvsClient.listEnvironments(crossinline block: ListEnvironmentsRequest.Builder.() -> Unit): ListEnvironmentsResponse

Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.

listEnvironmentsPaginated

fun EvsClient.listEnvironmentsPaginated(initialRequest: ListEnvironmentsRequest = ListEnvironmentsRequest { }): Flow<ListEnvironmentsResponse>

fun EvsClient.listEnvironmentsPaginated(block: ListEnvironmentsRequest.Builder.() -> Unit): Flow<ListEnvironmentsResponse>

Paginate over ListEnvironmentsResponse results.

listEnvironmentVlans

inline suspend fun EvsClient.listEnvironmentVlans(crossinline block: ListEnvironmentVlansRequest.Builder.() -> Unit): ListEnvironmentVlansResponse

Lists environment VLANs that are associated with the specified environment.

listEnvironmentVlansPaginated

fun EvsClient.listEnvironmentVlansPaginated(initialRequest: ListEnvironmentVlansRequest): Flow<ListEnvironmentVlansResponse>

fun EvsClient.listEnvironmentVlansPaginated(block: ListEnvironmentVlansRequest.Builder.() -> Unit): Flow<ListEnvironmentVlansResponse>

Paginate over ListEnvironmentVlansResponse results.

listTagsForResource

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

Lists the tags for an Amazon EVS resource.

listVmEntitlements

inline suspend fun EvsClient.listVmEntitlements(crossinline block: ListVmEntitlementsRequest.Builder.() -> Unit): ListVmEntitlementsResponse

listVmEntitlementsPaginated

fun EvsClient.listVmEntitlementsPaginated(initialRequest: ListVmEntitlementsRequest): Flow<ListVmEntitlementsResponse>

fun EvsClient.listVmEntitlementsPaginated(block: ListVmEntitlementsRequest.Builder.() -> Unit): Flow<ListVmEntitlementsResponse>

Paginate over ListVmEntitlementsResponse results.

tagResource

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

untagResource

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

Deletes specified tags from an Amazon EVS resource.

updateEnvironmentConnector

inline suspend fun EvsClient.updateEnvironmentConnector(crossinline block: UpdateEnvironmentConnectorRequest.Builder.() -> Unit): UpdateEnvironmentConnectorResponse

Updates a connector for an Amazon EVS environment. You can update the Amazon Web Services Secrets Manager secret ARN or the appliance FQDN to reconfigure the connector metadata.

withConfig

fun EvsClient.withConfig(block: EvsClient.Config.Builder.() -> Unit): EvsClient

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.