Skip to content

describe_custom_domains async

describe_custom_domains(
    service_arn: AppRunnerResourceArn,
    *,
    config_overrides: Optional[AsyncAppRunnerClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[DescribeCustomDomainsMaxResults] = None,
) -> DescribeCustomDomainsResponse

Return a description of custom domain names that are associated with an App Runner service.

Parameters:

  • service_arn (AppRunnerResourceArn) –

    The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

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

    A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

    If you don't specify NextToken, the request retrieves the first result page.

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

    The maximum number of results that each response (result page) can include. It's used for a paginated request.

    If you don't specify MaxResults, the request retrieves all available results in a single response.

Raises:

Source code in docs_src/capo_apprunner/_services/async_app_runner.py
async def describe_custom_domains(
    self,
    service_arn: "capo_apprunner.types.app_runner_resource_arn.AppRunnerResourceArn",
    *,
    config_overrides: Optional[AsyncAppRunnerClientConfig] = None,
    next_token: Optional["capo_apprunner.types.string.String"] = None,
    max_results: Optional[
        "capo_apprunner.types.describe_custom_domains_max_results.DescribeCustomDomainsMaxResults"
    ] = None,
) -> "capo_apprunner.types.describe_custom_domains_response.DescribeCustomDomainsResponse":
    """<p>Return a description of custom domain names that are associated with an App Runner service.</p>

    Args:
        service_arn: <p>The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.</p>
        next_token: <p>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.</p> <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p>
        max_results: <p>The maximum number of results that each response (result page) can include. It's used for a paginated request.</p> <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p>

    Raises:
        capo_apprunner.errors.internal_service_error_exception.InternalServiceErrorException: <p>An unexpected service exception occurred.</p>
        capo_apprunner.errors.invalid_request_exception.InvalidRequestException: <p>One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.</p>
        capo_apprunner.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.</p>
        capo_apprunner.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_apprunner.types.describe_custom_domains_request.DescribeCustomDomainsRequest]",
    ) -> AsyncOperationResponse[
        "capo_apprunner.types.describe_custom_domains_response.DescribeCustomDomainsResponse"
    ]:
        import capo_apprunner._operations.app_runner.describe_custom_domains

        (
            output,
            http_response,
        ) = await capo_apprunner._operations.app_runner.describe_custom_domains.async_describe_custom_domains(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCustomDomains")
    )
    input_: capo_apprunner.types.describe_custom_domains_request.DescribeCustomDomainsRequest = {
        "service_arn": service_arn
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output