Function getProperties

getProperties(
ctx: AmplifyContext,
input: GetPropertiesWithPathInput,
): Promise<GetPropertiesWithPathOutput>
Parameters
- ctx: AmplifyContext
  The AmplifyContext to operate on.
- input: GetPropertiesWithPathInput
  The GetPropertiesWithPathInput object.
Returns Promise<GetPropertiesWithPathOutput>
getProperties(
ctx: AmplifyContext,
input: GetPropertiesInput,
): Promise<GetPropertiesOutput>
Parameters
- ctx: AmplifyContext
  The AmplifyContext to operate on.
- input: GetPropertiesInput
  The GetPropertiesInput object.
Returns Promise<GetPropertiesOutput>
getProperties(
input: GetPropertiesWithPathInput,
): Promise<GetPropertiesWithPathOutput>
Gets the properties of a file. The properties include S3 system metadata and the user metadata that was provided when uploading the file.
Parameters
- input: GetPropertiesWithPathInput
  The GetPropertiesWithPathInput object.
Returns Promise<GetPropertiesWithPathOutput>
Requested object properties.

Throws
An S3Exception when the underlying S3 service returned error.

Throws
A StorageValidationErrorCode when API call parameters are invalid.
getProperties(input: GetPropertiesInput): Promise<GetPropertiesOutput>
Parameters
- input: GetPropertiesInput
  The GetPropertiesInput object.
Returns Promise<GetPropertiesOutput>
Requested object properties.

Deprecated
The key and accessLevel parameters are deprecated and may be removed in the next major version. Please use path instead.

Gets the properties of a file. The properties include S3 system metadata and the user metadata that was provided when uploading the file.

Throws
An S3Exception when the underlying S3 service returned error.

Throws
A StorageValidationErrorCode when API call parameters are invalid.

Function getProperties

Parameters

Returns Promise<GetPropertiesWithPathOutput>

Parameters

Returns Promise<GetPropertiesOutput>

Parameters

Returns Promise<GetPropertiesWithPathOutput>

Throws

Throws

Parameters

Returns Promise<GetPropertiesOutput>

Deprecated

Throws

Throws

Settings