@bitmovin/api-sdk/dist/encoding/inputs/s3/S3Api.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import S3Input from '../../../models/S3Input';
import PaginationResponse from '../../../models/PaginationResponse';
import { S3InputListQueryParams, S3InputListQueryParamsBuilder } from './S3InputListQueryParams';
/**
 * S3Api - object-oriented interface
 * @export
 * @class S3Api
 * @extends {BaseAPI}
 */
export default class S3Api extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create S3 Input
     * @param {S3Input} s3Input The S3 input to be created  The following permissions are required for S3 input:   * s3:GetObject   * s3:GetBucketLocation,
     * @throws {BitmovinError}
     * @memberof S3Api
     */
    create(s3Input?: S3Input): Promise<S3Input>;
    /**
     * @summary Delete S3 Input
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof S3Api
     */
    delete(inputId: string): Promise<BitmovinResponse>;
    /**
     * @summary S3 Input Details
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof S3Api
     */
    get(inputId: string): Promise<S3Input>;
    /**
     * @summary List S3 Inputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof S3Api
     */
    list(queryParameters?: S3InputListQueryParams | ((q: S3InputListQueryParamsBuilder) => S3InputListQueryParamsBuilder)): Promise<PaginationResponse<S3Input>>;
}