Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.
", "idempotent":true }, "CreateEntitlement":{ "name":"CreateEntitlement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEntitlementRequest"}, "output":{"shape":"CreateEntitlementResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "idempotent":true }, "CreateEnvironment":{ "name":"CreateEnvironment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEnvironmentRequest"}, "output":{"shape":"CreateEnvironmentResponse"}, "errors":[ {"shape":"ValidationException"} ], "documentation":"Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.
When you specify SELF_DEPLOYED for vcfVersion, Amazon EVS provisions only the VLAN subnets; no hosts are added and no VCF installation is performed. After the environment is created, you can add hosts with CreateEnvironmentHost and install VCF yourself. The licenseInfo, hosts, vcfHostnames, siteId, and connectivityInfo parameters are not supported in this mode.
When you specify any other VCF version, Amazon EVS installs and configures VCF for you. For more information, see Self-deployed mode in the Amazon EVS User Guide.
When Amazon EVS installs VCF, the default ESX version for the selected VCF version will be used. After a host is added with a specific ESX version, it can only be upgraded using vCenter Lifecycle Manager.
You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.
Creates a connector for an Amazon EVS environment. A connector allows the Amazon EVS control plane to interface with VCF appliances using a fully qualified domain name.
You can create only one connector of each type per environment. For environments where Amazon EVS installs VCF, the SDDC_MANAGER connector is created automatically.
Amazon EVS requires an active connector to SDDC Manager or VCF Operations Manager to monitor environment health and license compliance.
Creates an ESX host and adds it to an Amazon EVS environment.
This action can only be used after the Amazon EVS environment is deployed.
You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESX host creation.
You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.
If you don't specify an ESX version when adding hosts using CreateEnvironmentHost action, Amazon EVS automatically uses the default ESX version for your environment's VCF version. To find the available ESX versions for a particular VCF version, use the GetVersions action.
You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.
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.
", "idempotent":true }, "DeleteEnvironment":{ "name":"DeleteEnvironment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEnvironmentRequest"}, "output":{"shape":"DeleteEnvironmentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes an Amazon EVS environment.
Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.
Environment deletion also deletes the associated Amazon EVS VLAN subnets and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create are not deleted. These resources may continue to incur costs.
", "idempotent":true }, "DeleteEnvironmentConnector":{ "name":"DeleteEnvironmentConnector", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEnvironmentConnectorRequest"}, "output":{"shape":"DeleteEnvironmentConnectorResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes a connector from an Amazon EVS environment.
Before deleting a connector, you must remove all entitlements that are associated with the same vCenter.
Deletes a host from an Amazon EVS environment.
Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.
Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.
", "idempotent":true }, "GetDepotUrl":{ "name":"GetDepotUrl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDepotUrlRequest"}, "output":{"shape":"GetDepotUrlResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a URL and authentication token for accessing the Amazon EVS Custom Addon depot. Configure the depot URL as a download source in vSphere Lifecycle Manager (vLCM) to sync and install the Amazon EVS Custom Addon.
The depot URL remains active until you rotate the authentication token by calling this action with rotate set to true.
Returns a description of the specified environment.
", "readonly":true }, "GetVersions":{ "name":"GetVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetVersionsRequest"}, "output":{"shape":"GetVersionsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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.
", "readonly":true }, "ListEnvironmentConnectors":{ "name":"ListEnvironmentConnectors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEnvironmentConnectorsRequest"}, "output":{"shape":"ListEnvironmentConnectorsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Lists the connectors within an environment. Returns the status of each connector and its applicable checks, among other connector details.
", "readonly":true }, "ListEnvironmentHosts":{ "name":"ListEnvironmentHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEnvironmentHostsRequest"}, "output":{"shape":"ListEnvironmentHostsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"List the hosts within an environment.
", "readonly":true }, "ListEnvironmentVlans":{ "name":"ListEnvironmentVlans", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEnvironmentVlansRequest"}, "output":{"shape":"ListEnvironmentVlansResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Lists environment VLANs that are associated with the specified environment.
", "readonly":true }, "ListEnvironments":{ "name":"ListEnvironments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEnvironmentsRequest"}, "output":{"shape":"ListEnvironmentsResponse"}, "errors":[ {"shape":"ValidationException"} ], "documentation":"Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.
", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Lists the tags for an Amazon EVS resource.
", "readonly":true }, "ListVmEntitlements":{ "name":"ListVmEntitlements", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListVmEntitlementsRequest"}, "output":{"shape":"ListVmEntitlementsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "readonly":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyTagsException"}, {"shape":"TagPolicyException"} ], "documentation":"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.
Deletes specified tags from an Amazon EVS resource.
", "idempotent":true }, "UpdateEnvironmentConnector":{ "name":"UpdateEnvironmentConnector", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateEnvironmentConnectorRequest"}, "output":{"shape":"UpdateEnvironmentConnectorResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
You cannot update both the secret and the FQDN in the same request.
This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment containing the VLAN that the Elastic IP address associates with.
" }, "vlanName":{ "shape":"AssociateEipToVlanRequestVlanNameString", "documentation":"The name of the VLAN. hcx is the only accepted VLAN name at this time.
The Elastic IP address allocation ID.
" } } }, "AssociateEipToVlanRequestVlanNameString":{ "type":"string", "max":200, "min":1 }, "AssociateEipToVlanResponse":{ "type":"structure", "members":{ "vlan":{"shape":"Vlan"} } }, "AssociationId":{ "type":"string", "max":26, "min":9, "pattern":"eipassoc-[a-zA-Z0-9_-]+" }, "Boolean":{ "type":"boolean", "box":true }, "Check":{ "type":"structure", "members":{ "type":{ "shape":"CheckType", "documentation":"The check type. Amazon EVS performs the following checks:
KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment.
KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts.
REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager.
HOST_COUNT: Verifies that the environment meets the minimum host count.
VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector.
VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server.
VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server.
OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector.
SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector.
SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements.
SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts.
SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment.
CONNECTOR_HEALTH: Aggregate health across all connectors in the environment.
A unique ID for the check.
" }, "result":{ "shape":"CheckResult", "documentation":"The check result.
" }, "impairedSince":{ "shape":"Timestamp", "documentation":"The time when environment health began to be impaired.
" } }, "documentation":"A check on the environment to identify environment health and validate VMware VCF licensing compliance.
" }, "CheckResult":{ "type":"string", "enum":[ "PASSED", "FAILED", "UNKNOWN" ] }, "CheckType":{ "type":"string", "enum":[ "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT", "OPERATIONS_MANAGER_REACHABILITY", "SDDC_MANAGER_REACHABILITY", "SDDC_MANAGER_HOST_COUNT", "SDDC_MANAGER_KEY_COVERAGE", "SDDC_MANAGER_KEY_REUSE", "CONNECTOR_HEALTH" ] }, "ChecksList":{ "type":"list", "member":{"shape":"Check"} }, "Cidr":{ "type":"string", "pattern":"((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[1-2][0-9]|[0-9])" }, "ClientToken":{ "type":"string", "max":100, "min":1, "pattern":"[!-~]+" }, "ConnectivityInfo":{ "type":"structure", "required":["privateRouteServerPeerings"], "members":{ "privateRouteServerPeerings":{ "shape":"RouteServerPeeringList", "documentation":"The unique IDs for private route server peers.
" } }, "documentation":"The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.
Not supported when vcfVersion is SELF_DEPLOYED.
The unique ID of the environment that the connector belongs to.
" }, "connectorId":{ "shape":"ConnectorId", "documentation":"The unique ID of the connector.
" }, "type":{ "shape":"ConnectorType", "documentation":"The type of the connector.
" }, "applianceFqdn":{ "shape":"ApplianceFqdn", "documentation":"The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
" }, "secretArn":{ "shape":"SecretIdentifier", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.
" }, "state":{ "shape":"ConnectorState", "documentation":"The state of the connector.
" }, "stateDetails":{ "shape":"StateDetails", "documentation":"A detailed description of the connector state.
" }, "status":{ "shape":"CheckResult", "documentation":"The status of the connector.
" }, "checks":{ "shape":"ConnectorsChecksList", "documentation":"A list of checks that are run on the connector.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time that the connector was created.
" }, "modifiedAt":{ "shape":"Timestamp", "documentation":"The date and time that the connector was modified.
" } }, "documentation":"An object that represents a connector for an Amazon EVS environment. A connector establishes a connection to the given appliance type using the credentials stored in Amazon Web Services Secrets Manager.
" }, "ConnectorCheck":{ "type":"structure", "members":{ "type":{ "shape":"CheckType", "documentation":"The check type.
" }, "result":{ "shape":"CheckResult", "documentation":"The check result.
" }, "lastCheckAttempt":{ "shape":"Timestamp", "documentation":"The date and time of the last check attempt.
" }, "impairedSince":{ "shape":"Timestamp", "documentation":"The time when connector health began to be impaired.
" } }, "documentation":"A check on a connector to identify connectivity health.
" }, "ConnectorId":{ "type":"string", "pattern":"(cnctr-[a-zA-Z0-9]{10})" }, "ConnectorList":{ "type":"list", "member":{"shape":"Connector"} }, "ConnectorState":{ "type":"string", "enum":[ "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED" ] }, "ConnectorType":{ "type":"string", "enum":[ "OPERATIONS_MANAGER", "SDDC_MANAGER", "VCENTER" ] }, "ConnectorsChecksList":{ "type":"list", "member":{"shape":"ConnectorCheck"} }, "CreateEntitlementRequest":{ "type":"structure", "required":[ "environmentId", "connectorId", "entitlementType", "vmIds" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the entitlement creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment to create the entitlement in.
" }, "connectorId":{ "shape":"ConnectorId", "documentation":"A unique ID for the connector associated with the entitlement.
" }, "entitlementType":{ "shape":"EntitlementType", "documentation":"The type of entitlement to create.
" }, "vmIds":{ "shape":"VmIdList", "documentation":"The list of VMware vSphere virtual machine managed object IDs to create entitlements for.
" } } }, "CreateEntitlementResponse":{ "type":"structure", "members":{ "entitlements":{ "shape":"VmEntitlementList", "documentation":"A list of the created entitlements.
" } } }, "CreateEnvironmentConnectorRequest":{ "type":"structure", "required":[ "environmentId", "type", "applianceFqdn", "secretIdentifier" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment to create the connector in.
" }, "type":{ "shape":"ConnectorType", "documentation":"The type of connector to create.
OPERATIONS_MANAGER: Connector to an Operations Manager appliance. Required for VCF 9x environments.
SDDC_MANAGER: Connector to an SDDC Manager appliance. Required for VCF 5.x environments.
VCENTER: Connector to a vCenter Server appliance. Required for features that depend on vCenter, such as Windows Server license-included.
The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.
" }, "secretIdentifier":{ "shape":"SecretIdentifier", "documentation":"The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. SDDC_MANAGER requires an apiKey field; OPERATIONS_MANAGER and VCENTER require username and password fields.
Do not use credentials with Administrator privileges. We recommend using a service account with read-only permissions.
A description of the created connector.
" } } }, "CreateEnvironmentHostRequest":{ "type":"structure", "required":[ "environmentId", "host" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the host creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment that the host is added to.
" }, "host":{ "shape":"HostInfoForCreate", "documentation":"The host that is created and added to the environment.
" }, "esxVersion":{ "shape":"EsxVersion", "documentation":"The ESX version to use for the host.
" } } }, "CreateEnvironmentHostResponse":{ "type":"structure", "members":{ "environmentSummary":{ "shape":"EnvironmentSummary", "documentation":"A summary of the environment that the host is created in.
" }, "host":{ "shape":"Host", "documentation":"A description of the created host.
" } } }, "CreateEnvironmentRequest":{ "type":"structure", "required":[ "vpcId", "serviceAccessSubnetId", "vcfVersion", "termsAccepted", "initialVlans" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentName":{ "shape":"EnvironmentName", "documentation":"The name to give to your environment. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character, and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the environment in.
" }, "kmsKeyId":{ "shape":"String", "documentation":"A unique ID for the customer-managed KMS key that is used to encrypt the VCF credential pairs for SDDC Manager, NSX Manager, and vCenter appliances. These credentials are stored in Amazon Web Services Secrets Manager.
" }, "tags":{ "shape":"RequestTagMap", "documentation":"Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
" }, "serviceAccessSecurityGroups":{ "shape":"ServiceAccessSecurityGroups", "documentation":"The security group that controls communication between the Amazon EVS control plane and VPC. The default security group is used if a custom security group isn't specified.
The security group should allow access to the following.
TCP/UDP access to the DNS servers
HTTPS/SSH access to the host management VLAN subnet
HTTPS/SSH access to the Management VM VLAN subnet
You should avoid modifying the security group rules after deployment, as this can break the persistent connection between the Amazon EVS control plane and VPC. This can cause future environment actions like adding or removing hosts to fail.
" }, "vpcId":{ "shape":"VpcId", "documentation":"A unique ID for the VPC that the environment is deployed inside.
Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.
The VPC that you specify must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts. The VPC cannot be used with any other deployed Amazon EVS environment. Amazon EVS does not provide multi-VPC support for environments at this time.
Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations.
Ensure that you specify a VPC that is adequately sized to accommodate the Amazon EVS subnets.
The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. The Amazon EVS control plane uses this subnet to interface with your environment. This includes validating DNS records and enabling Amazon EVS Connectors.
" }, "vcfVersion":{ "shape":"VcfVersion", "documentation":"The VCF version to use for the environment.
SELF_DEPLOYED: You install VCF yourself. The licenseInfo, hosts, vcfHostnames, siteId, and connectivityInfo parameters are not supported.
Any other valid value: Amazon EVS installs and configures VCF for you in the version you specify.
Confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.
" }, "initialVlans":{ "shape":"InitialVlans", "documentation":"The initial VLAN subnets for the Amazon EVS environment.
For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.
The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX edges over the NSX uplink subnet, providing BGP-based dynamic routing for overlay networks.
Not supported when vcfVersion is SELF_DEPLOYED.
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type.
For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide.
VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.
VCF license information can be retrieved from the Broadcom portal.
Not supported when vcfVersion is SELF_DEPLOYED.
The ESX hosts to add to the environment. For each host, provide the desired hostname, EC2 SSH keypair name, and EC2 instance type. Optionally, provide a partition or cluster placement group, or use Amazon EC2 Dedicated Hosts.
Not supported when vcfVersion is SELF_DEPLOYED. In that case, you can add hosts using CreateEnvironmentHost after the environment is created.
The DNS hostnames for the virtual machines that host the VCF management appliances. Provide hostnames for vCenter, NSX Manager, SDDC Manager, and Cloud Builder.
Not supported when vcfVersion is SELF_DEPLOYED.
The Broadcom Site ID that is allocated to you as part of your electronic software delivery. This ID allows customer access to the Broadcom portal, and is provided to you by Broadcom at the close of your software contract or contract renewal. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.
Not supported when vcfVersion is SELF_DEPLOYED.
A description of the created environment.
" } } }, "DedicatedHostId":{ "type":"string", "max":25, "min":1, "pattern":"h-[a-f0-9]{8}([a-f0-9]{9})?" }, "DeleteEntitlementRequest":{ "type":"structure", "required":[ "environmentId", "connectorId", "entitlementType", "vmIds" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the entitlement deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment that the entitlement belongs to.
" }, "connectorId":{ "shape":"ConnectorId", "documentation":"A unique ID for the connector associated with the entitlement.
" }, "entitlementType":{ "shape":"EntitlementType", "documentation":"The type of entitlement to delete.
" }, "vmIds":{ "shape":"VmIdList", "documentation":"The list of VMware vSphere virtual machine managed object IDs to delete entitlements for.
" } } }, "DeleteEntitlementResponse":{ "type":"structure", "members":{ "entitlements":{ "shape":"VmEntitlementList", "documentation":"A list of the deleted entitlements.
" } } }, "DeleteEnvironmentConnectorRequest":{ "type":"structure", "required":[ "environmentId", "connectorId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment that the connector belongs to.
" }, "connectorId":{ "shape":"ConnectorId", "documentation":"A unique ID for the connector to be deleted.
" } } }, "DeleteEnvironmentConnectorResponse":{ "type":"structure", "members":{ "connector":{ "shape":"Connector", "documentation":"A description of the deleted connector.
" }, "environmentSummary":{ "shape":"EnvironmentSummary", "documentation":"A summary of the environment that the connector was deleted from.
" } } }, "DeleteEnvironmentHostRequest":{ "type":"structure", "required":[ "environmentId", "hostName" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the host deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the host's environment.
" }, "hostName":{ "shape":"HostName", "documentation":"The DNS hostname associated with the host to be deleted.
" } } }, "DeleteEnvironmentHostResponse":{ "type":"structure", "members":{ "environmentSummary":{ "shape":"EnvironmentSummary", "documentation":"A summary of the environment that the host was deleted from.
" }, "host":{ "shape":"Host", "documentation":"A description of the deleted host.
" } } }, "DeleteEnvironmentRequest":{ "type":"structure", "required":["environmentId"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID associated with the environment to be deleted.
" } } }, "DeleteEnvironmentResponse":{ "type":"structure", "members":{ "environment":{ "shape":"Environment", "documentation":"A description of the deleted environment.
" } } }, "DisassociateEipFromVlanRequest":{ "type":"structure", "required":[ "environmentId", "vlanName", "associationId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment containing the VLAN that the Elastic IP address disassociates from.
" }, "vlanName":{ "shape":"DisassociateEipFromVlanRequestVlanNameString", "documentation":"The name of the VLAN. hcx is the only accepted VLAN name at this time.
A unique ID for the Elastic IP address association.
" } } }, "DisassociateEipFromVlanRequestVlanNameString":{ "type":"string", "max":200, "min":1 }, "DisassociateEipFromVlanResponse":{ "type":"structure", "members":{ "vlan":{"shape":"Vlan"} } }, "EipAssociation":{ "type":"structure", "members":{ "associationId":{ "shape":"AssociationId", "documentation":"A unique ID for the elastic IP address association with the VLAN subnet.
" }, "allocationId":{ "shape":"AllocationId", "documentation":"The Elastic IP address allocation ID.
" }, "ipAddress":{ "shape":"IpAddress", "documentation":"The Elastic IP address.
" } }, "documentation":"An Elastic IP address association with the elastic network interface in the VLAN subnet.
" }, "EipAssociationList":{ "type":"list", "member":{"shape":"EipAssociation"} }, "EntitlementStatus":{ "type":"string", "enum":[ "CREATING", "CREATED", "DELETED", "AT_RISK", "ENTITLEMENT_REMOVED", "CREATE_FAILED" ] }, "EntitlementType":{ "type":"string", "enum":["WINDOWS_SERVER"] }, "Environment":{ "type":"structure", "members":{ "environmentId":{ "shape":"EnvironmentId", "documentation":"The unique ID for the environment.
" }, "environmentState":{ "shape":"EnvironmentState", "documentation":"The state of an environment.
" }, "stateDetails":{ "shape":"StateDetails", "documentation":"A detailed description of the environmentState of an environment.
The date and time that the environment was created.
" }, "modifiedAt":{ "shape":"Timestamp", "documentation":"The date and time that the environment was modified.
" }, "environmentArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) that is associated with the environment.
" }, "environmentName":{ "shape":"EnvironmentName", "documentation":"The name of the environment.
" }, "vpcId":{ "shape":"VpcId", "documentation":"The VPC associated with the environment.
" }, "serviceAccessSubnetId":{ "shape":"SubnetId", "documentation":"The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.
" }, "vcfVersion":{ "shape":"VcfVersion", "documentation":"The VCF version of the environment.
" }, "termsAccepted":{ "shape":"Boolean", "documentation":"Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.
" }, "licenseInfo":{ "shape":"LicenseInfoList", "documentation":"The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type.
For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide.
" }, "siteId":{ "shape":"String", "documentation":"The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.
" }, "environmentStatus":{ "shape":"CheckResult", "documentation":"Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
" }, "checks":{ "shape":"ChecksList", "documentation":"A check on the environment to identify connector health.
" }, "connectivityInfo":{ "shape":"ConnectivityInfo", "documentation":"The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.
" }, "vcfHostnames":{ "shape":"VcfHostnames", "documentation":"The DNS hostnames to be used by the VCF management appliances in your environment.
For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.
" }, "kmsKeyId":{ "shape":"String", "documentation":"The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key aws/secretsmanager. You can also specify a customer managed key.
The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.
" }, "credentials":{ "shape":"SecretList", "documentation":"The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.
Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
" } }, "documentation":"An object that represents an Amazon EVS environment.
" }, "EnvironmentId":{ "type":"string", "pattern":"(env-[a-zA-Z0-9]{10})" }, "EnvironmentName":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "EnvironmentState":{ "type":"string", "enum":[ "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED" ] }, "EnvironmentStateList":{ "type":"list", "member":{"shape":"EnvironmentState"} }, "EnvironmentSummary":{ "type":"structure", "members":{ "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment.
" }, "environmentName":{ "shape":"EnvironmentName", "documentation":"The name of the environment.
" }, "vcfVersion":{ "shape":"VcfVersion", "documentation":"The VCF version of the environment.
" }, "environmentStatus":{ "shape":"CheckResult", "documentation":"Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
" }, "environmentState":{ "shape":"EnvironmentState", "documentation":"The state of an environment.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time that the environment was created.
" }, "modifiedAt":{ "shape":"Timestamp", "documentation":"The date and time that the environment was modified.
" }, "environmentArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) that is associated with the environment.
" } }, "documentation":"A list of environments with summarized environment details.
" }, "EnvironmentSummaryList":{ "type":"list", "member":{"shape":"EnvironmentSummary"} }, "ErrorDetail":{ "type":"structure", "required":[ "errorCode", "errorMessage" ], "members":{ "errorCode":{ "shape":"String", "documentation":"The error code.
" }, "errorMessage":{ "shape":"String", "documentation":"The error message.
" } }, "documentation":"An object that contains error details for an entitlement.
" }, "EsxVersion":{ "type":"string", "max":128, "min":0 }, "EsxVersionList":{ "type":"list", "member":{"shape":"String"} }, "GetDepotUrlRequest":{ "type":"structure", "required":["environmentId"], "members":{ "environmentId":{ "shape":"EnvironmentId", "documentation":"The unique ID of the Amazon EVS environment to get the depot URL for.
" }, "rotate":{ "shape":"Boolean", "documentation":"Revokes the current authentication token and returns a new depot URL with a new token. Previously issued depot URLs will stop working within 5 minutes of rotation.
" } } }, "GetDepotUrlResponse":{ "type":"structure", "required":[ "depotUrl", "token" ], "members":{ "depotUrl":{ "shape":"String", "documentation":"The URL for accessing the Amazon EVS Custom Addon depot. This URL includes the authentication token as a path component.
" }, "token":{ "shape":"String", "documentation":"The authentication token for depot access. This token is included in the depot URL and is used to authenticate requests.
" } } }, "GetEnvironmentRequest":{ "type":"structure", "required":["environmentId"], "members":{ "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment.
" } } }, "GetEnvironmentResponse":{ "type":"structure", "members":{ "environment":{ "shape":"Environment", "documentation":"A description of the requested environment.
" } } }, "GetVersionsRequest":{ "type":"structure", "members":{} }, "GetVersionsResponse":{ "type":"structure", "required":[ "vcfVersions", "instanceTypeEsxVersions" ], "members":{ "vcfVersions":{ "shape":"VcfVersionList", "documentation":"A list of VCF versions with their availability status, default ESX version, and instance types.
" }, "instanceTypeEsxVersions":{ "shape":"InstanceTypeEsxVersionsList", "documentation":"A list of EC2 instance types and their available ESX versions.
" } } }, "Host":{ "type":"structure", "members":{ "hostName":{ "shape":"HostName", "documentation":"The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.
" }, "ipAddress":{ "shape":"IpAddress", "documentation":"The IP address of the host.
" }, "keyName":{ "shape":"KeyName", "documentation":"The name of the SSH key that is used to access the host.
" }, "instanceType":{ "shape":"InstanceType", "documentation":"The EC2 instance type of the host.
EC2 instances created through Amazon EVS do not support associating an IAM instance profile.
The unique ID of the placement group where the host is placed.
" }, "dedicatedHostId":{ "shape":"DedicatedHostId", "documentation":"The unique ID of the Amazon EC2 Dedicated Host.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time that the host was created.
" }, "modifiedAt":{ "shape":"Timestamp", "documentation":"The date and time that the host was modified.
" }, "hostState":{ "shape":"HostState", "documentation":"The state of the host.
" }, "stateDetails":{ "shape":"StateDetails", "documentation":" A detailed description of the hostState of a host.
The unique ID of the EC2 instance that represents the host.
" }, "networkInterfaces":{ "shape":"NetworkInterfaceList", "documentation":"The elastic network interfaces that are attached to the host.
" } }, "documentation":"An ESX host that runs on an Amazon EC2 bare metal instance.
" }, "HostInfoForCreate":{ "type":"structure", "required":[ "hostName", "keyName", "instanceType" ], "members":{ "hostName":{ "shape":"HostName", "documentation":"The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.
" }, "keyName":{ "shape":"KeyName", "documentation":"The name of the SSH key that is used to access the host.
" }, "instanceType":{ "shape":"InstanceType", "documentation":"The EC2 instance type that represents the host.
" }, "placementGroupId":{ "shape":"PlacementGroupId", "documentation":"The unique ID of the placement group where the host is placed.
" }, "dedicatedHostId":{ "shape":"DedicatedHostId", "documentation":"The unique ID of the Amazon EC2 Dedicated Host.
" } }, "documentation":"An object that represents a host.
You cannot use dedicatedHostId and placementGroupId together in the same HostInfoForCreateobject. This results in a ValidationException response.
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
" } }, "documentation":"An object that represents an initial VLAN subnet for the Amazon EVS environment. Amazon EVS creates initial VLAN subnets when you first create the environment. Amazon EVS creates the following 10 VLAN subnets: host management VLAN, vMotion VLAN, vSAN VLAN, VTEP VLAN, Edge VTEP VLAN, Management VM VLAN, HCX uplink VLAN, NSX uplink VLAN, expansion VLAN 1, expansion VLAN 2.
For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.
The host VMkernel management VLAN subnet. This VLAN subnet carries traffic for managing ESX hosts and communicating with VMware vCenter Server.
" }, "vmManagement":{ "shape":"InitialVlanInfo", "documentation":"The VM management VLAN subnet. This VLAN subnet carries traffic for vSphere virtual machines.
" }, "vMotion":{ "shape":"InitialVlanInfo", "documentation":"The vMotion VLAN subnet. This VLAN subnet carries traffic for vSphere vMotion.
" }, "vSan":{ "shape":"InitialVlanInfo", "documentation":"The vSAN VLAN subnet. This VLAN subnet carries the communication between ESX hosts to implement a vSAN shared storage pool.
" }, "vTep":{ "shape":"InitialVlanInfo", "documentation":"The VTEP VLAN subnet. This VLAN subnet handles internal network traffic between virtual machines within a VCF instance.
" }, "edgeVTep":{ "shape":"InitialVlanInfo", "documentation":"The edge VTEP VLAN subnet. This VLAN subnet manages traffic flowing between the internal network and external networks, including internet access and other site connections.
" }, "nsxUplink":{ "shape":"InitialVlanInfo", "documentation":"The NSX uplink VLAN subnet. This VLAN subnet allows connectivity to the NSX overlay network.
" }, "hcx":{ "shape":"InitialVlanInfo", "documentation":"The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.
If you plan to use a public HCX VLAN subnet, the following requirements must be met:
Must have a /28 netmask and be allocated from the IPAM public pool. Required for HCX internet access configuration.
The HCX public VLAN CIDR block must be added to the VPC as a secondary CIDR block.
Must have at least two Elastic IP addresses to be allocated from the public IPAM pool for HCX components.
An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.
" }, "expansionVlan2":{ "shape":"InitialVlanInfo", "documentation":"An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.
" }, "isHcxPublic":{ "shape":"Boolean", "documentation":"Determines if the HCX VLAN that Amazon EVS provisions is public or private.
" }, "hcxNetworkAclId":{ "shape":"NetworkAclId", "documentation":"A unique ID for a network access control list that the HCX VLAN uses. Required when isHcxPublic is set to true.
The initial VLAN subnets for the environment. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
" }, "InstanceType":{ "type":"string", "enum":[ "i4i.metal", "i7i.metal-24xl" ] }, "InstanceTypeEsxVersionsInfo":{ "type":"structure", "required":[ "instanceType", "esxVersions" ], "members":{ "instanceType":{ "shape":"InstanceType", "documentation":"The EC2 instance type.
" }, "esxVersions":{ "shape":"EsxVersionList", "documentation":"The list of ESX versions offered for this instance type.
" } }, "documentation":"Information about ESX versions offered for each EC2 instance type.
" }, "InstanceTypeEsxVersionsList":{ "type":"list", "member":{"shape":"InstanceTypeEsxVersionsInfo"} }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"Describes the error encountered.
" } }, "documentation":"An internal server error occurred. Retry your request.
", "exception":true, "fault":true, "retryable":{"throttling":false} }, "IpAddress":{ "type":"string", "pattern":"(\\d{1,3}\\.){3}\\d{1,3}" }, "KeyName":{ "type":"string", "max":255, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "LicenseInfo":{ "type":"structure", "required":[ "solutionKey", "vsanKey" ], "members":{ "solutionKey":{ "shape":"SolutionKey", "documentation":"The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must meet the instance-type-specific minimum core requirements.
" }, "vsanKey":{ "shape":"VSanLicenseKey", "documentation":"The VSAN license key. This license unlocks vSAN features. The vSAN license key must meet the instance-type-specific minimum capacity requirements.
" } }, "documentation":"The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.
" }, "LicenseInfoList":{ "type":"list", "member":{"shape":"LicenseInfo"}, "max":1, "min":1 }, "ListEnvironmentConnectorsRequest":{ "type":"structure", "required":["environmentId"], "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
A unique ID for the environment.
" } } }, "ListEnvironmentConnectorsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
" }, "connectors":{ "shape":"ConnectorList", "documentation":"A list of connectors in the environment.
" } } }, "ListEnvironmentHostsRequest":{ "type":"structure", "required":["environmentId"], "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
A unique ID for the environment.
" } } }, "ListEnvironmentHostsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
" }, "environmentHosts":{ "shape":"HostList", "documentation":"A list of hosts in the environment.
" } } }, "ListEnvironmentVlansRequest":{ "type":"structure", "required":["environmentId"], "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
A unique ID for the environment.
" } } }, "ListEnvironmentVlansResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
" }, "environmentVlans":{ "shape":"VlanList", "documentation":"A list of VLANs that are associated with the specified environment.
" } } }, "ListEnvironmentsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
The state of an environment. Used to filter response results to return only environments with the specified environmentState.
A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
" }, "environmentSummaries":{ "shape":"EnvironmentSummaryList", "documentation":"A list of environments with summarized environment details.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) that identifies the resource to list tags for.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"ResponseTagMap", "documentation":"The tags for the resource.
" } } }, "ListVmEntitlementsRequest":{ "type":"structure", "required":[ "environmentId", "connectorId", "entitlementType" ], "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
A unique ID for the environment.
" }, "connectorId":{ "shape":"ConnectorId", "documentation":"A unique ID for the connector.
" }, "entitlementType":{ "shape":"EntitlementType", "documentation":"The type of entitlement to list.
" } } }, "ListVmEntitlementsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
" }, "entitlements":{ "shape":"VmEntitlementList", "documentation":"A list of entitlements for virtual machines in the environment.
" } } }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "NetworkAclId":{ "type":"string", "max":21, "min":4, "pattern":"acl-[a-zA-Z0-9_-]+" }, "NetworkInterface":{ "type":"structure", "members":{ "networkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"The unique ID of the elastic network interface.
" } }, "documentation":"An elastic network interface (ENI) that connects hosts to the VLAN subnets. Amazon EVS provisions two identically configured ENIs in the VMkernel management subnet during host creation. One ENI is active, and the other is in standby mode for automatic switchover during a failure scenario.
" }, "NetworkInterfaceId":{ "type":"string", "max":100, "min":1 }, "NetworkInterfaceList":{ "type":"list", "member":{"shape":"NetworkInterface"}, "max":2, "min":0 }, "PaginationToken":{"type":"string"}, "PlacementGroupId":{ "type":"string", "max":25, "min":1, "pattern":"pg-[a-f0-9]{8}([a-f0-9]{9})?" }, "RequestTagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":200, "min":1 }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{ "shape":"String", "documentation":"Describes the error encountered.
" }, "resourceId":{ "shape":"String", "documentation":"The ID of the resource that could not be found.
" }, "resourceType":{ "shape":"String", "documentation":"The type of the resource that is associated with the error.
" } }, "documentation":"A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
The Amazon Resource Name (ARN) of the secret.
" } }, "documentation":"A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager. During environment creation, the Amazon EVS control plane uses Amazon Web Services Secrets Manager to create, encrypt, validate, and store secrets. If you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment. Amazon EVS does not provide managed rotation of secrets. We recommend that you rotate secrets regularly to ensure that secrets are not long-lived.
" }, "SecretIdentifier":{ "type":"string", "max":2048, "min":1, "pattern":"(arn:aws:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@!-]+|[a-zA-Z0-9/_+=.@!-]+)" }, "SecretList":{ "type":"list", "member":{"shape":"Secret"} }, "SecurityGroupId":{ "type":"string", "max":25, "min":3, "pattern":"sg-[0-9a-zA-Z]*" }, "SecurityGroups":{ "type":"list", "member":{"shape":"SecurityGroupId"}, "max":2, "min":0 }, "ServiceAccessSecurityGroups":{ "type":"structure", "members":{ "securityGroups":{ "shape":"SecurityGroups", "documentation":"The security groups that allow service access.
" } }, "documentation":"The security groups that allow traffic between the Amazon EVS control plane and your VPC for Amazon EVS service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.
" }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"Describes the error encountered.
" } }, "documentation":"The number of one or more Amazon EVS resources exceeds the maximum allowed. For a list of Amazon EVS quotas, see Amazon EVS endpoints and quotas in the Amazon EVS User Guide. Delete some resources or request an increase in your service quota. To request an increase, see Amazon Web Services Service Quotas in the Amazon Web Services General Reference Guide.
", "exception":true }, "SolutionKey":{ "type":"string", "pattern":"[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}", "sensitive":true }, "StateDetails":{"type":"string"}, "String":{"type":"string"}, "SubnetId":{ "type":"string", "max":24, "min":15, "pattern":"subnet-[a-f0-9]{8}([a-f0-9]{9})?" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"[\\w.:/=+-@]+" }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":1 }, "TagPolicyException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"Describes the error encountered
" } }, "documentation":" TagPolicyException is deprecated. See ValidationException instead.
The request doesn't comply with IAM tag policy. Correct your request and then retry it.
", "exception":true }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource to add tags to.
" }, "tags":{ "shape":"RequestTagMap", "documentation":"Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other environment or Amazon Web Services resources.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"[\\w.:/=+-@]+|" }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"Describes the error encountered.
" }, "retryAfterSeconds":{ "shape":"Integer", "documentation":"The seconds to wait to retry.
" } }, "documentation":"The operation could not be performed because the service is throttling requests. This exception is thrown when the service endpoint receives too many concurrent requests.
", "exception":true, "retryable":{"throttling":false} }, "Timestamp":{"type":"timestamp"}, "TooManyTagsException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"Describes the error encountered.
" } }, "documentation":" TooManyTagsException is deprecated. See ServiceQuotaExceededException instead.
A service resource associated with the request has more than 200 tags.
", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource to delete tags from.
" }, "tagKeys":{ "shape":"TagKeys", "documentation":"The keys of the tags to delete.
" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateEnvironmentConnectorRequest":{ "type":"structure", "required":[ "environmentId", "connectorId" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector update request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "idempotencyToken":true }, "environmentId":{ "shape":"EnvironmentId", "documentation":"A unique ID for the environment that the connector belongs to.
" }, "connectorId":{ "shape":"ConnectorId", "documentation":"A unique ID for the connector to update.
" }, "applianceFqdn":{ "shape":"ApplianceFqdn", "documentation":"The new fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
" }, "secretIdentifier":{ "shape":"SecretIdentifier", "documentation":"The new ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.
" } } }, "UpdateEnvironmentConnectorResponse":{ "type":"structure", "members":{ "connector":{ "shape":"Connector", "documentation":"A description of the updated connector.
" } } }, "VSanLicenseKey":{ "type":"string", "pattern":"[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}", "sensitive":true }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{ "shape":"String", "documentation":"Describes the error encountered.
" }, "reason":{ "shape":"ValidationExceptionReason", "documentation":"The reason for the exception.
" }, "fieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"A list of fields that didn't validate.
" } }, "documentation":"The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
", "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"String", "documentation":"The field name.
" }, "message":{ "shape":"String", "documentation":"A message describing why the field failed validation.
" } }, "documentation":"Stores information about a field passed inside a request that resulted in an exception.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "unknownOperation", "cannotParse", "fieldValidationFailed", "other" ] }, "VcfHostnames":{ "type":"structure", "required":[ "vCenter", "nsx", "nsxManager1", "nsxManager2", "nsxManager3", "nsxEdge1", "nsxEdge2", "sddcManager", "cloudBuilder" ], "members":{ "vCenter":{ "shape":"HostName", "documentation":"The VMware vCenter hostname.
" }, "nsx":{ "shape":"HostName", "documentation":"The VMware NSX Virtual IP (VIP) hostname.
" }, "nsxManager1":{ "shape":"HostName", "documentation":"The hostname for the first VMware NSX Manager virtual machine (VM).
" }, "nsxManager2":{ "shape":"HostName", "documentation":"The hostname for the second VMware NSX Manager virtual machine (VM).
" }, "nsxManager3":{ "shape":"HostName", "documentation":"The hostname for the third VMware NSX Manager virtual machine (VM).
" }, "nsxEdge1":{ "shape":"HostName", "documentation":"The hostname for the first NSX Edge node.
" }, "nsxEdge2":{ "shape":"HostName", "documentation":"The hostname for the second NSX Edge node.
" }, "sddcManager":{ "shape":"HostName", "documentation":"The hostname for SDDC Manager.
" }, "cloudBuilder":{ "shape":"HostName", "documentation":"The hostname for VMware Cloud Builder.
" } }, "documentation":"The DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder. Each hostname must be unique, and resolve to a domain name that you've registered in your DNS service of choice. Hostnames cannot be changed.
VMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines.
Not supported when vcfVersion is SELF_DEPLOYED.
The VCF version number.
" }, "status":{ "shape":"String", "documentation":"The status for this VCF version. Valid values are:
AVAILABLE - This VCF version is available to you.
RESTRICTED - This VCF version has limited availability.
If the version you need shows RESTRICTED, and you require, check out VCF versions and EC2 instance types provided by Amazon EVS for more information.
The default ESX version for this VCF version. It is based on Broadcom's Bill Of Materials (BOM).
" }, "instanceTypes":{ "shape":"InstanceTypeList", "documentation":"EC2 instance types provided by Amazon EVS for this VCF version for creating environments.
" } }, "documentation":"Information about a VCF versions provided by Amazon EVS, including its status, default ESX version, and EC2 instance types.
" }, "VcfVersionList":{ "type":"list", "member":{"shape":"VcfVersionInfo"} }, "Vlan":{ "type":"structure", "members":{ "vlanId":{ "shape":"VlanId", "documentation":"The unique ID of the VLAN.
" }, "cidr":{ "shape":"Cidr", "documentation":"The CIDR block of the VLAN. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.
" }, "availabilityZone":{ "shape":"String", "documentation":"The availability zone of the VLAN.
" }, "functionName":{ "shape":"String", "documentation":"The VMware VCF traffic type that is carried over the VLAN. For example, a VLAN with a functionName of hcx is being used to carry VMware HCX traffic.
The unique ID of the VLAN subnet.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time that the VLAN was created.
" }, "modifiedAt":{ "shape":"Timestamp", "documentation":"The date and time that the VLAN was modified.
" }, "vlanState":{ "shape":"VlanState", "documentation":"The state of the VLAN.
" }, "stateDetails":{ "shape":"StateDetails", "documentation":"The state details of the VLAN.
" }, "eipAssociations":{ "shape":"EipAssociationList", "documentation":"An array of Elastic IP address associations.
" }, "isPublic":{ "shape":"Boolean", "documentation":"Determines if the VLAN that Amazon EVS provisions is public or private.
" }, "networkAclId":{ "shape":"NetworkAclId", "documentation":"A unique ID for a network access control list.
" } }, "documentation":"The VLANs that Amazon EVS creates during environment creation.
" }, "VlanId":{ "type":"integer", "box":true }, "VlanList":{ "type":"list", "member":{"shape":"Vlan"} }, "VlanState":{ "type":"string", "enum":[ "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED" ] }, "VmEntitlement":{ "type":"structure", "members":{ "vmId":{ "shape":"VmId", "documentation":"The unique ID of the virtual machine.
" }, "environmentId":{ "shape":"EnvironmentId", "documentation":"The unique ID of the environment.
" }, "connectorId":{ "shape":"ConnectorId", "documentation":"The unique ID of the connector associated with the entitlement.
" }, "vmName":{ "shape":"VmName", "documentation":"The name of the virtual machine.
" }, "type":{ "shape":"EntitlementType", "documentation":"The type of entitlement.
" }, "status":{ "shape":"EntitlementStatus", "documentation":"The status of the entitlement.
" }, "lastSyncedAt":{ "shape":"Timestamp", "documentation":"The date and time that the entitlement was last synced.
" }, "startedAt":{ "shape":"Timestamp", "documentation":"The date and time that the entitlement started.
" }, "stoppedAt":{ "shape":"Timestamp", "documentation":"The date and time that the entitlement stopped.
" }, "errorDetail":{ "shape":"ErrorDetail", "documentation":"The error details associated with the entitlement, if applicable.
" } }, "documentation":"An object that represents a Windows Server License entitlement for a virtual machine in an Amazon EVS environment.
" }, "VmEntitlementList":{ "type":"list", "member":{"shape":"VmEntitlement"} }, "VmId":{ "type":"string", "max":1024, "min":4, "pattern":"vm-[0-9]+" }, "VmIdList":{ "type":"list", "member":{"shape":"VmId"}, "max":100, "min":1 }, "VmName":{ "type":"string", "max":1024, "min":1 }, "VpcId":{ "type":"string", "max":21, "min":12, "pattern":"vpc-[a-f0-9]{8}([a-f0-9]{9})?" } }, "documentation":"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.
" }