Skip to content

list_domains

list_domains(
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    next_token: Optional[token] = None,
    max_results: Optional[maxSize100] = None,
) -> ListDomainsResponse

Returns a list of all the domains for an AWS account that have been created.

Parameters:

  • next_token (Optional[token], default: None ) –

    The pagination token from the previous ListDomain API call.

  • max_results (Optional[maxSize100], default: None ) –

    The maximum number of objects returned per page.

Raises:

Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py
def list_domains(
    self,
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    next_token: Optional["capo_customer_profiles.types.token.token"] = None,
    max_results: Optional[
        "capo_customer_profiles.types.max_size100.maxSize100"
    ] = None,
) -> "capo_customer_profiles.types.list_domains_response.ListDomainsResponse":
    """<p>Returns a list of all the domains for an AWS account that have been created.</p>

    Args:
        next_token: <p>The pagination token from the previous ListDomain API call.</p>
        max_results: <p>The maximum number of objects returned per page.</p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_customer_profiles.types.list_domains_request.ListDomainsRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.list_domains_response.ListDomainsResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.list_domains

        output, http_response = (
            capo_customer_profiles._operations.customer_profiles_20200815.list_domains.list_domains(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDomains")
    )
    input_: capo_customer_profiles.types.list_domains_request.ListDomainsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output