Skip to content

list_databases async

list_databases(
    *,
    config_overrides: Optional[AsyncSsmSapClientConfig] = None,
    application_id: Optional[ApplicationId] = None,
    component_id: Optional[ComponentId] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListDatabasesOutput

Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

Parameters:

  • application_id (Optional[ApplicationId], default: None ) –

    The ID of the application.

  • component_id (Optional[ComponentId], default: None ) –

    The ID of the component.

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

    The token for the next page of results.

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

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

Raises:

Source code in docs_src/capo_ssm_sap/_services/async_ssm_sap.py
async def list_databases(
    self,
    *,
    config_overrides: Optional[AsyncSsmSapClientConfig] = None,
    application_id: Optional[
        "capo_ssm_sap.types.application_id.ApplicationId"
    ] = None,
    component_id: Optional["capo_ssm_sap.types.component_id.ComponentId"] = None,
    next_token: Optional["capo_ssm_sap.types.next_token.NextToken"] = None,
    max_results: Optional["capo_ssm_sap.types.max_results.MaxResults"] = None,
) -> "capo_ssm_sap.types.list_databases_output.ListDatabasesOutput":
    """<p>Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.</p>

    Args:
        application_id: <p>The ID of the application.</p>
        component_id: <p>The ID of the component.</p>
        next_token: <p>The token for the next page of results. </p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.</p>

    Raises:
        capo_ssm_sap.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_ssm_sap.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource is not available.</p>
        capo_ssm_sap.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service. </p>
        capo_ssm_sap.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm_sap.types.list_databases_input.ListDatabasesInput]",
    ) -> AsyncOperationResponse[
        "capo_ssm_sap.types.list_databases_output.ListDatabasesOutput"
    ]:
        import capo_ssm_sap._operations.ssm_sap.list_databases

        (
            output,
            http_response,
        ) = await capo_ssm_sap._operations.ssm_sap.list_databases.async_list_databases(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDatabases")
    )
    input_: capo_ssm_sap.types.list_databases_input.ListDatabasesInput = {}
    if application_id is not None:
        input_["application_id"] = application_id
    if component_id is not None:
        input_["component_id"] = component_id
    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