EVSClient

Index > EVS > EVSClient

Auto-generated documentation for EVS type annotations stubs module mypy-boto3-evs.

EVSClient

Type annotations and code completion for boto3.client("evs"). boto3 documentation

# EVSClient usage example

from boto3.session import Session
from mypy_boto3_evs.client import EVSClient

def get_evs_client() -> EVSClient:
    return Session().client("evs")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("evs").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("evs")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.TagPolicyException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_evs.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("evs").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("evs").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_eip_to_vlan

Associates an Elastic IP address with a public HCX VLAN.

Type annotations and code completion for boto3.client("evs").associate_eip_to_vlan method. boto3 documentation

# associate_eip_to_vlan method definition

def associate_eip_to_vlan(
    self,
    *,
    environmentId: str,
    vlanName: str,
    allocationId: str,
    clientToken: str = ...,
) -> AssociateEipToVlanResponseTypeDef:  # (1)
    ...

1. See AssociateEipToVlanResponseTypeDef

# associate_eip_to_vlan method usage example with argument unpacking

kwargs: AssociateEipToVlanRequestTypeDef = {  # (1)
    "environmentId": ...,
    "vlanName": ...,
    "allocationId": ...,
}

parent.associate_eip_to_vlan(**kwargs)

1. See AssociateEipToVlanRequestTypeDef

create_entitlement

Creates a Windows Server License entitlement for virtual machines in an Amazon EVS environment using the provided vCenter Server connector.

Type annotations and code completion for boto3.client("evs").create_entitlement method. boto3 documentation

# create_entitlement method definition

def create_entitlement(
    self,
    *,
    environmentId: str,
    connectorId: str,
    entitlementType: EntitlementTypeType,  # (1)
    vmIds: Sequence[str],
    clientToken: str = ...,
) -> CreateEntitlementResponseTypeDef:  # (2)
    ...

1. See EntitlementTypeType
2. See CreateEntitlementResponseTypeDef

# create_entitlement method usage example with argument unpacking

kwargs: CreateEntitlementRequestTypeDef = {  # (1)
    "environmentId": ...,
    "connectorId": ...,
    "entitlementType": ...,
    "vmIds": ...,
}

parent.create_entitlement(**kwargs)

1. See CreateEntitlementRequestTypeDef

create_environment

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

Type annotations and code completion for boto3.client("evs").create_environment method. boto3 documentation

# create_environment method definition

def create_environment(
    self,
    *,
    vpcId: str,
    serviceAccessSubnetId: str,
    vcfVersion: VcfVersionType,  # (1)
    termsAccepted: bool,
    licenseInfo: Sequence[LicenseInfoTypeDef],  # (2)
    initialVlans: InitialVlansTypeDef,  # (3)
    hosts: Sequence[HostInfoForCreateTypeDef],  # (4)
    connectivityInfo: ConnectivityInfoUnionTypeDef,  # (5)
    vcfHostnames: VcfHostnamesTypeDef,  # (6)
    siteId: str,
    clientToken: str = ...,
    environmentName: str = ...,
    kmsKeyId: str = ...,
    tags: Mapping[str, str] = ...,
    serviceAccessSecurityGroups: ServiceAccessSecurityGroupsUnionTypeDef = ...,  # (7)
) -> CreateEnvironmentResponseTypeDef:  # (8)
    ...

1. See VcfVersionType
2. See Sequence[LicenseInfoTypeDef]
3. See InitialVlansTypeDef
4. See Sequence[HostInfoForCreateTypeDef]
5. See ConnectivityInfoUnionTypeDef
6. See VcfHostnamesTypeDef
7. See ServiceAccessSecurityGroupsUnionTypeDef
8. See CreateEnvironmentResponseTypeDef

# create_environment method usage example with argument unpacking

kwargs: CreateEnvironmentRequestTypeDef = {  # (1)
    "vpcId": ...,
    "serviceAccessSubnetId": ...,
    "vcfVersion": ...,
    "termsAccepted": ...,
    "licenseInfo": ...,
    "initialVlans": ...,
    "hosts": ...,
    "connectivityInfo": ...,
    "vcfHostnames": ...,
    "siteId": ...,
}

parent.create_environment(**kwargs)

1. See CreateEnvironmentRequestTypeDef

create_environment_connector

Creates a connector for an Amazon EVS environment.

Type annotations and code completion for boto3.client("evs").create_environment_connector method. boto3 documentation

# create_environment_connector method definition

def create_environment_connector(
    self,
    *,
    environmentId: str,
    type: ConnectorTypeType,  # (1)
    applianceFqdn: str,
    secretIdentifier: str,
    clientToken: str = ...,
) -> CreateEnvironmentConnectorResponseTypeDef:  # (2)
    ...

1. See ConnectorTypeType
2. See CreateEnvironmentConnectorResponseTypeDef

# create_environment_connector method usage example with argument unpacking

kwargs: CreateEnvironmentConnectorRequestTypeDef = {  # (1)
    "environmentId": ...,
    "type": ...,
    "applianceFqdn": ...,
    "secretIdentifier": ...,
}

parent.create_environment_connector(**kwargs)

1. See CreateEnvironmentConnectorRequestTypeDef

create_environment_host

Creates an ESX host and adds it to an Amazon EVS environment.

Type annotations and code completion for boto3.client("evs").create_environment_host method. boto3 documentation

# create_environment_host method definition

def create_environment_host(
    self,
    *,
    environmentId: str,
    host: HostInfoForCreateTypeDef,  # (1)
    clientToken: str = ...,
    esxVersion: str = ...,
) -> CreateEnvironmentHostResponseTypeDef:  # (2)
    ...

1. See HostInfoForCreateTypeDef
2. See CreateEnvironmentHostResponseTypeDef

# create_environment_host method usage example with argument unpacking

kwargs: CreateEnvironmentHostRequestTypeDef = {  # (1)
    "environmentId": ...,
    "host": ...,
}

parent.create_environment_host(**kwargs)

1. See CreateEnvironmentHostRequestTypeDef

delete_entitlement

Deletes a Windows Server License entitlement for virtual machines in an Amazon EVS environment.

Type annotations and code completion for boto3.client("evs").delete_entitlement method. boto3 documentation

# delete_entitlement method definition

def delete_entitlement(
    self,
    *,
    environmentId: str,
    connectorId: str,
    entitlementType: EntitlementTypeType,  # (1)
    vmIds: Sequence[str],
    clientToken: str = ...,
) -> DeleteEntitlementResponseTypeDef:  # (2)
    ...

1. See EntitlementTypeType
2. See DeleteEntitlementResponseTypeDef

# delete_entitlement method usage example with argument unpacking

kwargs: DeleteEntitlementRequestTypeDef = {  # (1)
    "environmentId": ...,
    "connectorId": ...,
    "entitlementType": ...,
    "vmIds": ...,
}

parent.delete_entitlement(**kwargs)

1. See DeleteEntitlementRequestTypeDef

delete_environment

Deletes an Amazon EVS environment.

Type annotations and code completion for boto3.client("evs").delete_environment method. boto3 documentation

# delete_environment method definition

def delete_environment(
    self,
    *,
    environmentId: str,
    clientToken: str = ...,
) -> DeleteEnvironmentResponseTypeDef:  # (1)
    ...

1. See DeleteEnvironmentResponseTypeDef

# delete_environment method usage example with argument unpacking

kwargs: DeleteEnvironmentRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.delete_environment(**kwargs)

1. See DeleteEnvironmentRequestTypeDef

delete_environment_connector

Deletes a connector from an Amazon EVS environment.

Type annotations and code completion for boto3.client("evs").delete_environment_connector method. boto3 documentation

# delete_environment_connector method definition

def delete_environment_connector(
    self,
    *,
    environmentId: str,
    connectorId: str,
    clientToken: str = ...,
) -> DeleteEnvironmentConnectorResponseTypeDef:  # (1)
    ...

1. See DeleteEnvironmentConnectorResponseTypeDef

# delete_environment_connector method usage example with argument unpacking

kwargs: DeleteEnvironmentConnectorRequestTypeDef = {  # (1)
    "environmentId": ...,
    "connectorId": ...,
}

parent.delete_environment_connector(**kwargs)

1. See DeleteEnvironmentConnectorRequestTypeDef

delete_environment_host

Deletes a host from an Amazon EVS environment.

Type annotations and code completion for boto3.client("evs").delete_environment_host method. boto3 documentation

# delete_environment_host method definition

def delete_environment_host(
    self,
    *,
    environmentId: str,
    hostName: str,
    clientToken: str = ...,
) -> DeleteEnvironmentHostResponseTypeDef:  # (1)
    ...

1. See DeleteEnvironmentHostResponseTypeDef

# delete_environment_host method usage example with argument unpacking

kwargs: DeleteEnvironmentHostRequestTypeDef = {  # (1)
    "environmentId": ...,
    "hostName": ...,
}

parent.delete_environment_host(**kwargs)

1. See DeleteEnvironmentHostRequestTypeDef

disassociate_eip_from_vlan

Disassociates an Elastic IP address from a public HCX VLAN.

Type annotations and code completion for boto3.client("evs").disassociate_eip_from_vlan method. boto3 documentation

# disassociate_eip_from_vlan method definition

def disassociate_eip_from_vlan(
    self,
    *,
    environmentId: str,
    vlanName: str,
    associationId: str,
    clientToken: str = ...,
) -> DisassociateEipFromVlanResponseTypeDef:  # (1)
    ...

1. See DisassociateEipFromVlanResponseTypeDef

# disassociate_eip_from_vlan method usage example with argument unpacking

kwargs: DisassociateEipFromVlanRequestTypeDef = {  # (1)
    "environmentId": ...,
    "vlanName": ...,
    "associationId": ...,
}

parent.disassociate_eip_from_vlan(**kwargs)

1. See DisassociateEipFromVlanRequestTypeDef

get_environment

Returns a description of the specified environment.

Type annotations and code completion for boto3.client("evs").get_environment method. boto3 documentation

# get_environment method definition

def get_environment(
    self,
    *,
    environmentId: str,
) -> GetEnvironmentResponseTypeDef:  # (1)
    ...

1. See GetEnvironmentResponseTypeDef

# get_environment method usage example with argument unpacking

kwargs: GetEnvironmentRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.get_environment(**kwargs)

1. See GetEnvironmentRequestTypeDef

get_versions

Returns information about VCF versions, ESX versions and EC2 instance types provided by Amazon EVS.

Type annotations and code completion for boto3.client("evs").get_versions method. boto3 documentation

# get_versions method definition

def get_versions(
    self,
) -> GetVersionsResponseTypeDef:  # (1)
    ...

1. See GetVersionsResponseTypeDef

list_environment_connectors

Lists the connectors within an environment.

Type annotations and code completion for boto3.client("evs").list_environment_connectors method. boto3 documentation

# list_environment_connectors method definition

def list_environment_connectors(
    self,
    *,
    environmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEnvironmentConnectorsResponseTypeDef:  # (1)
    ...

1. See ListEnvironmentConnectorsResponseTypeDef

# list_environment_connectors method usage example with argument unpacking

kwargs: ListEnvironmentConnectorsRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_environment_connectors(**kwargs)

1. See ListEnvironmentConnectorsRequestTypeDef

list_environment_hosts

List the hosts within an environment.

Type annotations and code completion for boto3.client("evs").list_environment_hosts method. boto3 documentation

# list_environment_hosts method definition

def list_environment_hosts(
    self,
    *,
    environmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEnvironmentHostsResponseTypeDef:  # (1)
    ...

1. See ListEnvironmentHostsResponseTypeDef

# list_environment_hosts method usage example with argument unpacking

kwargs: ListEnvironmentHostsRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_environment_hosts(**kwargs)

1. See ListEnvironmentHostsRequestTypeDef

list_environment_vlans

Lists environment VLANs that are associated with the specified environment.

Type annotations and code completion for boto3.client("evs").list_environment_vlans method. boto3 documentation

# list_environment_vlans method definition

def list_environment_vlans(
    self,
    *,
    environmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEnvironmentVlansResponseTypeDef:  # (1)
    ...

1. See ListEnvironmentVlansResponseTypeDef

# list_environment_vlans method usage example with argument unpacking

kwargs: ListEnvironmentVlansRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_environment_vlans(**kwargs)

1. See ListEnvironmentVlansRequestTypeDef

list_environments

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

Type annotations and code completion for boto3.client("evs").list_environments method. boto3 documentation

# list_environments method definition

def list_environments(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    state: Sequence[EnvironmentStateType] = ...,  # (1)
) -> ListEnvironmentsResponseTypeDef:  # (2)
    ...

1. See Sequence[EnvironmentStateType]
2. See ListEnvironmentsResponseTypeDef

# list_environments method usage example with argument unpacking

kwargs: ListEnvironmentsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_environments(**kwargs)

1. See ListEnvironmentsRequestTypeDef

list_tags_for_resource

Lists the tags for an Amazon EVS resource.

Type annotations and code completion for boto3.client("evs").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_vm_entitlements

Lists the Windows Server License entitlements for virtual machines in an Amazon EVS environment.

Type annotations and code completion for boto3.client("evs").list_vm_entitlements method. boto3 documentation

# list_vm_entitlements method definition

def list_vm_entitlements(
    self,
    *,
    environmentId: str,
    connectorId: str,
    entitlementType: EntitlementTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListVmEntitlementsResponseTypeDef:  # (2)
    ...

1. See EntitlementTypeType
2. See ListVmEntitlementsResponseTypeDef

# list_vm_entitlements method usage example with argument unpacking

kwargs: ListVmEntitlementsRequestTypeDef = {  # (1)
    "environmentId": ...,
    "connectorId": ...,
    "entitlementType": ...,
}

parent.list_vm_entitlements(**kwargs)

1. See ListVmEntitlementsRequestTypeDef

tag_resource

Associates the specified tags to an Amazon EVS resource with the specified resourceArn.

Type annotations and code completion for boto3.client("evs").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Deletes specified tags from an Amazon EVS resource.

Type annotations and code completion for boto3.client("evs").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_environment_connector

Updates a connector for an Amazon EVS environment.

Type annotations and code completion for boto3.client("evs").update_environment_connector method. boto3 documentation

# update_environment_connector method definition

def update_environment_connector(
    self,
    *,
    environmentId: str,
    connectorId: str,
    clientToken: str = ...,
    applianceFqdn: str = ...,
    secretIdentifier: str = ...,
) -> UpdateEnvironmentConnectorResponseTypeDef:  # (1)
    ...

1. See UpdateEnvironmentConnectorResponseTypeDef

# update_environment_connector method usage example with argument unpacking

kwargs: UpdateEnvironmentConnectorRequestTypeDef = {  # (1)
    "environmentId": ...,
    "connectorId": ...,
}

parent.update_environment_connector(**kwargs)

1. See UpdateEnvironmentConnectorRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("evs").get_paginator method with overloads.

• client.get_paginator("list_environment_connectors") -> ListEnvironmentConnectorsPaginator
• client.get_paginator("list_environment_hosts") -> ListEnvironmentHostsPaginator
• client.get_paginator("list_environment_vlans") -> ListEnvironmentVlansPaginator
• client.get_paginator("list_environments") -> ListEnvironmentsPaginator
• client.get_paginator("list_vm_entitlements") -> ListVmEntitlementsPaginator