SecurityAgent / Client / list_target_domains

list_target_domains¶

SecurityAgent.Client.list_target_domains(**kwargs)¶

Returns a paginated list of target domain summaries in your account.

Request Syntax

response = client.list_target_domains(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.
maxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'targetDomainSummaries': [
        {
            'targetDomainId': 'string',
            'domainName': 'string',
            'verificationStatus': 'PENDING'|'VERIFIED'|'FAILED'|'UNREACHABLE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Output for the ListTargetDomains operation.
- targetDomainSummaries (list) –
  
  The list of target domain summaries.
  - (dict) –
    
    Contains summary information about a target domain.
    - targetDomainId (string) –
      
      The unique identifier of the target domain.
    - domainName (string) –
      
      The domain name of the target domain.
    - verificationStatus (string) –
      
      The current verification status of the target domain.
- nextToken (string) –
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.