list_packages_for_domain `async` ¶

list_packages_for_domain(
    domain_name: DomainName,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListPackagesForDomainResponse

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Parameters:

domain_name (DomainName) –

The name of the domain for which you want to list associated packages.
max_results (Optional[MaxResults], default: None ) –

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
next_token (Optional[NextToken], default: None ) –

If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.

Raises:

AccessDeniedException –

An error occurred because you don't have permissions to access the resource.
BaseException –

An error occurred while processing the request.
InternalException –

Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException –

An exception for accessing or deleting a resource that doesn't exist.
ValidationException –

An exception for accessing or deleting a resource that doesn't exist.
UnknownServiceError –

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

Source code in docs_src/capo_opensearch/_services/async_open_search.py

async def list_packages_for_domain(
    self,
    domain_name: "capo_opensearch.types.domain_name.DomainName",
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    max_results: Optional["capo_opensearch.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_opensearch.types.next_token.NextToken"] = None,
) -> "capo_opensearch.types.list_packages_for_domain_response.ListPackagesForDomainResponse":
    """<p>Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>.</p>

    Args:
        domain_name: <p>The name of the domain for which you want to list associated packages.</p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.</p>
        next_token: <p>If your initial <code>ListPackagesForDomain</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListPackagesForDomain</code> operations, which returns results in the next page.</p>

    Raises:
        capo_opensearch.errors.access_denied_exception.AccessDeniedException: <p>An error occurred because you don't have permissions to access the resource.</p>
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearch.types.list_packages_for_domain_request.ListPackagesForDomainRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.list_packages_for_domain_response.ListPackagesForDomainResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.list_packages_for_domain

        (
            output,
            http_response,
        ) = await capo_opensearch._operations.amazon_open_search_service.list_packages_for_domain.async_list_packages_for_domain(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPackagesForDomain")
    )
    input_: capo_opensearch.types.list_packages_for_domain_request.ListPackagesForDomainRequest = {
        "domain_name": domain_name
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

list_packages_for_domain async ¶

list_packages_for_domain `async` ¶