SecurityAgent / Client / update_target_domain

update_target_domain

SecurityAgent.Client.update_target_domain(**kwargs)

Updates a target domain record

See also: AWS API Documentation

Request Syntax

response = client.update_target_domain(
    targetDomainId='string',
    verificationMethod='DNS_TXT'|'HTTP_ROUTE'
)
Parameters:
  • targetDomainId (string) –

    [REQUIRED]

    Unique identifier of the target domain to update

  • verificationMethod (string) –

    [REQUIRED]

    Verification method for the target domain

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 UpdateTargetDomain operation

    • targetDomainId (string) –

      Unique identifier of the target domain

    • domainName (string) –

      Name of the 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