- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListMediaCapturePipelinesCommand
Returns a list of media pipelines.
Example Syntax
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",
// };
ListMediaCapturePipelinesCommand Input
See ListMediaCapturePipelinesCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
MaxResults | number | undefined | The maximum number of results to return in a single call. Valid Range: 1 - 99. |
NextToken | string | undefined | The token used to retrieve the next page of results. |
ListMediaCapturePipelinesCommand Output
See ListMediaCapturePipelinesCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
MediaCapturePipelines | MediaCapturePipelineSummary[] | undefined | The media pipeline objects in the list. |
NextToken | string | undefined | The token used to retrieve the next page of results. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequestException | client | The input parameters don't match the service's restrictions. |
| ForbiddenException | client | The client is permanently forbidden from making the request. |
| ResourceLimitExceededException | client | The request exceeds the resource limit. |
| ServiceFailureException | server | The service encountered an unexpected error. |
| ServiceUnavailableException | server | The service is currently unavailable. |
| ThrottledClientException | client | The client exceeded its request rate limit. |
| UnauthorizedClientException | client | The client is not currently authorized to make the request. |
| ChimeSDKMediaPipelinesServiceException | Base exception class for all service exceptions from ChimeSDKMediaPipelines service. |