SecurityAgent / Client / batch_get_target_domains

batch_get_target_domains

SecurityAgent.Client.batch_get_target_domains(**kwargs)

Retrieves multiple target domains in a single request

See also: AWS API Documentation

Request Syntax

response = client.batch_get_target_domains(
    targetDomainIds=[
        'string',
    ]
)

Parameters:

targetDomainIds (list) –

[REQUIRED]

List of target domain IDs to retrieve

• (string) –

Return type:

dict

Returns:

Response Syntax

{
    'targetDomains': [
        {
            '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)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

• (dict) –

  Output for the BatchGetTargetDomains operation

  • targetDomains (list) –

    List of target domains that were successfully retrieved

    • (dict) –

      Represents a target domain

      • targetDomainId (string) –

        Unique identifier of the target domain

      • domainName (string) –

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

  • notFound (list) –

    List of target domain IDs that could not be found

    • (string) –