describe_backup_vault ¶

describe_backup_vault(
    backup_vault_name: string,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    backup_vault_account_id: Optional[string] = None,
) -> DescribeBackupVaultOutput

Returns metadata about a backup vault specified by its name.

Parameters:

backup_vault_name (string) –

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
backup_vault_account_id (Optional[string], default: None ) –

The account ID of the specified backup vault.

Raises:

InvalidParameterValueException –

Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException –

Indicates that a required parameter is missing.
ResourceNotFoundException –

A resource that is required for the action doesn't exist.
ServiceUnavailableException –

The request failed due to a temporary failure of the server.
UnknownServiceError –

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

Source code in docs_src/capo_backup/_services/backup.py

def describe_backup_vault(
    self,
    backup_vault_name: "capo_backup.types.string.string",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    backup_vault_account_id: Optional["capo_backup.types.string.string"] = None,
) -> "capo_backup.types.describe_backup_vault_output.DescribeBackupVaultOutput":
    """<p>Returns metadata about a backup vault specified by its name.</p>

    Args:
        backup_vault_name: <p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.</p>
        backup_vault_account_id: <p>The account ID of the specified backup vault.</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.
    """

    def _handler(
        req: "OperationRequest[capo_backup.types.describe_backup_vault_input.DescribeBackupVaultInput]",
    ) -> OperationResponse[
        "capo_backup.types.describe_backup_vault_output.DescribeBackupVaultOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.describe_backup_vault

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.describe_backup_vault.describe_backup_vault(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeBackupVault")
    )
    input_: capo_backup.types.describe_backup_vault_input.DescribeBackupVaultInput = {
        "backup_vault_name": backup_vault_name
    }
    if backup_vault_account_id is not None:
        input_["backup_vault_account_id"] = backup_vault_account_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output