POST /#Action=CreateVerifiedAccessEndpoint

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

Servers

Request headers

Name Type Required Description
X-Amz-Content-Sha256 String No
X-Amz-Credential String No
Content-Type String Yes The media type of the request body.

Default value: "text/xml"

X-Amz-Date String No
X-Amz-Algorithm String No
X-Amz-SignedHeaders String No
X-Amz-Security-Token String No
X-Amz-Signature String No

Query parameters

Name Type Required Description
Version String Yes

Possible values:

  • "2016-11-15"
Action String Yes

Possible values:

  • "CreateVerifiedAccessEndpoint"

Request body fields

Name Type Required Description
TagSpecifications[] Array No

The tags to assign to the Amazon Web Services Verified Access endpoint.

ClientToken String No

A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

ApplicationDomain String Yes

The DNS name for users to reach your application.

EndpointType String Yes

The type of Amazon Web Services Verified Access endpoint to create.

Possible values:

  • "network-interface"
  • "load-balancer"
DomainCertificateArn String Yes

The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.

PolicyDocument String No

The Amazon Web Services Verified Access policy document.

VerifiedAccessGroupId String Yes

The ID of the Verified Access group to associate the endpoint with.

EndpointDomainPrefix String Yes

A custom identifier that gets prepended to a DNS name that is generated for the endpoint.

SecurityGroupIds[] Array No

The Amazon EC2 security groups to associate with the Amazon Web Services Verified Access endpoint.

AttachmentType String Yes

The Amazon Web Services network component Verified Access attaches to.

Possible values:

  • "vpc"
DryRun Boolean No

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Description String No

A description for the Amazon Web Services Verified Access endpoint.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.