create_stream ¶

create_stream(
    stream_id: StreamId,
    files: StreamFiles,
    role_arn: RoleArn,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    description: Optional[StreamDescription] = None,
    tags: Optional[TagList] = None,
) -> CreateStreamResponse

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.

Requires permission to access the CreateStream action.

Parameters:

stream_id (StreamId) –

The stream ID.
description (Optional[StreamDescription], default: None ) –

A description of the stream.
files (StreamFiles) –

The files to stream.
role_arn (RoleArn) –

An IAM role that allows the IoT service principal to access your S3 files.
tags (Optional[TagList], default: None ) –

Metadata which can be used to manage streams.

Raises:

InternalFailureException –

An unexpected error has occurred.
InvalidRequestException –

The request is not valid.
LimitExceededException –

A limit has been exceeded.
ResourceAlreadyExistsException –

The resource already exists.
ResourceNotFoundException –

The specified resource does not exist.
ServiceUnavailableException –

The service is temporarily unavailable.
ThrottlingException –

The rate exceeds the limit.
UnauthorizedException –

You are not authorized to perform this operation.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iot/_services/io_t.py

def create_stream(
    self,
    stream_id: "capo_iot.types.stream_id.StreamId",
    files: "capo_iot.types.stream_files.StreamFiles",
    role_arn: "capo_iot.types.role_arn.RoleArn",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    description: Optional[
        "capo_iot.types.stream_description.StreamDescription"
    ] = None,
    tags: Optional["capo_iot.types.tag_list.TagList"] = None,
) -> "capo_iot.types.create_stream_response.CreateStreamResponse":
    """<p>Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateStream</a> action.</p>

    Args:
        stream_id: <p>The stream ID.</p>
        description: <p>A description of the stream.</p>
        files: <p>The files to stream.</p>
        role_arn: <p>An IAM role that allows the IoT service principal to access your S3 files.</p>
        tags: <p>Metadata which can be used to manage streams.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.limit_exceeded_exception.LimitExceededException: <p>A limit has been exceeded.</p>
        capo_iot.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The resource already exists.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.create_stream_request.CreateStreamRequest]",
    ) -> OperationResponse[
        "capo_iot.types.create_stream_response.CreateStreamResponse"
    ]:
        import capo_iot._operations.aws_iot_service.create_stream

        output, http_response = (
            capo_iot._operations.aws_iot_service.create_stream.create_stream(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateStream")
    )
    input_: capo_iot.types.create_stream_request.CreateStreamRequest = {
        "stream_id": stream_id,
        "files": files,
        "role_arn": role_arn,
    }
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output