Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateEnvironmentConnector

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

Request Syntax


{
   "applianceFqdn": "string",
   "clientToken": "string",
   "environmentId": "string",
   "secretIdentifier": "string",
   "type": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

applianceFqdn

The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: [a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*

Required: Yes

environmentId

A unique ID for the environment to create the connector in.

Type: String

Pattern: (env-[a-zA-Z0-9]{10})

Required: Yes

secretIdentifier

The ARN or name of the AWS Secrets Manager secret that stores the credentials for the VCF appliance.

Important

Do not use credentials with Administrator privileges. We recommend using a service account with the minimum required permissions.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: (arn:aws:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@!-]+|[a-zA-Z0-9/_+=.@!-]+)

Required: Yes

type

The type of connector to create.

Type: String

Valid Values: VCENTER

Required: Yes

clientToken

Note

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [!-~]+

Required: No

Response Syntax


{
   "connector": { 
      "applianceFqdn": "string",
      "checks": [ 
         { 
            "impairedSince": number,
            "lastCheckAttempt": number,
            "result": "string",
            "type": "string"
         }
      ],
      "connectorId": "string",
      "createdAt": number,
      "environmentId": "string",
      "modifiedAt": number,
      "secretArn": "string",
      "state": "string",
      "stateDetails": "string",
      "status": "string",
      "type": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connector

A description of the created connector.

Type: Connector object

Errors

For information about the errors that are common to all actions, see Common Error Types.

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.

message: Describes the error encountered.
resourceId: The ID of the resource that could not be found.
resourceType: The type of the resource that is associated with the error.

HTTP Status Code: 400

ThrottlingException

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.

message: Describes the error encountered.
retryAfterSeconds: The seconds to wait to retry.

HTTP Status Code: 400

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.

fieldList: A list of fields that didn't validate.
message: Describes the error encountered.
reason: The reason for the exception.

HTTP Status Code: 400