Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListMediaCapturePipelines

Returns a list of media capture pipelines.

Important

This API is no longer supported and will not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Request Syntax


GET /media-capture-pipelines?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return in a single call. Valid Range: 1 - 99.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken

The token used to retrieve the next page of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "MediaCapturePipelines": [ 
      { 
         "ChimeSdkMeetingConfiguration": { 
            "ArtifactsConfiguration": { 
               "Audio": { 
                  "MuxType": "string"
               },
               "Content": { 
                  "MuxType": "string",
                  "State": "string"
               },
               "Video": { 
                  "MuxType": "string",
                  "State": "string"
               }
            },
            "SourceConfiguration": { 
               "SelectedVideoStreams": { 
                  "AttendeeIds": [ "string" ],
                  "ExternalUserIds": [ "string" ]
               }
            }
         },
         "CreatedTimestamp": "string",
         "MediaPipelineId": "string",
         "SinkArn": "string",
         "SinkType": "string",
         "SourceArn": "string",
         "SourceType": "string",
         "Status": "string",
         "UpdatedTimestamp": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MediaCapturePipelines

The media capture pipeline objects in the list.

Type: Array of MediaCapturePipeline objects

NextToken

The token used to retrieve the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

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

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401