create_recording_configuration
¶
create_recording_configuration(
destination_configuration: DestinationConfiguration,
*,
config_overrides: Optional[ivsClientConfig] = None,
name: Optional[RecordingConfigurationName] = None,
tags: Optional[Tags] = None,
thumbnail_configuration: Optional[ThumbnailConfiguration] = None,
recording_reconnect_window_seconds: Optional[
RecordingReconnectWindowSeconds
] = None,
rendition_configuration: Optional[RenditionConfiguration] = None,
) -> CreateRecordingConfigurationResponse
Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)
Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
Parameters:
-
name(Optional[RecordingConfigurationName], default:None) –Recording-configuration name. The value does not need to be unique.
-
destination_configuration(DestinationConfiguration) –A complex type that contains a destination configuration for where recorded video will be stored.
-
tags(Optional[Tags], default:None) –Array of 1-50 maps, each of the form
string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there. -
thumbnail_configuration(Optional[ThumbnailConfiguration], default:None) –A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
-
recording_reconnect_window_seconds(Optional[RecordingReconnectWindowSeconds], default:None) –If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
-
rendition_configuration(Optional[RenditionConfiguration], default:None) –Object that describes which renditions should be recorded for a stream.
Raises:
-
AccessDeniedException–User does not have sufficient access to perform this action.
-
ConflictException–Updating or deleting a resource can cause an inconsistent state.
-
InternalServerException–Unexpected error during processing of request.
-
PendingVerification–Your account is pending verification.
-
ServiceQuotaExceededException–Request would cause a service quota to be exceeded.
-
ValidationException–The input fails to satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_ivs/_services/ivs.py
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 | |