Skip to content

list_domain_names

list_domain_names(
    *,
    config_overrides: Optional[AppSyncClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListDomainNamesResponse

Lists multiple custom domain names.

Parameters:

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

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

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

    The maximum number of results that you want the request to return.

Raises:

  • AccessDeniedException –

    You don't have access to perform this operation on this resource.

  • BadRequestException –

    The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

  • InternalFailureException –

    An internal AppSync error occurred. Try your request again.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_appsync/_services/app_sync.py
def list_domain_names(
    self,
    *,
    config_overrides: Optional[AppSyncClientConfig] = None,
    next_token: Optional[
        "capo_appsync.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_appsync.types.max_results.MaxResults"] = None,
) -> "capo_appsync.types.list_domain_names_response.ListDomainNamesResponse":
    """<p>Lists multiple custom domain names.</p>

    Args:
        next_token: <p>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</p>
        max_results: <p>The maximum number of results that you want the request to return.</p>

    Raises:
        capo_appsync.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to perform this operation on this resource.</p>
        capo_appsync.errors.bad_request_exception.BadRequestException: <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.</p>
        capo_appsync.errors.internal_failure_exception.InternalFailureException: <p>An internal AppSync error occurred. Try your request again.</p>
        capo_appsync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appsync.types.list_domain_names_request.ListDomainNamesRequest]",
    ) -> OperationResponse[
        "capo_appsync.types.list_domain_names_response.ListDomainNamesResponse"
    ]:
        import capo_appsync._operations.aws_deepdish_control_plane_service.list_domain_names

        output, http_response = (
            capo_appsync._operations.aws_deepdish_control_plane_service.list_domain_names.list_domain_names(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDomainNames")
    )
    input_: capo_appsync.types.list_domain_names_request.ListDomainNamesRequest = {}
    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