@bitmovin/api-sdk/dist/encoding/outputs/s3RoleBased/S3RoleBasedApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import S3RoleBasedOutput from '../../../models/S3RoleBasedOutput';
import PaginationResponse from '../../../models/PaginationResponse';
import { S3RoleBasedOutputListQueryParams, S3RoleBasedOutputListQueryParamsBuilder } from './S3RoleBasedOutputListQueryParams';
/**
 * S3RoleBasedApi - object-oriented interface
 * @export
 * @class S3RoleBasedApi
 * @extends {BaseAPI}
 */
export default class S3RoleBasedApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create S3 Role-based Output
     * @param {S3RoleBasedOutput} s3RoleBasedOutput The S3 Role-based output to be created  The following permissions are required for S3 Role-based output:  * s3:PutObject  * s3:PutObjectAcl  * s3:ListBucket  * s3:GetBucketLocation
     * @throws {BitmovinError}
     * @memberof S3RoleBasedApi
     */
    create(s3RoleBasedOutput?: S3RoleBasedOutput): Promise<S3RoleBasedOutput>;
    /**
     * @summary Delete S3 Role-based Output
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof S3RoleBasedApi
     */
    delete(outputId: string): Promise<S3RoleBasedOutput>;
    /**
     * @summary S3 Role-based Output Details
     * @param {string} outputId Id of the input
     * @throws {BitmovinError}
     * @memberof S3RoleBasedApi
     */
    get(outputId: string): Promise<S3RoleBasedOutput>;
    /**
     * @summary List S3 Role-based Outputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof S3RoleBasedApi
     */
    list(queryParameters?: S3RoleBasedOutputListQueryParams | ((q: S3RoleBasedOutputListQueryParamsBuilder) => S3RoleBasedOutputListQueryParamsBuilder)): Promise<PaginationResponse<S3RoleBasedOutput>>;
}