CreateEnvironment

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

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

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF according to your unique requirements.

Parameter Syntax

$result = $client->createEnvironment([
    'clientToken' => '<string>',
    'connectivityInfo' => [ // REQUIRED
        'privateRouteServerPeerings' => ['<string>', ...], // REQUIRED
    ],
    'environmentName' => '<string>',
    'hosts' => [ // REQUIRED
        [
            'dedicatedHostId' => '<string>',
            'hostName' => '<string>', // REQUIRED
            'instanceType' => 'i4i.metal', // REQUIRED
            'keyName' => '<string>', // REQUIRED
            'placementGroupId' => '<string>',
        ],
        // ...
    ],
    'initialVlans' => [ // REQUIRED
        'edgeVTep' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
        'expansionVlan1' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
        'expansionVlan2' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
        'hcx' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
        'nsxUplink' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
        'vMotion' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
        'vSan' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
        'vTep' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
        'vmManagement' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
        'vmkManagement' => [ // REQUIRED
            'cidr' => '<string>', // REQUIRED
        ],
    ],
    'kmsKeyId' => '<string>',
    'licenseInfo' => [ // REQUIRED
        [
            'solutionKey' => '<string>', // REQUIRED
            'vsanKey' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'serviceAccessSecurityGroups' => [
        'securityGroups' => ['<string>', ...],
    ],
    'serviceAccessSubnetId' => '<string>', // REQUIRED
    'siteId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'termsAccepted' => true || false, // REQUIRED
    'vcfHostnames' => [ // REQUIRED
        'cloudBuilder' => '<string>', // REQUIRED
        'nsx' => '<string>', // REQUIRED
        'nsxEdge1' => '<string>', // REQUIRED
        'nsxEdge2' => '<string>', // REQUIRED
        'nsxManager1' => '<string>', // REQUIRED
        'nsxManager2' => '<string>', // REQUIRED
        'nsxManager3' => '<string>', // REQUIRED
        'sddcManager' => '<string>', // REQUIRED
        'vCenter' => '<string>', // REQUIRED
    ],
    'vcfVersion' => 'VCF-5.2.1', // REQUIRED
    'vpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environment' => [
        'checks' => [
            [
                'impairedSince' => <DateTime>,
                'result' => 'PASSED|FAILED|UNKNOWN',
                'type' => 'KEY_REUSE|KEY_COVERAGE|REACHABILITY|HOST_COUNT',
            ],
            // ...
        ],
        'connectivityInfo' => [
            'privateRouteServerPeerings' => ['<string>', ...],
        ],
        'createdAt' => <DateTime>,
        'credentials' => [
            [
                'secretArn' => '<string>',
            ],
            // ...
        ],
        'environmentArn' => '<string>',
        'environmentId' => '<string>',
        'environmentName' => '<string>',
        'environmentState' => 'CREATING|CREATED|DELETING|DELETED|CREATE_FAILED',
        'environmentStatus' => 'PASSED|FAILED|UNKNOWN',
        'kmsKeyId' => '<string>',
        'licenseInfo' => [
            [
                'solutionKey' => '<string>',
                'vsanKey' => '<string>',
            ],
            // ...
        ],
        'modifiedAt' => <DateTime>,
        'serviceAccessSecurityGroups' => [
            'securityGroups' => ['<string>', ...],
        ],
        'serviceAccessSubnetId' => '<string>',
        'siteId' => '<string>',
        'stateDetails' => '<string>',
        'termsAccepted' => true || false,
        'vcfHostnames' => [
            'cloudBuilder' => '<string>',
            'nsx' => '<string>',
            'nsxEdge1' => '<string>',
            'nsxEdge2' => '<string>',
            'nsxManager1' => '<string>',
            'nsxManager2' => '<string>',
            'nsxManager3' => '<string>',
            'sddcManager' => '<string>',
            'vCenter' => '<string>',
        ],
        'vcfVersion' => 'VCF-5.2.1',
        'vpcId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

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.

CreateEnvironmentHost

$result = $client->createEnvironmentHost([/* ... */]);
$promise = $client->createEnvironmentHostAsync([/* ... */]);

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

This action can only be used after the Amazon EVS environment is deployed. All Amazon EVS hosts are created with the latest AMI release version for the respective VCF version of the environment.

You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

Parameter Syntax

$result = $client->createEnvironmentHost([
    'clientToken' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'host' => [ // REQUIRED
        'dedicatedHostId' => '<string>',
        'hostName' => '<string>', // REQUIRED
        'instanceType' => 'i4i.metal', // REQUIRED
        'keyName' => '<string>', // REQUIRED
        'placementGroupId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'environmentSummary' => [
        'createdAt' => <DateTime>,
        'environmentArn' => '<string>',
        'environmentId' => '<string>',
        'environmentName' => '<string>',
        'environmentState' => 'CREATING|CREATED|DELETING|DELETED|CREATE_FAILED',
        'environmentStatus' => 'PASSED|FAILED|UNKNOWN',
        'modifiedAt' => <DateTime>,
        'vcfVersion' => 'VCF-5.2.1',
    ],
    'host' => [
        'createdAt' => <DateTime>,
        'dedicatedHostId' => '<string>',
        'ec2InstanceId' => '<string>',
        'hostName' => '<string>',
        'hostState' => 'CREATING|CREATED|UPDATING|DELETING|DELETED|CREATE_FAILED|UPDATE_FAILED',
        'instanceType' => 'i4i.metal',
        'ipAddress' => '<string>',
        'keyName' => '<string>',
        'modifiedAt' => <DateTime>,
        'networkInterfaces' => [
            [
                'networkInterfaceId' => '<string>',
            ],
            // ...
        ],
        'placementGroupId' => '<string>',
        'stateDetails' => '<string>',
    ],
]

Result Details

Errors

ThrottlingException:

The CreateEnvironmentHost operation couldn't be performed because the service is throttling requests. This exception is thrown when the CreateEnvironmentHost request exceeds concurrency of 1 transaction per second (TPS).

ValidationException:

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.

DeleteEnvironment

$result = $client->deleteEnvironment([/* ... */]);
$promise = $client->deleteEnvironmentAsync([/* ... */]);

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. Other associated Amazon Web Services resources are not deleted. These resources may continue to incur costs.

Parameter Syntax

$result = $client->deleteEnvironment([
    'clientToken' => '<string>',
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environment' => [
        'checks' => [
            [
                'impairedSince' => <DateTime>,
                'result' => 'PASSED|FAILED|UNKNOWN',
                'type' => 'KEY_REUSE|KEY_COVERAGE|REACHABILITY|HOST_COUNT',
            ],
            // ...
        ],
        'connectivityInfo' => [
            'privateRouteServerPeerings' => ['<string>', ...],
        ],
        'createdAt' => <DateTime>,
        'credentials' => [
            [
                'secretArn' => '<string>',
            ],
            // ...
        ],
        'environmentArn' => '<string>',
        'environmentId' => '<string>',
        'environmentName' => '<string>',
        'environmentState' => 'CREATING|CREATED|DELETING|DELETED|CREATE_FAILED',
        'environmentStatus' => 'PASSED|FAILED|UNKNOWN',
        'kmsKeyId' => '<string>',
        'licenseInfo' => [
            [
                'solutionKey' => '<string>',
                'vsanKey' => '<string>',
            ],
            // ...
        ],
        'modifiedAt' => <DateTime>,
        'serviceAccessSecurityGroups' => [
            'securityGroups' => ['<string>', ...],
        ],
        'serviceAccessSubnetId' => '<string>',
        'siteId' => '<string>',
        'stateDetails' => '<string>',
        'termsAccepted' => true || false,
        'vcfHostnames' => [
            'cloudBuilder' => '<string>',
            'nsx' => '<string>',
            'nsxEdge1' => '<string>',
            'nsxEdge2' => '<string>',
            'nsxManager1' => '<string>',
            'nsxManager2' => '<string>',
            'nsxManager3' => '<string>',
            'sddcManager' => '<string>',
            'vCenter' => '<string>',
        ],
        'vcfVersion' => 'VCF-5.2.1',
        'vpcId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

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.

ResourceNotFoundException:

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.

DeleteEnvironmentHost

$result = $client->deleteEnvironmentHost([/* ... */]);
$promise = $client->deleteEnvironmentHostAsync([/* ... */]);

Deletes a host from an Amazon EVS environment.

Parameter Syntax

$result = $client->deleteEnvironmentHost([
    'clientToken' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'hostName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentSummary' => [
        'createdAt' => <DateTime>,
        'environmentArn' => '<string>',
        'environmentId' => '<string>',
        'environmentName' => '<string>',
        'environmentState' => 'CREATING|CREATED|DELETING|DELETED|CREATE_FAILED',
        'environmentStatus' => 'PASSED|FAILED|UNKNOWN',
        'modifiedAt' => <DateTime>,
        'vcfVersion' => 'VCF-5.2.1',
    ],
    'host' => [
        'createdAt' => <DateTime>,
        'dedicatedHostId' => '<string>',
        'ec2InstanceId' => '<string>',
        'hostName' => '<string>',
        'hostState' => 'CREATING|CREATED|UPDATING|DELETING|DELETED|CREATE_FAILED|UPDATE_FAILED',
        'instanceType' => 'i4i.metal',
        'ipAddress' => '<string>',
        'keyName' => '<string>',
        'modifiedAt' => <DateTime>,
        'networkInterfaces' => [
            [
                'networkInterfaceId' => '<string>',
            ],
            // ...
        ],
        'placementGroupId' => '<string>',
        'stateDetails' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

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.

ResourceNotFoundException:

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.

GetEnvironment

$result = $client->getEnvironment([/* ... */]);
$promise = $client->getEnvironmentAsync([/* ... */]);

Returns a description of the specified environment.

Parameter Syntax

$result = $client->getEnvironment([
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environment' => [
        'checks' => [
            [
                'impairedSince' => <DateTime>,
                'result' => 'PASSED|FAILED|UNKNOWN',
                'type' => 'KEY_REUSE|KEY_COVERAGE|REACHABILITY|HOST_COUNT',
            ],
            // ...
        ],
        'connectivityInfo' => [
            'privateRouteServerPeerings' => ['<string>', ...],
        ],
        'createdAt' => <DateTime>,
        'credentials' => [
            [
                'secretArn' => '<string>',
            ],
            // ...
        ],
        'environmentArn' => '<string>',
        'environmentId' => '<string>',
        'environmentName' => '<string>',
        'environmentState' => 'CREATING|CREATED|DELETING|DELETED|CREATE_FAILED',
        'environmentStatus' => 'PASSED|FAILED|UNKNOWN',
        'kmsKeyId' => '<string>',
        'licenseInfo' => [
            [
                'solutionKey' => '<string>',
                'vsanKey' => '<string>',
            ],
            // ...
        ],
        'modifiedAt' => <DateTime>,
        'serviceAccessSecurityGroups' => [
            'securityGroups' => ['<string>', ...],
        ],
        'serviceAccessSubnetId' => '<string>',
        'siteId' => '<string>',
        'stateDetails' => '<string>',
        'termsAccepted' => true || false,
        'vcfHostnames' => [
            'cloudBuilder' => '<string>',
            'nsx' => '<string>',
            'nsxEdge1' => '<string>',
            'nsxEdge2' => '<string>',
            'nsxManager1' => '<string>',
            'nsxManager2' => '<string>',
            'nsxManager3' => '<string>',
            'sddcManager' => '<string>',
            'vCenter' => '<string>',
        ],
        'vcfVersion' => 'VCF-5.2.1',
        'vpcId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

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.

ResourceNotFoundException:

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.

ListEnvironmentHosts

$result = $client->listEnvironmentHosts([/* ... */]);
$promise = $client->listEnvironmentHostsAsync([/* ... */]);

List the hosts within an environment.

Parameter Syntax

$result = $client->listEnvironmentHosts([
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'environmentHosts' => [
        [
            'createdAt' => <DateTime>,
            'dedicatedHostId' => '<string>',
            'ec2InstanceId' => '<string>',
            'hostName' => '<string>',
            'hostState' => 'CREATING|CREATED|UPDATING|DELETING|DELETED|CREATE_FAILED|UPDATE_FAILED',
            'instanceType' => 'i4i.metal',
            'ipAddress' => '<string>',
            'keyName' => '<string>',
            'modifiedAt' => <DateTime>,
            'networkInterfaces' => [
                [
                    'networkInterfaceId' => '<string>',
                ],
                // ...
            ],
            'placementGroupId' => '<string>',
            'stateDetails' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

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.

ResourceNotFoundException:

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.

ListEnvironmentVlans

$result = $client->listEnvironmentVlans([/* ... */]);
$promise = $client->listEnvironmentVlansAsync([/* ... */]);

Lists environment VLANs that are associated with the specified environment.

Parameter Syntax

$result = $client->listEnvironmentVlans([
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'environmentVlans' => [
        [
            'availabilityZone' => '<string>',
            'cidr' => '<string>',
            'createdAt' => <DateTime>,
            'functionName' => '<string>',
            'modifiedAt' => <DateTime>,
            'stateDetails' => '<string>',
            'subnetId' => '<string>',
            'vlanId' => <integer>,
            'vlanState' => 'CREATING|CREATED|DELETING|DELETED|CREATE_FAILED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

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.

ResourceNotFoundException:

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.

ListEnvironments

$result = $client->listEnvironments([/* ... */]);
$promise = $client->listEnvironmentsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEnvironments([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'state' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'environmentSummaries' => [
        [
            'createdAt' => <DateTime>,
            'environmentArn' => '<string>',
            'environmentId' => '<string>',
            'environmentName' => '<string>',
            'environmentState' => 'CREATING|CREATED|DELETING|DELETED|CREATE_FAILED',
            'environmentStatus' => 'PASSED|FAILED|UNKNOWN',
            'modifiedAt' => <DateTime>,
            'vcfVersion' => 'VCF-5.2.1',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for an Amazon EVS resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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.

TooManyTagsException:

A service resource associated with the request has more than 200 tags.

TagPolicyException:

The request doesn't comply with IAM tag policy. Correct your request and then retry it.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes specified tags from an Amazon EVS resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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.

TagPolicyException:

The request doesn't comply with IAM tag policy. Correct your request and then retry it.