Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class ListMediaCapturePipelinesCommandProtected

Returns a list of media pipelines.

Example

Use a bare-bones client and the command you need to make an API call.

import { ChimeSDKMediaPipelinesClient, ListMediaCapturePipelinesCommand } from "@aws-sdk/client-chime-sdk-media-pipelines"; // ES Modules import
// const { ChimeSDKMediaPipelinesClient, ListMediaCapturePipelinesCommand } = require("@aws-sdk/client-chime-sdk-media-pipelines"); // CommonJS import
const client = new ChimeSDKMediaPipelinesClient(config);
const input = { // ListMediaCapturePipelinesRequest
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListMediaCapturePipelinesCommand(input);
const response = await client.send(command);
// { // ListMediaCapturePipelinesResponse
// MediaCapturePipelines: [ // MediaCapturePipelineSummaryList
// { // MediaCapturePipelineSummary
// MediaPipelineId: "STRING_VALUE",
// MediaPipelineArn: "STRING_VALUE",
// },
// ],
// NextToken: "STRING_VALUE",
// };

Param

ListMediaCapturePipelinesCommandInput

Returns

ListMediaCapturePipelinesCommandOutput

See

Throws

BadRequestException (client fault)

The input parameters don't match the service's restrictions.

Throws

ForbiddenException (client fault)

The client is permanently forbidden from making the request.

Throws

ResourceLimitExceededException (client fault)

The request exceeds the resource limit.

Throws

ServiceFailureException (server fault)

The service encountered an unexpected error.

Throws

ServiceUnavailableException (server fault)

The service is currently unavailable.

Throws

ThrottledClientException (client fault)

The client exceeded its request rate limit.

Throws

UnauthorizedClientException (client fault)

The client is not currently authorized to make the request.

Throws

ChimeSDKMediaPipelinesServiceException

Base exception class for all service exceptions from ChimeSDKMediaPipelines service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods