SecurityAgent / Client / create_target_domain

create_target_domain

SecurityAgent.Client.create_target_domain(**kwargs)

Creates a target domain record

See also: AWS API Documentation

Request Syntax

response = client.create_target_domain(
    targetDomainName='string',
    verificationMethod='DNS_TXT'|'HTTP_ROUTE',
    tags={
        'string': 'string'
    }
)

Parameters:

• targetDomainName (string) –

  [REQUIRED]

  Domain name of the target domain

• verificationMethod (string) –

  [REQUIRED]

  Verification method for the target domain

• tags (dict) –

  Tags to associate with the target domain

  • (string) –

    Key for a resource tag

    • (string) –

      Value for a resource tag

Return type:

dict

Returns:

Response Syntax

{
    'targetDomainId': 'string',
    'domainName': 'string',
    'verificationStatus': 'PENDING'|'VERIFIED'|'FAILED'|'UNREACHABLE',
    'verificationDetails': {
        'method': 'DNS_TXT'|'HTTP_ROUTE',
        'dnsTxt': {
            'token': 'string',
            'dnsRecordName': 'string',
            'dnsRecordType': 'TXT'
        },
        'httpRoute': {
            'token': 'string',
            'routePath': 'string'
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'verifiedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  Output for the CreateTargetDomain operation

  • targetDomainId (string) –

    Unique identifier of the created target domain

  • domainName (string) –

    Name of the created target domain

  • verificationStatus (string) –

    Current verification status of the registered target domain

  • verificationDetails (dict) –

    Verification details to verify registered target domain

    • method (string) –

      Type of domain ownership verification method

    • dnsTxt (dict) –

      Represents dns txt verification details

      • token (string) –

        Token used to verify domain ownership

      • dnsRecordName (string) –

        Record name to be added in DNS for target domain

      • dnsRecordType (string) –

        Type of record to be added in DNS for target domain

    • httpRoute (dict) –

      Represents http route verification details

      • token (string) –

        Token used to verify domain ownership

      • routePath (string) –

        Route path where verification token should be placed

  • createdAt (datetime) –

    Timestamp when the target domain was registered

  • verifiedAt (datetime) –

    Timestamp when the target domain was last successfully verified