Package software.amazon.awssdk.services.emr.model

Interface StartNotebookExecutionRequest.Builder

    • Method Detail

      • editorId

        StartNotebookExecutionRequest.Builder editorId​(String editorId)

        The unique identifier of the Amazon EMR Notebook to use for notebook execution.

        Parameters:
        editorId - The unique identifier of the Amazon EMR Notebook to use for notebook execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • relativePath

        StartNotebookExecutionRequest.Builder relativePath​(String relativePath)

        The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .

        Parameters:
        relativePath - The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notebookExecutionName

        StartNotebookExecutionRequest.Builder notebookExecutionName​(String notebookExecutionName)

        An optional name for the notebook execution.

        Parameters:
        notebookExecutionName - An optional name for the notebook execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notebookParams

        StartNotebookExecutionRequest.Builder notebookParams​(String notebookParams)

        Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

        Parameters:
        notebookParams - Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionEngine

        StartNotebookExecutionRequest.Builder executionEngine​(ExecutionEngineConfig executionEngine)

        Specifies the execution engine (cluster) that runs the notebook execution.

        Parameters:
        executionEngine - Specifies the execution engine (cluster) that runs the notebook execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceRole

        StartNotebookExecutionRequest.Builder serviceRole​(String serviceRole)

        The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.

        Parameters:
        serviceRole - The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notebookInstanceSecurityGroupId

        StartNotebookExecutionRequest.Builder notebookInstanceSecurityGroupId​(String notebookInstanceSecurityGroupId)

        The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.

        Parameters:
        notebookInstanceSecurityGroupId - The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartNotebookExecutionRequest.Builder tags​(Collection<Tag> tags)

        A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

        Parameters:
        tags - A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartNotebookExecutionRequest.Builder tags​(Tag... tags)

        A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

        Parameters:
        tags - A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartNotebookExecutionRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • notebookS3Location

        StartNotebookExecutionRequest.Builder notebookS3Location​(NotebookS3LocationFromInput notebookS3Location)

        The Amazon S3 location for the notebook execution input.

        Parameters:
        notebookS3Location - The Amazon S3 location for the notebook execution input.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputNotebookS3Location

        StartNotebookExecutionRequest.Builder outputNotebookS3Location​(OutputNotebookS3LocationFromInput outputNotebookS3Location)

        The Amazon S3 location for the notebook execution output.

        Parameters:
        outputNotebookS3Location - The Amazon S3 location for the notebook execution output.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environmentVariables

        StartNotebookExecutionRequest.Builder environmentVariables​(Map<String,​String> environmentVariables)

        The environment variables associated with the notebook execution.

        Parameters:
        environmentVariables - The environment variables associated with the notebook execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.