"documentation":"MediaConnect created the new resource successfully."
},
"errors":[
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol."
"documentation":"AWS Elemental MediaConnect can't complete this request because this flow already has the maximum number of allowed outputs (50). For more information, contact AWS Customer Support."
"documentation":"AWS Elemental MediaConnect created the new flow successfully."
},
"errors":[
{
"shape":"CreateFlow420Exception",
"documentation":"Your account already contains the maximum number of 20 flows per account, per Region. For more information, contact AWS Customer Support."
},
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
"documentation":"Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50)."
"documentation":"AWS Elemental MediaConnect is deleting the flow."
},
"errors":[
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"Deletes a flow. Before you can delete a flow, you must stop the flow."
},
"DescribeFlow":{
"name":"DescribeFlow",
"http":{
"method":"GET",
"requestUri":"/v1/flows/{flowArn}",
"responseCode":200
},
"input":{
"shape":"DescribeFlowRequest"
},
"output":{
"shape":"DescribeFlowResponse",
"documentation":"AWS Elemental MediaConnect returned the flow details successfully."
},
"errors":[
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements."
"documentation":"MediaConnect returned the offering details successfully."
},
"errors":[
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
},
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
}
],
"documentation":"Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN)."
},
"DescribeReservation":{
"name":"DescribeReservation",
"http":{
"method":"GET",
"requestUri":"/v1/reservations/{reservationArn}",
"responseCode":200
},
"input":{
"shape":"DescribeReservationRequest"
},
"output":{
"shape":"DescribeReservationResponse",
"documentation":"MediaConnect returned the reservation details successfully."
},
"errors":[
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
},
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
}
],
"documentation":"Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth)."
"documentation":"AWS Elemental MediaConnect granted the entitlements successfully."
},
"errors":[
{
"shape":"GrantFlowEntitlements420Exception",
"documentation":"AWS Elemental MediaConnect can't complete this request because this flow already has the maximum number of allowed entitlements (50). For more information, contact AWS Customer Support."
},
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"Grants entitlements to an existing flow."
},
"ListEntitlements":{
"name":"ListEntitlements",
"http":{
"method":"GET",
"requestUri":"/v1/entitlements",
"responseCode":200
},
"input":{
"shape":"ListEntitlementsRequest"
},
"output":{
"shape":"ListEntitlementsResponse",
"documentation":"AWS Elemental MediaConnect returned the list of entitlements successfully."
},
"errors":[
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
},
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
}
],
"documentation":"Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page."
},
"ListFlows":{
"name":"ListFlows",
"http":{
"method":"GET",
"requestUri":"/v1/flows",
"responseCode":200
},
"input":{
"shape":"ListFlowsRequest"
},
"output":{
"shape":"ListFlowsResponse",
"documentation":"AWS Elemental MediaConnect returned the list of flows successfully."
},
"errors":[
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
},
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
}
],
"documentation":"Displays a list of flows that are associated with this account. This request returns a paginated result."
"documentation":"MediaConnect returned the list of offerings successfully."
},
"errors":[
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
},
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
}
],
"documentation":"Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings."
},
"ListReservations":{
"name":"ListReservations",
"http":{
"method":"GET",
"requestUri":"/v1/reservations",
"responseCode":200
},
"input":{
"shape":"ListReservationsRequest"
},
"output":{
"shape":"ListReservationsResponse",
"documentation":"MediaConnect returned the list of reservations successfully."
},
"errors":[
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
},
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
}
],
"documentation":"Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired)."
"documentation":"output successfully removed from flow configuration."
},
"errors":[
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output."
"documentation":"VPC interface successfully removed from flow configuration."
},
"errors":[
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface."
"documentation":"AWS Elemental MediaConnect revoked the entitlement successfully."
},
"errors":[
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed."
},
"StartFlow":{
"name":"StartFlow",
"http":{
"method":"POST",
"requestUri":"/v1/flows/start/{flowArn}",
"responseCode":202
},
"input":{
"shape":"StartFlowRequest"
},
"output":{
"shape":"StartFlowResponse",
"documentation":"AWS Elemental MediaConnect is starting the flow."
},
"errors":[
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"Starts a flow."
},
"StopFlow":{
"name":"StopFlow",
"http":{
"method":"POST",
"requestUri":"/v1/flows/stop/{flowArn}",
"responseCode":202
},
"input":{
"shape":"StopFlowRequest"
},
"output":{
"shape":"StopFlowResponse",
"documentation":"AWS Elemental MediaConnect is stopping the flow."
},
"errors":[
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"Stops a flow."
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}",
"responseCode":204
},
"input":{
"shape":"TagResourceRequest"
},
"errors":[
{
"shape":"NotFoundException",
"documentation":"The requested resource was not found"
},
{
"shape":"BadRequestException",
"documentation":"The client performed an invalid request"
},
{
"shape":"InternalServerErrorException",
"documentation":"Internal service error"
}
],
"documentation":"Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well."
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resourceArn}",
"responseCode":204
},
"input":{
"shape":"UntagResourceRequest"
},
"errors":[
{
"shape":"NotFoundException",
"documentation":"The requested resource was not found"
},
{
"shape":"BadRequestException",
"documentation":"The client performed an invalid request"
},
{
"shape":"InternalServerErrorException",
"documentation":"Internal service error"
}
],
"documentation":"Deletes specified tags from a resource."
"documentation":"AWS Elemental MediaConnect updated the entitlement successfully."
},
"errors":[
{
"shape":"BadRequestException",
"documentation":"The request that you submitted is not valid."
},
{
"shape":"InternalServerErrorException",
"documentation":"AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape":"ForbiddenException",
"documentation":"You don't have the required permissions to perform this operation."
},
{
"shape":"NotFoundException",
"documentation":"AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape":"ServiceUnavailableException",
"documentation":"AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape":"TooManyRequestsException",
"documentation":"You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation":"You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed."
"documentation":"The error message returned by AWS Elemental MediaConnect."
}
},
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"documentation":"The attributes that you want to assign to the new media stream."
},
"ClockRate":{
"shape":"__integer",
"locationName":"clockRate",
"documentation":"The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"A description that can help you quickly identify what your media stream is used for."
},
"MediaStreamId":{
"shape":"__integer",
"locationName":"mediaStreamId",
"documentation":"A unique identifier for the media stream."
},
"MediaStreamName":{
"shape":"__string",
"locationName":"mediaStreamName",
"documentation":"A name that helps you distinguish one media stream from another."
},
"MediaStreamType":{
"shape":"MediaStreamType",
"locationName":"mediaStreamType",
"documentation":"The type of media stream."
},
"VideoFormat":{
"shape":"__string",
"locationName":"videoFormat",
"documentation":"The resolution of the video."
}
},
"documentation":"The media stream that you want to add to the flow.",
"documentation":"The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user."
},
"Destination":{
"shape":"__string",
"locationName":"destination",
"documentation":"The IP address from which video will be sent to output destinations."
},
"Encryption":{
"shape":"Encryption",
"locationName":"encryption",
"documentation":"The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."
},
"MaxLatency":{
"shape":"__integer",
"locationName":"maxLatency",
"documentation":"The maximum latency in milliseconds for Zixi-based streams."
"documentation":"The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
"documentation":"The output that you want to add to this flow.",
"required":[
"Protocol"
]
},
"Algorithm":{
"type":"string",
"enum":[
"aes128",
"aes192",
"aes256"
]
},
"BadRequestException":{
"type":"structure",
"members":{
"Message":{
"shape":"__string",
"locationName":"message",
"documentation":"The error message returned by AWS Elemental MediaConnect."
}
},
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"documentation":"The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region."
},
"Entitlements":{
"shape":"__listOfGrantEntitlementRequest",
"locationName":"entitlements",
"documentation":"The entitlements that you want to grant on a flow."
"documentation":"Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).",
"documentation":"The IP address where contents of the media stream will be sent."
},
"DestinationPort":{
"shape":"__integer",
"locationName":"destinationPort",
"documentation":"The port to use when the content of the media stream is distributed to the output."
},
"Interface":{
"shape":"Interface",
"locationName":"interface",
"documentation":"The VPC interface that is used for the media stream associated with the output."
},
"OutboundIp":{
"shape":"__string",
"locationName":"outboundIp",
"documentation":"The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol."
}
},
"documentation":"The transport parameters that are associated with an outbound media stream.",
"required":[
"DestinationIp",
"DestinationPort",
"Interface",
"OutboundIp"
]
},
"DestinationConfigurationRequest":{
"type":"structure",
"members":{
"DestinationIp":{
"shape":"__string",
"locationName":"destinationIp",
"documentation":"The IP address where you want MediaConnect to send contents of the media stream."
},
"DestinationPort":{
"shape":"__integer",
"locationName":"destinationPort",
"documentation":"The port that you want MediaConnect to use when it distributes the media stream to the output."
},
"Interface":{
"shape":"InterfaceRequest",
"locationName":"interface",
"documentation":"The VPC interface that you want to use for the media stream associated with the output."
}
},
"documentation":"The transport parameters that you want to associate with an outbound media stream.",
"documentation":"A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive."
},
"EncoderProfile":{
"shape":"EncoderProfile",
"locationName":"encoderProfile",
"documentation":"A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol."
}
},
"documentation":"A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.",
"required":[
"EncoderProfile",
"CompressionFactor"
]
},
"EncodingParametersRequest":{
"type":"structure",
"members":{
"CompressionFactor":{
"shape":"__double",
"locationName":"compressionFactor",
"documentation":"A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive."
},
"EncoderProfile":{
"shape":"EncoderProfile",
"locationName":"encoderProfile",
"documentation":"A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol."
}
},
"documentation":"A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.",
"documentation":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."
},
"ConstantInitializationVector":{
"shape":"__string",
"locationName":"constantInitializationVector",
"documentation":"A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption."
},
"DeviceId":{
"shape":"__string",
"locationName":"deviceId",
"documentation":"The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption."
},
"KeyType":{
"shape":"KeyType",
"locationName":"keyType",
"documentation":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."
},
"Region":{
"shape":"__string",
"locationName":"region",
"documentation":"The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption."
},
"ResourceId":{
"shape":"__string",
"locationName":"resourceId",
"documentation":"An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption."
},
"RoleArn":{
"shape":"__string",
"locationName":"roleArn",
"documentation":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."
},
"SecretArn":{
"shape":"__string",
"locationName":"secretArn",
"documentation":"The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."
},
"Url":{
"shape":"__string",
"locationName":"url",
"documentation":"The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption."
}
},
"documentation":"Information about the encryption of the flow.",
"documentation":"The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source."
}
},
"documentation":"The settings for a flow entitlement.",
"documentation":"The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams."
"documentation":"The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account."
},
"EgressIp":{
"shape":"__string",
"locationName":"egressIp",
"documentation":"The IP address from which video will be sent to output destinations."
},
"Entitlements":{
"shape":"__listOfEntitlement",
"locationName":"entitlements",
"documentation":"The entitlements in this flow."
},
"FlowArn":{
"shape":"__string",
"locationName":"flowArn",
"documentation":"The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow."
"documentation":"The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow."
"documentation":"The format of the audio channel."
},
"Colorimetry":{
"shape":"Colorimetry",
"locationName":"colorimetry",
"documentation":"The format that is used for the representation of color."
},
"ExactFramerate":{
"shape":"__string",
"locationName":"exactFramerate",
"documentation":"The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate."
},
"Par":{
"shape":"__string",
"locationName":"par",
"documentation":"The pixel aspect ratio (PAR) of the video."
},
"Range":{
"shape":"Range",
"locationName":"range",
"documentation":"The encoding range of the video."
},
"ScanMode":{
"shape":"ScanMode",
"locationName":"scanMode",
"documentation":"The type of compression that was used to smooth the video\u2019s appearance"
},
"Tcs":{
"shape":"Tcs",
"locationName":"tcs",
"documentation":"The transfer characteristic system (TCS) that is used in the video."
}
},
"documentation":"FMTP"
},
"FmtpRequest":{
"type":"structure",
"members":{
"ChannelOrder":{
"shape":"__string",
"locationName":"channelOrder",
"documentation":"The format of the audio channel."
},
"Colorimetry":{
"shape":"Colorimetry",
"locationName":"colorimetry",
"documentation":"The format that is used for the representation of color."
},
"ExactFramerate":{
"shape":"__string",
"locationName":"exactFramerate",
"documentation":"The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate."
},
"Par":{
"shape":"__string",
"locationName":"par",
"documentation":"The pixel aspect ratio (PAR) of the video."
},
"Range":{
"shape":"Range",
"locationName":"range",
"documentation":"The encoding range of the video."
},
"ScanMode":{
"shape":"ScanMode",
"locationName":"scanMode",
"documentation":"The type of compression that was used to smooth the video\u2019s appearance."
},
"Tcs":{
"shape":"Tcs",
"locationName":"tcs",
"documentation":"The transfer characteristic system (TCS) that is used in the video."
}
},
"documentation":"The settings that you want to use to define the media stream."
"documentation":"The error message returned by AWS Elemental MediaConnect."
}
},
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"documentation":"A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user."
},
"Encryption":{
"shape":"Encryption",
"locationName":"encryption",
"documentation":"The type of encryption that will be used on the output that is associated with this entitlement."
"documentation":"An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don\u2019t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED."
"documentation":"The name of the entitlement. This value must be unique within the current flow."
},
"Subscribers":{
"shape":"__listOf__string",
"locationName":"subscribers",
"documentation":"The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source."
}
},
"documentation":"The entitlements that you want to grant on a flow.",
"required":[
"Subscribers"
]
},
"GrantFlowEntitlements420Exception":{
"type":"structure",
"members":{
"Message":{
"shape":"__string",
"locationName":"message",
"documentation":"The error message returned by AWS Elemental MediaConnect."
}
},
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"documentation":"The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page."
},
"NextToken":{
"shape":"__string",
"location":"querystring",
"locationName":"nextToken",
"documentation":"The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value."
"documentation":"A list of entitlements that have been granted to you from other AWS accounts."
},
"NextToken":{
"shape":"__string",
"locationName":"nextToken",
"documentation":"The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value."
"documentation":"The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page."
},
"NextToken":{
"shape":"__string",
"location":"querystring",
"locationName":"nextToken",
"documentation":"The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value."
"documentation":"The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value."
"documentation":"The maximum number of results to return per API request. For example, you submit a ListOfferings request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page."
},
"NextToken":{
"shape":"__string",
"location":"querystring",
"locationName":"nextToken",
"documentation":"The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value."
}
}
},
"ListOfferingsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"__string",
"locationName":"nextToken",
"documentation":"The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value."
},
"Offerings":{
"shape":"__listOfOffering",
"locationName":"offerings",
"documentation":"A list of offerings that are available to this account in the current AWS Region."
}
}
},
"ListReservationsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"location":"querystring",
"locationName":"maxResults",
"documentation":"The maximum number of results to return per API request. For example, you submit a ListReservations request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page."
},
"NextToken":{
"shape":"__string",
"location":"querystring",
"locationName":"nextToken",
"documentation":"The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value."
}
}
},
"ListReservationsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"__string",
"locationName":"nextToken",
"documentation":"The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value."
},
"Reservations":{
"shape":"__listOfReservation",
"locationName":"reservations",
"documentation":"A list of all reservations that have been purchased by this account in the current AWS Region."
"documentation":"A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters."
"documentation":"An entitlement that has been granted to you from other AWS accounts.",
"required":[
"EntitlementArn",
"EntitlementName"
]
},
"ListedFlow":{
"type":"structure",
"members":{
"AvailabilityZone":{
"shape":"__string",
"locationName":"availabilityZone",
"documentation":"The Availability Zone that the flow was created in."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"A description of the flow."
},
"FlowArn":{
"shape":"__string",
"locationName":"flowArn",
"documentation":"The ARN of the flow."
},
"Name":{
"shape":"__string",
"locationName":"name",
"documentation":"The name of the flow."
},
"SourceType":{
"shape":"SourceType",
"locationName":"sourceType",
"documentation":"The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account)."
},
"Status":{
"shape":"Status",
"locationName":"status",
"documentation":"The current status of the flow."
}
},
"documentation":"Provides a summary of a flow, including its ARN, Availability Zone, and source type.",
"documentation":"Attributes that are related to the media stream."
},
"ClockRate":{
"shape":"__integer",
"locationName":"clockRate",
"documentation":"The sample rate for the stream. This value is measured in Hz."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"A description that can help you quickly identify what your media stream is used for."
},
"Fmt":{
"shape":"__integer",
"locationName":"fmt",
"documentation":"The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver."
},
"MediaStreamId":{
"shape":"__integer",
"locationName":"mediaStreamId",
"documentation":"A unique identifier for the media stream."
},
"MediaStreamName":{
"shape":"__string",
"locationName":"mediaStreamName",
"documentation":"A name that helps you distinguish one media stream from another."
},
"MediaStreamType":{
"shape":"MediaStreamType",
"locationName":"mediaStreamType",
"documentation":"The type of media stream."
},
"VideoFormat":{
"shape":"__string",
"locationName":"videoFormat",
"documentation":"The resolution of the video."
}
},
"documentation":"A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.",
"required":[
"MediaStreamType",
"MediaStreamId",
"MediaStreamName",
"Fmt"
]
},
"MediaStreamAttributes":{
"type":"structure",
"members":{
"Fmtp":{
"shape":"Fmtp",
"locationName":"fmtp",
"documentation":"A set of parameters that define the media stream."
},
"Lang":{
"shape":"__string",
"locationName":"lang",
"documentation":"The audio language, in a format that is recognized by the receiver."
}
},
"documentation":"Attributes that are related to the media stream.",
"required":[
"Fmtp"
]
},
"MediaStreamAttributesRequest":{
"type":"structure",
"members":{
"Fmtp":{
"shape":"FmtpRequest",
"locationName":"fmtp",
"documentation":"The settings that you want to use to define the media stream."
},
"Lang":{
"shape":"__string",
"locationName":"lang",
"documentation":"The audio language, in a format that is recognized by the receiver."
}
},
"documentation":"Attributes that are related to the media stream."
},
"MediaStreamOutputConfiguration":{
"type":"structure",
"members":{
"DestinationConfigurations":{
"shape":"__listOfDestinationConfiguration",
"locationName":"destinationConfigurations",
"documentation":"The transport parameters that are associated with each outbound media stream."
},
"EncodingName":{
"shape":"EncodingName",
"locationName":"encodingName",
"documentation":"The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv."
},
"EncodingParameters":{
"shape":"EncodingParameters",
"locationName":"encodingParameters",
"documentation":"Encoding parameters"
},
"MediaStreamName":{
"shape":"__string",
"locationName":"mediaStreamName",
"documentation":"The name of the media stream."
}
},
"documentation":"The media stream that is associated with the output, and the parameters for that association.",
"documentation":"The transport parameters that you want to associate with the media stream."
},
"EncodingName":{
"shape":"EncodingName",
"locationName":"encodingName",
"documentation":"The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv."
},
"EncodingParameters":{
"shape":"EncodingParametersRequest",
"locationName":"encodingParameters",
"documentation":"A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source."
},
"MediaStreamName":{
"shape":"__string",
"locationName":"mediaStreamName",
"documentation":"The name of the media stream that is associated with the output."
}
},
"documentation":"The media stream that you want to associate with the output, and the parameters for that association.",
"required":[
"MediaStreamName",
"EncodingName"
]
},
"MediaStreamSourceConfiguration":{
"type":"structure",
"members":{
"EncodingName":{
"shape":"EncodingName",
"locationName":"encodingName",
"documentation":"The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv."
},
"InputConfigurations":{
"shape":"__listOfInputConfiguration",
"locationName":"inputConfigurations",
"documentation":"The transport parameters that are associated with an incoming media stream."
},
"MediaStreamName":{
"shape":"__string",
"locationName":"mediaStreamName",
"documentation":"The name of the media stream."
}
},
"documentation":"The media stream that is associated with the source, and the parameters for that association.",
"required":[
"MediaStreamName",
"EncodingName"
]
},
"MediaStreamSourceConfigurationRequest":{
"type":"structure",
"members":{
"EncodingName":{
"shape":"EncodingName",
"locationName":"encodingName",
"documentation":"The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv."
},
"InputConfigurations":{
"shape":"__listOfInputConfigurationRequest",
"locationName":"inputConfigurations",
"documentation":"The transport parameters that you want to associate with the media stream."
},
"MediaStreamName":{
"shape":"__string",
"locationName":"mediaStreamName",
"documentation":"The name of the media stream."
}
},
"documentation":"The definition of a media stream that you want to associate with the source.",
"documentation":"The error message returned by AWS Elemental MediaConnect."
}
},
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"documentation":"The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol."
"documentation":"The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input."
"documentation":"The Amazon Resource Name (ARN) of the offering."
},
"ReservationName":{
"shape":"__string",
"locationName":"reservationName",
"documentation":"The name that you want to use for the reservation."
},
"Start":{
"shape":"__string",
"locationName":"start",
"documentation":"The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z."
}
},
"documentation":"A request to purchase a offering.",
"documentation":"The type of currency that is used for billing. The currencyCode used for your reservation is US dollars."
},
"Duration":{
"shape":"__integer",
"locationName":"duration",
"documentation":"The length of time that this reservation is active. MediaConnect defines this value in the offering."
},
"DurationUnits":{
"shape":"DurationUnits",
"locationName":"durationUnits",
"documentation":"The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering."
},
"End":{
"shape":"__string",
"locationName":"end",
"documentation":"The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration."
},
"OfferingArn":{
"shape":"__string",
"locationName":"offeringArn",
"documentation":"The Amazon Resource Name (ARN) that MediaConnect assigns to the offering."
},
"OfferingDescription":{
"shape":"__string",
"locationName":"offeringDescription",
"documentation":"A description of the offering. MediaConnect defines this value in the offering."
},
"PricePerUnit":{
"shape":"__string",
"locationName":"pricePerUnit",
"documentation":"The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering."
},
"PriceUnits":{
"shape":"PriceUnits",
"locationName":"priceUnits",
"documentation":"The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering."
},
"ReservationArn":{
"shape":"__string",
"locationName":"reservationArn",
"documentation":"The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering."
},
"ReservationName":{
"shape":"__string",
"locationName":"reservationName",
"documentation":"The name that you assigned to the reservation when you purchased the offering."
},
"ReservationState":{
"shape":"ReservationState",
"locationName":"reservationState",
"documentation":"The status of your reservation."
},
"ResourceSpecification":{
"shape":"ResourceSpecification",
"locationName":"resourceSpecification",
"documentation":"A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering."
},
"Start":{
"shape":"__string",
"locationName":"start",
"documentation":"The day and time that the reservation becomes active. You set this value when you purchase the offering."
}
},
"documentation":"A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.",
"required":[
"CurrencyCode",
"ReservationState",
"OfferingArn",
"ReservationArn",
"Start",
"OfferingDescription",
"ReservationName",
"End",
"Duration",
"DurationUnits",
"PricePerUnit",
"ResourceSpecification",
"PriceUnits"
]
},
"ReservationState":{
"type":"string",
"enum":[
"ACTIVE",
"EXPIRED",
"PROCESSING",
"CANCELED"
]
},
"ResourceSpecification":{
"type":"structure",
"members":{
"ReservedBitrate":{
"shape":"__integer",
"locationName":"reservedBitrate",
"documentation":"The amount of outbound bandwidth that is discounted in the offering."
},
"ResourceType":{
"shape":"ResourceType",
"locationName":"resourceType",
"documentation":"The type of resource and the unit that is being billed for."
}
},
"documentation":"A definition of what is being billed for, including the type and amount.",
"documentation":"The error message returned by AWS Elemental MediaConnect."
}
},
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"required":[
"Message"
]
},
"RevokeFlowEntitlementRequest":{
"type":"structure",
"members":{
"EntitlementArn":{
"shape":"__string",
"location":"uri",
"locationName":"entitlementArn",
"documentation":"The ARN of the entitlement that you want to revoke."
},
"FlowArn":{
"shape":"__string",
"location":"uri",
"locationName":"flowArn",
"documentation":"The flow that you want to revoke an entitlement from."
}
},
"required":[
"FlowArn",
"EntitlementArn"
]
},
"RevokeFlowEntitlementResponse":{
"type":"structure",
"members":{
"EntitlementArn":{
"shape":"__string",
"locationName":"entitlementArn",
"documentation":"The ARN of the entitlement that was revoked."
},
"FlowArn":{
"shape":"__string",
"locationName":"flowArn",
"documentation":"The ARN of the flow that the entitlement was revoked from."
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"documentation":"The type of encryption that is used on the content ingested from this source."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account."
},
"EntitlementArn":{
"shape":"__string",
"locationName":"entitlementArn",
"documentation":"The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow."
},
"IngestPort":{
"shape":"__integer",
"locationName":"ingestPort",
"documentation":"The port that the flow will be listening on for incoming content."
"documentation":"The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
"documentation":"The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."
}
},
"documentation":"The settings for the source of the flow."
"documentation":"The type of encryption that is used on the content ingested from this source."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account."
},
"EntitlementArn":{
"shape":"__string",
"locationName":"entitlementArn",
"documentation":"The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow."
},
"IngestIp":{
"shape":"__string",
"locationName":"ingestIp",
"documentation":"The IP address that the flow will be listening on for incoming content."
},
"IngestPort":{
"shape":"__integer",
"locationName":"ingestPort",
"documentation":"The port that the flow will be listening on for incoming content."
"documentation":"The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."
}
},
"documentation":"The settings for the source of the flow.",
"documentation":"The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags."
},
"Tags":{
"shape":"__mapOf__string",
"locationName":"tags",
"documentation":"A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters."
}
},
"documentation":"The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.",
"documentation":"The error message returned by AWS Elemental MediaConnect."
}
},
"documentation":"Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.",
"documentation":"The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."
"documentation":"The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
"documentation":"The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams."
}
},
"documentation":"Attributes related to the transport stream that are used in a source or output.",
"required":[
"Protocol"
]
},
"UntagResourceRequest":{
"type":"structure",
"members":{
"ResourceArn":{
"shape":"__string",
"location":"uri",
"locationName":"resourceArn",
"documentation":"The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags."
},
"TagKeys":{
"shape":"__listOf__string",
"location":"querystring",
"locationName":"tagKeys",
"documentation":"The keys of the tags to be removed."
}
},
"required":[
"TagKeys",
"ResourceArn"
]
},
"UpdateEncryption":{
"type":"structure",
"members":{
"Algorithm":{
"shape":"Algorithm",
"locationName":"algorithm",
"documentation":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."
},
"ConstantInitializationVector":{
"shape":"__string",
"locationName":"constantInitializationVector",
"documentation":"A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption."
},
"DeviceId":{
"shape":"__string",
"locationName":"deviceId",
"documentation":"The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption."
},
"KeyType":{
"shape":"KeyType",
"locationName":"keyType",
"documentation":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."
},
"Region":{
"shape":"__string",
"locationName":"region",
"documentation":"The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption."
},
"ResourceId":{
"shape":"__string",
"locationName":"resourceId",
"documentation":"An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption."
},
"RoleArn":{
"shape":"__string",
"locationName":"roleArn",
"documentation":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."
},
"SecretArn":{
"shape":"__string",
"locationName":"secretArn",
"documentation":"The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."
},
"Url":{
"shape":"__string",
"locationName":"url",
"documentation":"The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption."
}
},
"documentation":"Information about the encryption of the flow."
"documentation":"The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams."
"documentation":"A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user."
},
"Encryption":{
"shape":"UpdateEncryption",
"locationName":"encryption",
"documentation":"The type of encryption that will be used on the output associated with this entitlement."
},
"EntitlementArn":{
"shape":"__string",
"location":"uri",
"locationName":"entitlementArn",
"documentation":"The ARN of the entitlement that you want to update."
"documentation":"An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber\u2019s flow temporarily. If you don\u2019t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged."
"documentation":"The flow that is associated with the entitlement that you want to update."
},
"Subscribers":{
"shape":"__listOf__string",
"locationName":"subscribers",
"documentation":"The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source."
}
},
"documentation":"The entitlement fields that you want to update.",
"documentation":"The attributes that you want to assign to the media stream."
},
"ClockRate":{
"shape":"__integer",
"locationName":"clockRate",
"documentation":"The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"Description"
},
"FlowArn":{
"shape":"__string",
"pattern":"^arn:.+:mediaconnect.+:flow:.+$",
"location":"uri",
"locationName":"flowArn",
"documentation":"The Amazon Resource Name (ARN) of the flow."
},
"MediaStreamName":{
"shape":"__string",
"location":"uri",
"locationName":"mediaStreamName",
"documentation":"The name of the media stream that you want to update."
},
"MediaStreamType":{
"shape":"MediaStreamType",
"locationName":"mediaStreamType",
"documentation":"The type of media stream."
},
"VideoFormat":{
"shape":"__string",
"locationName":"videoFormat",
"documentation":"The resolution of the video."
}
},
"documentation":"The fields that you want to update in the media stream.",
"required":[
"FlowArn",
"MediaStreamName"
]
},
"UpdateFlowMediaStreamResponse":{
"type":"structure",
"members":{
"FlowArn":{
"shape":"__string",
"locationName":"flowArn",
"documentation":"The ARN of the flow that is associated with the media stream that you updated."
},
"MediaStream":{
"shape":"MediaStream",
"locationName":"mediaStream",
"documentation":"The media stream that you updated."
"documentation":"The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user."
},
"Destination":{
"shape":"__string",
"locationName":"destination",
"documentation":"The IP address where you want to send the output."
},
"Encryption":{
"shape":"UpdateEncryption",
"locationName":"encryption",
"documentation":"The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."
},
"FlowArn":{
"shape":"__string",
"location":"uri",
"locationName":"flowArn",
"documentation":"The flow that is associated with the output that you want to update."
},
"MaxLatency":{
"shape":"__integer",
"locationName":"maxLatency",
"documentation":"The maximum latency in milliseconds for Zixi-based streams."
"documentation":"The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
"documentation":"The type of encryption used on the content ingested from this source."
},
"Description":{
"shape":"__string",
"locationName":"description",
"documentation":"A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account."
},
"EntitlementArn":{
"shape":"__string",
"locationName":"entitlementArn",
"documentation":"The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow."
},
"FlowArn":{
"shape":"__string",
"location":"uri",
"locationName":"flowArn",
"documentation":"The flow that is associated with the source that you want to update."
},
"IngestPort":{
"shape":"__integer",
"locationName":"ingestPort",
"documentation":"The port that the flow will be listening on for incoming content."
"documentation":"The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
"documentation":"The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."
}
},
"documentation":"A request to update the source of a flow.",
"required":[
"FlowArn",
"SourceArn"
]
},
"UpdateFlowSourceResponse":{
"type":"structure",
"members":{
"FlowArn":{
"shape":"__string",
"locationName":"flowArn",
"documentation":"The ARN of the flow that you want to update."
},
"Source":{
"shape":"Source",
"locationName":"source",
"documentation":"The settings for the source of the flow."