VPCLattice / Client / start_domain_verification

start_domain_verification¶

VPCLattice.Client.start_domain_verification(**kwargs)¶

Starts the domain verification process for a custom domain name.

Request Syntax

response = client.start_domain_verification(
    clientToken='string',
    domainName='string',
    tags={
        'string': 'string'
    }
)

Parameters:

clientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.

This field is autopopulated if not provided.
domainName (string) –
[REQUIRED]

The domain name to verify ownership for.
tags (dict) –
The tags for the domain verification.
- (string) –
  
  The key of the tag.
  
  Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws:.
  - (string) –
    
    The value of the tag.
    
    Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'domainName': 'string',
    'status': 'VERIFIED'|'PENDING'|'VERIFICATION_TIMED_OUT',
    'txtMethodConfig': {
        'value': 'string',
        'name': 'string'
    }
}

Response Structure

(dict) –
- id (string) –
  
  The ID of the domain verification.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the domain verification.
- domainName (string) –
  
  The domain name being verified.
- status (string) –
  
  The current status of the domain verification process.
- txtMethodConfig (dict) –
  
  The TXT record configuration used for domain verification.
  - value (string) –
    
    The value that must be added to the TXT record for domain verification.
  - name (string) –
    
    The name of the TXT record that must be created for domain verification.

Exceptions

VPCLattice.Client.exceptions.ValidationException
VPCLattice.Client.exceptions.AccessDeniedException
VPCLattice.Client.exceptions.ConflictException
VPCLattice.Client.exceptions.ThrottlingException
VPCLattice.Client.exceptions.ServiceQuotaExceededException
VPCLattice.Client.exceptions.InternalServerException