@bitmovin/api-sdk/dist/encoding/outputs/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 S3Output from '../../../models/S3Output';
import PaginationResponse from '../../../models/PaginationResponse';
import { S3OutputListQueryParams, S3OutputListQueryParamsBuilder } from './S3OutputListQueryParams';
/**
 * S3Api - object-oriented interface
 * @export
 * @class S3Api
 * @extends {BaseAPI}
 */
export default class S3Api extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create S3 Output
     * @param {S3Output} s3Output The S3 output to be created  The following permissions are required for S3 output:  * s3:PutObject  * s3:PutObjectAcl  * s3:ListBucket  * s3:GetBucketLocation
     * @throws {BitmovinError}
     * @memberof S3Api
     */
    create(s3Output?: S3Output): Promise<S3Output>;
    /**
     * @summary Delete S3 Output
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof S3Api
     */
    delete(outputId: string): Promise<S3Output>;
    /**
     * @summary S3 Output Details
     * @param {string} outputId Id of the input
     * @throws {BitmovinError}
     * @memberof S3Api
     */
    get(outputId: string): Promise<S3Output>;
    /**
     * @summary List S3 Outputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof S3Api
     */
    list(queryParameters?: S3OutputListQueryParams | ((q: S3OutputListQueryParamsBuilder) => S3OutputListQueryParamsBuilder)): Promise<PaginationResponse<S3Output>>;
}