@bitmovin/api-sdk/dist/encoding/inputs/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 S3RoleBasedInput from '../../../models/S3RoleBasedInput';
import PaginationResponse from '../../../models/PaginationResponse';
import { S3RoleBasedInputListQueryParams, S3RoleBasedInputListQueryParamsBuilder } from './S3RoleBasedInputListQueryParams';
/**
 * 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 Input
     * @param {S3RoleBasedInput} s3RoleBasedInput The S3 Role-based input to be created  The following permissions are required for S3 Role-based input:   * s3:GetObject   * s3:GetBucketLocation,
     * @throws {BitmovinError}
     * @memberof S3RoleBasedApi
     */
    create(s3RoleBasedInput?: S3RoleBasedInput): Promise<S3RoleBasedInput>;
    /**
     * @summary Delete S3 Role-based Input
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof S3RoleBasedApi
     */
    delete(inputId: string): Promise<S3RoleBasedInput>;
    /**
     * @summary S3 Role-based Input Details
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof S3RoleBasedApi
     */
    get(inputId: string): Promise<S3RoleBasedInput>;
    /**
     * @summary List S3 Role-based Inputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof S3RoleBasedApi
     */
    list(queryParameters?: S3RoleBasedInputListQueryParams | ((q: S3RoleBasedInputListQueryParamsBuilder) => S3RoleBasedInputListQueryParamsBuilder)): Promise<PaginationResponse<S3RoleBasedInput>>;
}