Skip to content

describe_framework async

describe_framework(
    framework_name: FrameworkName,
    *,
    config_overrides: Optional[AsyncBackupClientConfig] = None,
) -> DescribeFrameworkOutput

Returns the framework details for the specified FrameworkName.

Parameters:

  • framework_name (FrameworkName) –

    The unique name of a framework.

Raises:

Source code in docs_src/capo_backup/_services/async_backup.py
async def describe_framework(
    self,
    framework_name: "capo_backup.types.framework_name.FrameworkName",
    *,
    config_overrides: Optional[AsyncBackupClientConfig] = None,
) -> "capo_backup.types.describe_framework_output.DescribeFrameworkOutput":
    """<p>Returns the framework details for the specified <code>FrameworkName</code>.</p>

    Args:
        framework_name: <p>The unique name of a framework.</p>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_backup.types.describe_framework_input.DescribeFrameworkInput]",
    ) -> AsyncOperationResponse[
        "capo_backup.types.describe_framework_output.DescribeFrameworkOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.describe_framework

        (
            output,
            http_response,
        ) = await capo_backup._operations.cryo_controller_user_manager.describe_framework.async_describe_framework(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFramework")
    )
    input_: capo_backup.types.describe_framework_input.DescribeFrameworkInput = {
        "framework_name": framework_name
    }

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