Class CreateMediaCapturePipelineRequest

    • Method Detail

      • sourceTypeAsString

        public final String sourceTypeAsString()

        Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

        If the service returns an enum value that is not available in the current SDK version, sourceType will return MediaPipelineSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

        Returns:
        Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
        See Also:
        MediaPipelineSourceType
      • sourceArn

        public final String sourceArn()

        ARN of the source from which the media artifacts are captured.

        Returns:
        ARN of the source from which the media artifacts are captured.
      • sinkTypeAsString

        public final String sinkTypeAsString()

        Destination type to which the media artifacts are saved. You must use an S3 bucket.

        If the service returns an enum value that is not available in the current SDK version, sinkType will return MediaPipelineSinkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sinkTypeAsString().

        Returns:
        Destination type to which the media artifacts are saved. You must use an S3 bucket.
        See Also:
        MediaPipelineSinkType
      • sinkArn

        public final String sinkArn()

        The ARN of the sink type.

        Returns:
        The ARN of the sink type.
      • clientRequestToken

        public final String clientRequestToken()

        The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

        Returns:
        The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.
      • chimeSdkMeetingConfiguration

        public final ChimeSdkMeetingConfiguration chimeSdkMeetingConfiguration()

        The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

        Returns:
        The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.
      • sseAwsKeyManagementParams

        public final SseAwsKeyManagementParams sseAwsKeyManagementParams()

        An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

        Returns:
        An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.
      • sinkIamRoleArn

        public final String sinkIamRoleArn()

        The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for SinkIamRoleArn.

        Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.

        Returns:
        The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for SinkIamRoleArn.

        Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final List<Tag> tags()

        The tag key-value pairs.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tag key-value pairs.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object