Skip to content

get_backend_storage 

get_backend_storage(
    app_id: __string,
    backend_environment_name: __string,
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    resource_name: Optional[__string] = None,
) -> GetBackendStorageResponse

Gets details for a backend storage resource.

Parameters:

  • app_id (__string) –

    The app ID.

  • backend_environment_name (__string) –

    The name of the backend environment.

  • resource_name (Optional[__string], default: None ) –

    The name of the storage resource.

Raises:

Source code in docs_src/capo_amplifybackend/_services/amplify_backend.py 
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
def get_backend_storage(
    self,
    app_id: "capo_amplifybackend.types.__string.__string",
    backend_environment_name: "capo_amplifybackend.types.__string.__string",
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    resource_name: Optional["capo_amplifybackend.types.__string.__string"] = None,
) -> "capo_amplifybackend.types.get_backend_storage_response.GetBackendStorageResponse":
    """<p>Gets details for a backend storage resource.</p>

    Args:
        app_id: <p>The app ID.</p>
        backend_environment_name: <p>The name of the backend environment.</p>
        resource_name: <p>The name of the storage resource.</p>

    Raises:
        capo_amplifybackend.errors.bad_request_exception.BadRequestException: <p>An error returned if a request is not formed properly.</p>
        capo_amplifybackend.errors.gateway_timeout_exception.GatewayTimeoutException: <p>An error returned if there's a temporary issue with the service.</p>
        capo_amplifybackend.errors.not_found_exception.NotFoundException: <p>An error returned when a specific resource type is not found.</p>
        capo_amplifybackend.errors.too_many_requests_exception.TooManyRequestsException: <p>An error that is returned when a limit of a specific type has been exceeded.</p>
        capo_amplifybackend.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amplifybackend.types.get_backend_storage_request.GetBackendStorageRequest]",
    ) -> OperationResponse[
        "capo_amplifybackend.types.get_backend_storage_response.GetBackendStorageResponse"
    ]:
        import capo_amplifybackend._operations.amplify_backend.get_backend_storage

        output, http_response = (
            capo_amplifybackend._operations.amplify_backend.get_backend_storage.get_backend_storage(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBackendStorage")
    )
    input_: capo_amplifybackend.types.get_backend_storage_request.GetBackendStorageRequest = {
        "app_id": app_id,
        "backend_environment_name": backend_environment_name,
    }
    if resource_name is not None:
        input_["resource_name"] = resource_name

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