emr – github.com/aws/aws-sdk-go-v2/service/emr Index | Files | Directories

package emr

import "github.com/aws/aws-sdk-go-v2/service/emr"

Package emr provides the API client, operations, and parameter types for Amazon Elastic MapReduce.

Amazon EMR is a web service that makes it easier to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS services to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehouse management.

Index

Constants

const ServiceAPIVersion = "2009-03-31"
const ServiceID = "EMR"

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AddInstanceFleetInput

type AddInstanceFleetInput struct {

	// The unique identifier of the cluster.
	//
	// This member is required.
	ClusterId *string

	// Specifies the configuration of the instance fleet.
	//
	// This member is required.
	InstanceFleet *types.InstanceFleetConfig
}

type AddInstanceFleetOutput

type AddInstanceFleetOutput struct {

	// The Amazon Resource Name of the cluster.
	ClusterArn *string

	// The unique identifier of the cluster.
	ClusterId *string

	// The unique identifier of the instance fleet.
	InstanceFleetId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AddInstanceGroupsInput

type AddInstanceGroupsInput struct {

	// Instance groups to add.
	//
	// This member is required.
	InstanceGroups []types.InstanceGroupConfig

	// Job flow in which to add the instance groups.
	//
	// This member is required.
	JobFlowId *string
}

Input to an AddInstanceGroups call.

type AddInstanceGroupsOutput

type AddInstanceGroupsOutput struct {

	// The Amazon Resource Name of the cluster.
	ClusterArn *string

	// Instance group IDs of the newly created instance groups.
	InstanceGroupIds []string

	// The job flow ID in which the instance groups are added.
	JobFlowId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Output from an AddInstanceGroups call.

type AddJobFlowStepsInput

type AddJobFlowStepsInput struct {

	// A string that uniquely identifies the job flow. This identifier is returned by
	// RunJobFlow and can also be obtained from ListClusters.
	//
	// This member is required.
	JobFlowId *string

	// A list of StepConfig to be executed by the job flow.
	//
	// This member is required.
	Steps []types.StepConfig
}

The input argument to the AddJobFlowSteps operation.

type AddJobFlowStepsOutput

type AddJobFlowStepsOutput struct {

	// The identifiers of the list of steps added to the job flow.
	StepIds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output for the AddJobFlowSteps operation.

type AddTagsInput

type AddTagsInput struct {

	// The Amazon EMR resource identifier to which tags will be added. This value must
	// be a cluster identifier.
	//
	// This member is required.
	ResourceId *string

	// A list of tags to associate with a cluster and propagate to EC2 instances. 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 member is required.
	Tags []types.Tag
}

This input identifies a cluster and a list of tags to attach.

type AddTagsOutput

type AddTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

This output indicates the result of adding tags to a resource.

type CancelStepsInput

type CancelStepsInput struct {

	// The ClusterID for the specified steps that will be canceled. Use RunJobFlow and
	// ListClusters to get ClusterIDs.
	//
	// This member is required.
	ClusterId *string

	// The list of StepIDs to cancel. Use ListSteps to get steps and their states for
	// the specified cluster.
	//
	// This member is required.
	StepIds []string

	// The option to choose to cancel RUNNING steps. By default, the value is
	// SEND_INTERRUPT.
	StepCancellationOption types.StepCancellationOption
}

The input argument to the CancelSteps operation.

type CancelStepsOutput

type CancelStepsOutput struct {

	// A list of CancelStepsInfo, which shows the status of specified cancel requests
	// for each StepID specified.
	CancelStepsInfoList []types.CancelStepsInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output for the CancelSteps operation.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Elastic MapReduce.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AddInstanceFleet

func (c *Client) AddInstanceFleet(ctx context.Context, params *AddInstanceFleetInput, optFns ...func(*Options)) (*AddInstanceFleetOutput, error)

Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.

func (*Client) AddInstanceGroups

func (c *Client) AddInstanceGroups(ctx context.Context, params *AddInstanceGroupsInput, optFns ...func(*Options)) (*AddInstanceGroupsOutput, error)

Adds one or more instance groups to a running cluster.

func (*Client) AddJobFlowSteps

func (c *Client) AddJobFlowSteps(ctx context.Context, params *AddJobFlowStepsInput, optFns ...func(*Options)) (*AddJobFlowStepsOutput, error)

AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster (https://docs.aws.amazon.com/emr/latest/ManagementGuide/AddMoreThan256Steps.html) in the Amazon EMR Management Guide. A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.

func (*Client) AddTags

func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error)

Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html).

func (*Client) CancelSteps

func (c *Client) CancelSteps(ctx context.Context, params *CancelStepsInput, optFns ...func(*Options)) (*CancelStepsOutput, error)

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state.

func (*Client) CreateSecurityConfiguration

func (c *Client) CreateSecurityConfiguration(ctx context.Context, params *CreateSecurityConfigurationInput, optFns ...func(*Options)) (*CreateSecurityConfigurationOutput, error)

Creates a security configuration, which is stored in the service and can be specified when a cluster is created.

func (*Client) CreateStudio

func (c *Client) CreateStudio(ctx context.Context, params *CreateStudioInput, optFns ...func(*Options)) (*CreateStudioOutput, error)

Creates a new Amazon EMR Studio.

func (*Client) CreateStudioSessionMapping

func (c *Client) CreateStudioSessionMapping(ctx context.Context, params *CreateStudioSessionMappingInput, optFns ...func(*Options)) (*CreateStudioSessionMappingOutput, error)

Maps a user or group to the Amazon EMR Studio specified by StudioId, and applies a session policy to refine Studio permissions for that user or group.

func (*Client) DeleteSecurityConfiguration

func (c *Client) DeleteSecurityConfiguration(ctx context.Context, params *DeleteSecurityConfigurationInput, optFns ...func(*Options)) (*DeleteSecurityConfigurationOutput, error)

Deletes a security configuration.

func (*Client) DeleteStudio

func (c *Client) DeleteStudio(ctx context.Context, params *DeleteStudioInput, optFns ...func(*Options)) (*DeleteStudioOutput, error)

Removes an Amazon EMR Studio from the Studio metadata store.

func (*Client) DeleteStudioSessionMapping

func (c *Client) DeleteStudioSessionMapping(ctx context.Context, params *DeleteStudioSessionMappingInput, optFns ...func(*Options)) (*DeleteStudioSessionMappingOutput, error)

Removes a user or group from an Amazon EMR Studio.

func (*Client) DescribeCluster

func (c *Client) DescribeCluster(ctx context.Context, params *DescribeClusterInput, optFns ...func(*Options)) (*DescribeClusterOutput, error)

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.

func (*Client) DescribeJobFlows

func (c *Client) DescribeJobFlows(ctx context.Context, params *DescribeJobFlowsInput, optFns ...func(*Options)) (*DescribeJobFlowsOutput, error)

This API is no longer supported and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. Regardless of supplied parameters, only job flows created within the last two months are returned. If no parameters are supplied, then job flows matching either of the following criteria are returned:

* Job flows created and completed in the last two weeks

* Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING

Amazon EMR can return a maximum of 512 job flow descriptions.

Deprecated: This operation has been deprecated.

func (*Client) DescribeNotebookExecution

func (c *Client) DescribeNotebookExecution(ctx context.Context, params *DescribeNotebookExecutionInput, optFns ...func(*Options)) (*DescribeNotebookExecutionOutput, error)

Provides details of a notebook execution.

func (*Client) DescribeSecurityConfiguration

func (c *Client) DescribeSecurityConfiguration(ctx context.Context, params *DescribeSecurityConfigurationInput, optFns ...func(*Options)) (*DescribeSecurityConfigurationOutput, error)

Provides the details of a security configuration by returning the configuration JSON.

func (*Client) DescribeStep

func (c *Client) DescribeStep(ctx context.Context, params *DescribeStepInput, optFns ...func(*Options)) (*DescribeStepOutput, error)

Provides more detail about the cluster step.

func (*Client) DescribeStudio

func (c *Client) DescribeStudio(ctx context.Context, params *DescribeStudioInput, optFns ...func(*Options)) (*DescribeStudioOutput, error)

Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.

func (*Client) GetBlockPublicAccessConfiguration

func (c *Client) GetBlockPublicAccessConfiguration(ctx context.Context, params *GetBlockPublicAccessConfigurationInput, optFns ...func(*Options)) (*GetBlockPublicAccessConfigurationOutput, error)

Returns the Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR (https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html) in the Amazon EMR Management Guide.

func (*Client) GetManagedScalingPolicy

func (c *Client) GetManagedScalingPolicy(ctx context.Context, params *GetManagedScalingPolicyInput, optFns ...func(*Options)) (*GetManagedScalingPolicyOutput, error)

Fetches the attached managed scaling policy for an Amazon EMR cluster.

func (*Client) GetStudioSessionMapping

func (c *Client) GetStudioSessionMapping(ctx context.Context, params *GetStudioSessionMappingInput, optFns ...func(*Options)) (*GetStudioSessionMappingOutput, error)

Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).

func (*Client) ListBootstrapActions

func (c *Client) ListBootstrapActions(ctx context.Context, params *ListBootstrapActionsInput, optFns ...func(*Options)) (*ListBootstrapActionsOutput, error)

Provides information about the bootstrap actions associated with a cluster.

func (*Client) ListClusters

func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, optFns ...func(*Options)) (*ListClustersOutput, error)

Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.

func (*Client) ListInstanceFleets

func (c *Client) ListInstanceFleets(ctx context.Context, params *ListInstanceFleetsInput, optFns ...func(*Options)) (*ListInstanceFleetsOutput, error)

Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

func (*Client) ListInstanceGroups

func (c *Client) ListInstanceGroups(ctx context.Context, params *ListInstanceGroupsInput, optFns ...func(*Options)) (*ListInstanceGroupsOutput, error)

Provides all available details about the instance groups in a cluster.

func (*Client) ListInstances

func (c *Client) ListInstances(ctx context.Context, params *ListInstancesInput, optFns ...func(*Options)) (*ListInstancesOutput, error)

Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.

func (*Client) ListNotebookExecutions

func (c *Client) ListNotebookExecutions(ctx context.Context, params *ListNotebookExecutionsInput, optFns ...func(*Options)) (*ListNotebookExecutionsOutput, error)

Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecution calls.

func (*Client) ListSecurityConfigurations

func (c *Client) ListSecurityConfigurations(ctx context.Context, params *ListSecurityConfigurationsInput, optFns ...func(*Options)) (*ListSecurityConfigurationsOutput, error)

Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.

func (*Client) ListSteps

func (c *Client) ListSteps(ctx context.Context, params *ListStepsInput, optFns ...func(*Options)) (*ListStepsOutput, error)

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request of filter by StepStates. You can specify a maximum of 10 stepIDs.

func (*Client) ListStudioSessionMappings

func (c *Client) ListStudioSessionMappings(ctx context.Context, params *ListStudioSessionMappingsInput, optFns ...func(*Options)) (*ListStudioSessionMappingsOutput, error)

Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId.

func (*Client) ListStudios

func (c *Client) ListStudios(ctx context.Context, params *ListStudiosInput, optFns ...func(*Options)) (*ListStudiosOutput, error)

Returns a list of all Amazon EMR Studios associated with the AWS account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.

func (*Client) ModifyCluster

func (c *Client) ModifyCluster(ctx context.Context, params *ModifyClusterInput, optFns ...func(*Options)) (*ModifyClusterOutput, error)

Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.

func (*Client) ModifyInstanceFleet

func (c *Client) ModifyInstanceFleet(ctx context.Context, params *ModifyInstanceFleetInput, optFns ...func(*Options)) (*ModifyInstanceFleetOutput, error)

Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

func (*Client) ModifyInstanceGroups

func (c *Client) ModifyInstanceGroups(ctx context.Context, params *ModifyInstanceGroupsInput, optFns ...func(*Options)) (*ModifyInstanceGroupsOutput, error)

ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.

func (*Client) PutAutoScalingPolicy

func (c *Client) PutAutoScalingPolicy(ctx context.Context, params *PutAutoScalingPolicyInput, optFns ...func(*Options)) (*PutAutoScalingPolicyOutput, error)

Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric.

func (*Client) PutBlockPublicAccessConfiguration

func (c *Client) PutBlockPublicAccessConfiguration(ctx context.Context, params *PutBlockPublicAccessConfigurationInput, optFns ...func(*Options)) (*PutBlockPublicAccessConfigurationOutput, error)

Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR (https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html) in the Amazon EMR Management Guide.

func (*Client) PutManagedScalingPolicy

func (c *Client) PutManagedScalingPolicy(ctx context.Context, params *PutManagedScalingPolicyInput, optFns ...func(*Options)) (*PutManagedScalingPolicyOutput, error)

Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.

func (*Client) RemoveAutoScalingPolicy

func (c *Client) RemoveAutoScalingPolicy(ctx context.Context, params *RemoveAutoScalingPolicyInput, optFns ...func(*Options)) (*RemoveAutoScalingPolicyOutput, error)

Removes an automatic scaling policy from a specified instance group within an EMR cluster.

func (*Client) RemoveManagedScalingPolicy

func (c *Client) RemoveManagedScalingPolicy(ctx context.Context, params *RemoveManagedScalingPolicyInput, optFns ...func(*Options)) (*RemoveManagedScalingPolicyOutput, error)

Removes a managed scaling policy from a specified EMR cluster.

func (*Client) RemoveTags

func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns ...func(*Options)) (*RemoveTagsOutput, error)

Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). The following example removes the stack tag with value Prod from a cluster:

func (*Client) RunJobFlow

func (c *Client) RunJobFlow(ctx context.Context, params *RunJobFlowInput, optFns ...func(*Options)) (*RunJobFlowOutput, error)

RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfigKeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed. For additional protection, you can set the JobFlowInstancesConfigTerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster (https://docs.aws.amazon.com/emr/latest/ManagementGuide/AddMoreThan256Steps.html) in the Amazon EMR Management Guide. For long running clusters, we recommend that you periodically store your results. The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.

func (*Client) SetTerminationProtection

func (c *Client) SetTerminationProtection(ctx context.Context, params *SetTerminationProtectionInput, optFns ...func(*Options)) (*SetTerminationProtectionOutput, error)

SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a cluster. SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage. To terminate a cluster that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false. For more information, seeManaging Cluster Termination (https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html) in the Amazon EMR Management Guide.

func (*Client) SetVisibleToAllUsers

func (c *Client) SetVisibleToAllUsers(ctx context.Context, params *SetVisibleToAllUsersInput, optFns ...func(*Options)) (*SetVisibleToAllUsersOutput, error)

Sets the Cluster$VisibleToAllUsers value, which determines whether the cluster is visible to all IAM users of the AWS account associated with the cluster. Only the IAM user who created the cluster or the AWS account root user can call this action. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If set to false, only the IAM user that created the cluster can perform actions. This action works on running clusters. You can override the default true setting when you create a cluster by using the VisibleToAllUsers parameter with RunJobFlow.

func (*Client) StartNotebookExecution

func (c *Client) StartNotebookExecution(ctx context.Context, params *StartNotebookExecutionInput, optFns ...func(*Options)) (*StartNotebookExecutionOutput, error)

Starts a notebook execution.

func (*Client) StopNotebookExecution

func (c *Client) StopNotebookExecution(ctx context.Context, params *StopNotebookExecutionInput, optFns ...func(*Options)) (*StopNotebookExecutionOutput, error)

Stops a notebook execution.

func (*Client) TerminateJobFlows

func (c *Client) TerminateJobFlows(ctx context.Context, params *TerminateJobFlowsInput, optFns ...func(*Options)) (*TerminateJobFlowsOutput, error)

TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created. The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.

func (*Client) UpdateStudio

func (c *Client) UpdateStudio(ctx context.Context, params *UpdateStudioInput, optFns ...func(*Options)) (*UpdateStudioOutput, error)

Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.

func (*Client) UpdateStudioSessionMapping

func (c *Client) UpdateStudioSessionMapping(ctx context.Context, params *UpdateStudioSessionMappingInput, optFns ...func(*Options)) (*UpdateStudioSessionMappingOutput, error)

Updates the session policy attached to the user or group for the specified Amazon EMR Studio.

type ClusterRunningWaiter

type ClusterRunningWaiter struct {
	// contains filtered or unexported fields
}

ClusterRunningWaiter defines the waiters for ClusterRunning

func NewClusterRunningWaiter

func NewClusterRunningWaiter(client DescribeClusterAPIClient, optFns ...func(*ClusterRunningWaiterOptions)) *ClusterRunningWaiter

NewClusterRunningWaiter constructs a ClusterRunningWaiter.

func (*ClusterRunningWaiter) Wait

func (w *ClusterRunningWaiter) Wait(ctx context.Context, params *DescribeClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterRunningWaiterOptions)) error

Wait calls the waiter function for ClusterRunning waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ClusterRunningWaiterOptions

type ClusterRunningWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ClusterRunningWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or set
	// to zero, ClusterRunningWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error)
}

ClusterRunningWaiterOptions are waiter options for ClusterRunningWaiter

type ClusterTerminatedWaiter

type ClusterTerminatedWaiter struct {
	// contains filtered or unexported fields
}

ClusterTerminatedWaiter defines the waiters for ClusterTerminated

func NewClusterTerminatedWaiter

func NewClusterTerminatedWaiter(client DescribeClusterAPIClient, optFns ...func(*ClusterTerminatedWaiterOptions)) *ClusterTerminatedWaiter

NewClusterTerminatedWaiter constructs a ClusterTerminatedWaiter.

func (*ClusterTerminatedWaiter) Wait

Wait calls the waiter function for ClusterTerminated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ClusterTerminatedWaiterOptions

type ClusterTerminatedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ClusterTerminatedWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or set
	// to zero, ClusterTerminatedWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error)
}

ClusterTerminatedWaiterOptions are waiter options for ClusterTerminatedWaiter

type CreateSecurityConfigurationInput

type CreateSecurityConfigurationInput struct {

	// The name of the security configuration.
	//
	// This member is required.
	Name *string

	// The security configuration details in JSON format. For JSON parameters and
	// examples, see Use Security Configurations to Set Up Cluster Security
	// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-security-configurations.html)
	// in the Amazon EMR Management Guide.
	//
	// This member is required.
	SecurityConfiguration *string
}

type CreateSecurityConfigurationOutput

type CreateSecurityConfigurationOutput struct {

	// The date and time the security configuration was created.
	//
	// This member is required.
	CreationDateTime *time.Time

	// The name of the security configuration.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateStudioInput

type CreateStudioInput struct {

	// Specifies whether the Studio authenticates users using single sign-on (SSO) or
	// IAM. Amazon EMR Studio currently only supports SSO authentication.
	//
	// This member is required.
	AuthMode types.AuthMode

	// The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook
	// files.
	//
	// This member is required.
	DefaultS3Location *string

	// The ID of the Amazon EMR Studio Engine security group. The Engine security group
	// allows inbound network traffic from the Workspace security group, and it must be
	// in the same VPC specified by VpcId.
	//
	// This member is required.
	EngineSecurityGroupId *string

	// A descriptive name for the Amazon EMR Studio.
	//
	// This member is required.
	Name *string

	// The IAM role that will be assumed by the Amazon EMR Studio. The service role
	// provides a way for Amazon EMR Studio to interoperate with other AWS services.
	//
	// This member is required.
	ServiceRole *string

	// A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have
	// a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId.
	// Studio users can create a Workspace in any of the specified subnets.
	//
	// This member is required.
	SubnetIds []string

	// The IAM user role that will be assumed by users and groups logged in to an
	// Amazon EMR Studio. The permissions attached to this IAM role can be scoped down
	// for each user or group using session policies.
	//
	// This member is required.
	UserRole *string

	// The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the
	// Studio.
	//
	// This member is required.
	VpcId *string

	// The ID of the Amazon EMR Studio Workspace security group. The Workspace security
	// group allows outbound network traffic to resources in the Engine security group,
	// and it must be in the same VPC specified by VpcId.
	//
	// This member is required.
	WorkspaceSecurityGroupId *string

	// A detailed description of the Amazon EMR Studio.
	Description *string

	// A list of tags to associate with the Amazon EMR Studio. 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.
	Tags []types.Tag
}

type CreateStudioOutput

type CreateStudioOutput struct {

	// The ID of the Amazon EMR Studio.
	StudioId *string

	// The unique Studio access URL.
	Url *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateStudioSessionMappingInput

type CreateStudioSessionMappingInput struct {

	// Specifies whether the identity to map to the Amazon EMR Studio is a user or a
	// group.
	//
	// This member is required.
	IdentityType types.IdentityType

	// The Amazon Resource Name (ARN) for the session policy that will be applied to
	// the user or group. Session policies refine Studio user permissions without the
	// need to use multiple IAM user roles.
	//
	// This member is required.
	SessionPolicyArn *string

	// The ID of the Amazon EMR Studio to which the user or group will be mapped.
	//
	// This member is required.
	StudioId *string

	// The globally unique identifier (GUID) of the user or group from the AWS SSO
	// Identity Store. For more information, see UserId
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId)
	// and GroupId
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId)
	// in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId
	// must be specified.
	IdentityId *string

	// The name of the user or group. For more information, see UserName
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName)
	// and DisplayName
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName)
	// in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId
	// must be specified.
	IdentityName *string
}

type CreateStudioSessionMappingOutput

type CreateStudioSessionMappingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteSecurityConfigurationInput

type DeleteSecurityConfigurationInput struct {

	// The name of the security configuration.
	//
	// This member is required.
	Name *string
}

type DeleteSecurityConfigurationOutput

type DeleteSecurityConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteStudioInput

type DeleteStudioInput struct {

	// The ID of the Amazon EMR Studio.
	//
	// This member is required.
	StudioId *string
}

type DeleteStudioOutput

type DeleteStudioOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteStudioSessionMappingInput

type DeleteStudioSessionMappingInput struct {

	// Specifies whether the identity to delete from the Amazon EMR Studio is a user or
	// a group.
	//
	// This member is required.
	IdentityType types.IdentityType

	// The ID of the Amazon EMR Studio.
	//
	// This member is required.
	StudioId *string

	// The globally unique identifier (GUID) of the user or group to remove from the
	// Amazon EMR Studio. For more information, see UserId
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId)
	// and GroupId
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId)
	// in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId
	// must be specified.
	IdentityId *string

	// The name of the user name or group to remove from the Amazon EMR Studio. For
	// more information, see UserName
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName)
	// and DisplayName
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName)
	// in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId
	// must be specified.
	IdentityName *string
}

type DeleteStudioSessionMappingOutput

type DeleteStudioSessionMappingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeClusterAPIClient

type DescribeClusterAPIClient interface {
	DescribeCluster(context.Context, *DescribeClusterInput, ...func(*Options)) (*DescribeClusterOutput, error)
}

DescribeClusterAPIClient is a client that implements the DescribeCluster operation.

type DescribeClusterInput

type DescribeClusterInput struct {

	// The identifier of the cluster to describe.
	//
	// This member is required.
	ClusterId *string
}

This input determines which cluster to describe.

type DescribeClusterOutput

type DescribeClusterOutput struct {

	// This output contains the details for the requested cluster.
	Cluster *types.Cluster

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

This output contains the description of the cluster.

type DescribeJobFlowsInput

type DescribeJobFlowsInput struct {

	// Return only job flows created after this date and time.
	CreatedAfter *time.Time

	// Return only job flows created before this date and time.
	CreatedBefore *time.Time

	// Return only job flows whose job flow ID is contained in this list.
	JobFlowIds []string

	// Return only job flows whose state is contained in this list.
	JobFlowStates []types.JobFlowExecutionState
}

The input for the DescribeJobFlows operation.

type DescribeJobFlowsOutput

type DescribeJobFlowsOutput struct {

	// A list of job flows matching the parameters supplied.
	JobFlows []types.JobFlowDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output for the DescribeJobFlows operation.

type DescribeNotebookExecutionInput

type DescribeNotebookExecutionInput struct {

	// The unique identifier of the notebook execution.
	//
	// This member is required.
	NotebookExecutionId *string
}

type DescribeNotebookExecutionOutput

type DescribeNotebookExecutionOutput struct {

	// Properties of the notebook execution.
	NotebookExecution *types.NotebookExecution

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSecurityConfigurationInput

type DescribeSecurityConfigurationInput struct {

	// The name of the security configuration.
	//
	// This member is required.
	Name *string
}

type DescribeSecurityConfigurationOutput

type DescribeSecurityConfigurationOutput struct {

	// The date and time the security configuration was created
	CreationDateTime *time.Time

	// The name of the security configuration.
	Name *string

	// The security configuration details in JSON format.
	SecurityConfiguration *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeStepAPIClient

type DescribeStepAPIClient interface {
	DescribeStep(context.Context, *DescribeStepInput, ...func(*Options)) (*DescribeStepOutput, error)
}

DescribeStepAPIClient is a client that implements the DescribeStep operation.

type DescribeStepInput

type DescribeStepInput struct {

	// The identifier of the cluster with steps to describe.
	//
	// This member is required.
	ClusterId *string

	// The identifier of the step to describe.
	//
	// This member is required.
	StepId *string
}

This input determines which step to describe.

type DescribeStepOutput

type DescribeStepOutput struct {

	// The step details for the requested step identifier.
	Step *types.Step

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

This output contains the description of the cluster step.

type DescribeStudioInput

type DescribeStudioInput struct {

	// The Amazon EMR Studio ID.
	//
	// This member is required.
	StudioId *string
}

type DescribeStudioOutput

type DescribeStudioOutput struct {

	// The Amazon EMR Studio details.
	Studio *types.Studio

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetBlockPublicAccessConfigurationInput

type GetBlockPublicAccessConfigurationInput struct {
}

type GetBlockPublicAccessConfigurationOutput

type GetBlockPublicAccessConfigurationOutput struct {

	// A configuration for Amazon EMR block public access. The configuration applies to
	// all clusters created in your account for the current Region. The configuration
	// specifies whether block public access is enabled. If block public access is
	// enabled, security groups associated with the cluster cannot have rules that
	// allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is
	// specified as an exception using PermittedPublicSecurityGroupRuleRanges in the
	// BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and
	// public access is allowed on this port. You can change this by updating the block
	// public access configuration to remove the exception. For accounts that created
	// clusters in a Region before November 25, 2019, block public access is disabled
	// by default in that Region. To use this feature, you must manually enable and
	// configure it. For accounts that did not create an EMR cluster in a Region before
	// this date, block public access is enabled by default in that Region.
	//
	// This member is required.
	BlockPublicAccessConfiguration *types.BlockPublicAccessConfiguration

	// Properties that describe the AWS principal that created the
	// BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration
	// action as well as the date and time that the configuration was created. Each
	// time a configuration for block public access is updated, Amazon EMR updates this
	// metadata.
	//
	// This member is required.
	BlockPublicAccessConfigurationMetadata *types.BlockPublicAccessConfigurationMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetManagedScalingPolicyInput

type GetManagedScalingPolicyInput struct {

	// Specifies the ID of the cluster for which the managed scaling policy will be
	// fetched.
	//
	// This member is required.
	ClusterId *string
}

type GetManagedScalingPolicyOutput

type GetManagedScalingPolicyOutput struct {

	// Specifies the managed scaling policy that is attached to an Amazon EMR cluster.
	ManagedScalingPolicy *types.ManagedScalingPolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetStudioSessionMappingInput

type GetStudioSessionMappingInput struct {

	// Specifies whether the identity to fetch is a user or a group.
	//
	// This member is required.
	IdentityType types.IdentityType

	// The ID of the Amazon EMR Studio.
	//
	// This member is required.
	StudioId *string

	// The globally unique identifier (GUID) of the user or group. For more
	// information, see UserId
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId)
	// and GroupId
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId)
	// in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId
	// must be specified.
	IdentityId *string

	// The name of the user or group to fetch. For more information, see UserName
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName)
	// and DisplayName
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName)
	// in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId
	// must be specified.
	IdentityName *string
}

type GetStudioSessionMappingOutput

type GetStudioSessionMappingOutput struct {

	// The session mapping details for the specified Amazon EMR Studio and identity,
	// including session policy ARN and creation time.
	SessionMapping *types.SessionMappingDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListBootstrapActionsAPIClient

type ListBootstrapActionsAPIClient interface {
	ListBootstrapActions(context.Context, *ListBootstrapActionsInput, ...func(*Options)) (*ListBootstrapActionsOutput, error)
}

ListBootstrapActionsAPIClient is a client that implements the ListBootstrapActions operation.

type ListBootstrapActionsInput

type ListBootstrapActionsInput struct {

	// The cluster identifier for the bootstrap actions to list.
	//
	// This member is required.
	ClusterId *string

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string
}

This input determines which bootstrap actions to retrieve.

type ListBootstrapActionsOutput

type ListBootstrapActionsOutput struct {

	// The bootstrap actions associated with the cluster.
	BootstrapActions []types.Command

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

This output contains the bootstrap actions detail.

type ListBootstrapActionsPaginator

type ListBootstrapActionsPaginator struct {
	// contains filtered or unexported fields
}

ListBootstrapActionsPaginator is a paginator for ListBootstrapActions

func NewListBootstrapActionsPaginator

NewListBootstrapActionsPaginator returns a new ListBootstrapActionsPaginator

func (*ListBootstrapActionsPaginator) HasMorePages

func (p *ListBootstrapActionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBootstrapActionsPaginator) NextPage

NextPage retrieves the next ListBootstrapActions page.

type ListBootstrapActionsPaginatorOptions

type ListBootstrapActionsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBootstrapActionsPaginatorOptions is the paginator options for ListBootstrapActions

type ListClustersAPIClient

type ListClustersAPIClient interface {
	ListClusters(context.Context, *ListClustersInput, ...func(*Options)) (*ListClustersOutput, error)
}

ListClustersAPIClient is a client that implements the ListClusters operation.

type ListClustersInput

type ListClustersInput struct {

	// The cluster state filters to apply when listing clusters.
	ClusterStates []types.ClusterState

	// The creation date and time beginning value filter for listing clusters.
	CreatedAfter *time.Time

	// The creation date and time end value filter for listing clusters.
	CreatedBefore *time.Time

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string
}

This input determines how the ListClusters action filters the list of clusters that it returns.

type ListClustersOutput

type ListClustersOutput struct {

	// The list of clusters for the account based on the given filters.
	Clusters []types.ClusterSummary

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.

type ListClustersPaginator

type ListClustersPaginator struct {
	// contains filtered or unexported fields
}

ListClustersPaginator is a paginator for ListClusters

func NewListClustersPaginator

func NewListClustersPaginator(client ListClustersAPIClient, params *ListClustersInput, optFns ...func(*ListClustersPaginatorOptions)) *ListClustersPaginator

NewListClustersPaginator returns a new ListClustersPaginator

func (*ListClustersPaginator) HasMorePages

func (p *ListClustersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListClustersPaginator) NextPage

func (p *ListClustersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListClustersOutput, error)

NextPage retrieves the next ListClusters page.

type ListClustersPaginatorOptions

type ListClustersPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListClustersPaginatorOptions is the paginator options for ListClusters

type ListInstanceFleetsAPIClient

type ListInstanceFleetsAPIClient interface {
	ListInstanceFleets(context.Context, *ListInstanceFleetsInput, ...func(*Options)) (*ListInstanceFleetsOutput, error)
}

ListInstanceFleetsAPIClient is a client that implements the ListInstanceFleets operation.

type ListInstanceFleetsInput

type ListInstanceFleetsInput struct {

	// The unique identifier of the cluster.
	//
	// This member is required.
	ClusterId *string

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string
}

type ListInstanceFleetsOutput

type ListInstanceFleetsOutput struct {

	// The list of instance fleets for the cluster and given filters.
	InstanceFleets []types.InstanceFleet

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListInstanceFleetsPaginator

type ListInstanceFleetsPaginator struct {
	// contains filtered or unexported fields
}

ListInstanceFleetsPaginator is a paginator for ListInstanceFleets

func NewListInstanceFleetsPaginator

func NewListInstanceFleetsPaginator(client ListInstanceFleetsAPIClient, params *ListInstanceFleetsInput, optFns ...func(*ListInstanceFleetsPaginatorOptions)) *ListInstanceFleetsPaginator

NewListInstanceFleetsPaginator returns a new ListInstanceFleetsPaginator

func (*ListInstanceFleetsPaginator) HasMorePages

func (p *ListInstanceFleetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstanceFleetsPaginator) NextPage

func (p *ListInstanceFleetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstanceFleetsOutput, error)

NextPage retrieves the next ListInstanceFleets page.

type ListInstanceFleetsPaginatorOptions

type ListInstanceFleetsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInstanceFleetsPaginatorOptions is the paginator options for ListInstanceFleets

type ListInstanceGroupsAPIClient

type ListInstanceGroupsAPIClient interface {
	ListInstanceGroups(context.Context, *ListInstanceGroupsInput, ...func(*Options)) (*ListInstanceGroupsOutput, error)
}

ListInstanceGroupsAPIClient is a client that implements the ListInstanceGroups operation.

type ListInstanceGroupsInput

type ListInstanceGroupsInput struct {

	// The identifier of the cluster for which to list the instance groups.
	//
	// This member is required.
	ClusterId *string

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string
}

This input determines which instance groups to retrieve.

type ListInstanceGroupsOutput

type ListInstanceGroupsOutput struct {

	// The list of instance groups for the cluster and given filters.
	InstanceGroups []types.InstanceGroup

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

This input determines which instance groups to retrieve.

type ListInstanceGroupsPaginator

type ListInstanceGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListInstanceGroupsPaginator is a paginator for ListInstanceGroups

func NewListInstanceGroupsPaginator

func NewListInstanceGroupsPaginator(client ListInstanceGroupsAPIClient, params *ListInstanceGroupsInput, optFns ...func(*ListInstanceGroupsPaginatorOptions)) *ListInstanceGroupsPaginator

NewListInstanceGroupsPaginator returns a new ListInstanceGroupsPaginator

func (*ListInstanceGroupsPaginator) HasMorePages

func (p *ListInstanceGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstanceGroupsPaginator) NextPage

func (p *ListInstanceGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstanceGroupsOutput, error)

NextPage retrieves the next ListInstanceGroups page.

type ListInstanceGroupsPaginatorOptions

type ListInstanceGroupsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInstanceGroupsPaginatorOptions is the paginator options for ListInstanceGroups

type ListInstancesAPIClient

type ListInstancesAPIClient interface {
	ListInstances(context.Context, *ListInstancesInput, ...func(*Options)) (*ListInstancesOutput, error)
}

ListInstancesAPIClient is a client that implements the ListInstances operation.

type ListInstancesInput

type ListInstancesInput struct {

	// The identifier of the cluster for which to list the instances.
	//
	// This member is required.
	ClusterId *string

	// The unique identifier of the instance fleet.
	InstanceFleetId *string

	// The node type of the instance fleet. For example MASTER, CORE, or TASK.
	InstanceFleetType types.InstanceFleetType

	// The identifier of the instance group for which to list the instances.
	InstanceGroupId *string

	// The type of instance group for which to list the instances.
	InstanceGroupTypes []types.InstanceGroupType

	// A list of instance states that will filter the instances returned with this
	// request.
	InstanceStates []types.InstanceState

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string
}

This input determines which instances to list.

type ListInstancesOutput

type ListInstancesOutput struct {

	// The list of instances for the cluster and given filters.
	Instances []types.Instance

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

This output contains the list of instances.

type ListInstancesPaginator

type ListInstancesPaginator struct {
	// contains filtered or unexported fields
}

ListInstancesPaginator is a paginator for ListInstances

func NewListInstancesPaginator

func NewListInstancesPaginator(client ListInstancesAPIClient, params *ListInstancesInput, optFns ...func(*ListInstancesPaginatorOptions)) *ListInstancesPaginator

NewListInstancesPaginator returns a new ListInstancesPaginator

func (*ListInstancesPaginator) HasMorePages

func (p *ListInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstancesPaginator) NextPage

func (p *ListInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstancesOutput, error)

NextPage retrieves the next ListInstances page.

type ListInstancesPaginatorOptions

type ListInstancesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInstancesPaginatorOptions is the paginator options for ListInstances

type ListNotebookExecutionsAPIClient

type ListNotebookExecutionsAPIClient interface {
	ListNotebookExecutions(context.Context, *ListNotebookExecutionsInput, ...func(*Options)) (*ListNotebookExecutionsOutput, error)
}

ListNotebookExecutionsAPIClient is a client that implements the ListNotebookExecutions operation.

type ListNotebookExecutionsInput

type ListNotebookExecutionsInput struct {

	// The unique ID of the editor associated with the notebook execution.
	EditorId *string

	// The beginning of time range filter for listing notebook executions. The default
	// is the timestamp of 30 days ago.
	From *time.Time

	// The pagination token, returned by a previous ListNotebookExecutions call, that
	// indicates the start of the list for this ListNotebookExecutions call.
	Marker *string

	// The status filter for listing notebook executions.
	//
	// * START_PENDING indicates
	// that the cluster has received the execution request but execution has not
	// begun.
	//
	// * STARTING indicates that the execution is starting on the cluster.
	//
	// *
	// RUNNING indicates that the execution is being processed by the cluster.
	//
	// *
	// FINISHING indicates that execution processing is in the final stages.
	//
	// *
	// FINISHED indicates that the execution has completed without error.
	//
	// * FAILING
	// indicates that the execution is failing and will not finish successfully.
	//
	// *
	// FAILED indicates that the execution failed.
	//
	// * STOP_PENDING indicates that the
	// cluster has received a StopNotebookExecution request and the stop is pending.
	//
	// *
	// STOPPING indicates that the cluster is in the process of stopping the execution
	// as a result of a StopNotebookExecution request.
	//
	// * STOPPED indicates that the
	// execution stopped because of a StopNotebookExecution request.
	Status types.NotebookExecutionStatus

	// The end of time range filter for listing notebook executions. The default is the
	// current timestamp.
	To *time.Time
}

type ListNotebookExecutionsOutput

type ListNotebookExecutionsOutput struct {

	// A pagination token that a subsequent ListNotebookExecutions can use to determine
	// the next set of results to retrieve.
	Marker *string

	// A list of notebook executions.
	NotebookExecutions []types.NotebookExecutionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListNotebookExecutionsPaginator

type ListNotebookExecutionsPaginator struct {
	// contains filtered or unexported fields
}

ListNotebookExecutionsPaginator is a paginator for ListNotebookExecutions

func NewListNotebookExecutionsPaginator

NewListNotebookExecutionsPaginator returns a new ListNotebookExecutionsPaginator

func (*ListNotebookExecutionsPaginator) HasMorePages

func (p *ListNotebookExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNotebookExecutionsPaginator) NextPage

NextPage retrieves the next ListNotebookExecutions page.

type ListNotebookExecutionsPaginatorOptions

type ListNotebookExecutionsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListNotebookExecutionsPaginatorOptions is the paginator options for ListNotebookExecutions

type ListSecurityConfigurationsAPIClient

type ListSecurityConfigurationsAPIClient interface {
	ListSecurityConfigurations(context.Context, *ListSecurityConfigurationsInput, ...func(*Options)) (*ListSecurityConfigurationsOutput, error)
}

ListSecurityConfigurationsAPIClient is a client that implements the ListSecurityConfigurations operation.

type ListSecurityConfigurationsInput

type ListSecurityConfigurationsInput struct {

	// The pagination token that indicates the set of results to retrieve.
	Marker *string
}

type ListSecurityConfigurationsOutput

type ListSecurityConfigurationsOutput struct {

	// A pagination token that indicates the next set of results to retrieve. Include
	// the marker in the next ListSecurityConfiguration call to retrieve the next page
	// of results, if required.
	Marker *string

	// The creation date and time, and name, of each security configuration.
	SecurityConfigurations []types.SecurityConfigurationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSecurityConfigurationsPaginator

type ListSecurityConfigurationsPaginator struct {
	// contains filtered or unexported fields
}

ListSecurityConfigurationsPaginator is a paginator for ListSecurityConfigurations

func NewListSecurityConfigurationsPaginator

NewListSecurityConfigurationsPaginator returns a new ListSecurityConfigurationsPaginator

func (*ListSecurityConfigurationsPaginator) HasMorePages

func (p *ListSecurityConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSecurityConfigurationsPaginator) NextPage

NextPage retrieves the next ListSecurityConfigurations page.

type ListSecurityConfigurationsPaginatorOptions

type ListSecurityConfigurationsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSecurityConfigurationsPaginatorOptions is the paginator options for ListSecurityConfigurations

type ListStepsAPIClient

type ListStepsAPIClient interface {
	ListSteps(context.Context, *ListStepsInput, ...func(*Options)) (*ListStepsOutput, error)
}

ListStepsAPIClient is a client that implements the ListSteps operation.

type ListStepsInput

type ListStepsInput struct {

	// The identifier of the cluster for which to list the steps.
	//
	// This member is required.
	ClusterId *string

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string

	// The filter to limit the step list based on the identifier of the steps. You can
	// specify a maximum of ten Step IDs. The character constraint applies to the
	// overall length of the array.
	StepIds []string

	// The filter to limit the step list based on certain states.
	StepStates []types.StepState
}

This input determines which steps to list.

type ListStepsOutput

type ListStepsOutput struct {

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string

	// The filtered list of steps for the cluster.
	Steps []types.StepSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.

type ListStepsPaginator

type ListStepsPaginator struct {
	// contains filtered or unexported fields
}

ListStepsPaginator is a paginator for ListSteps

func NewListStepsPaginator

func NewListStepsPaginator(client ListStepsAPIClient, params *ListStepsInput, optFns ...func(*ListStepsPaginatorOptions)) *ListStepsPaginator

NewListStepsPaginator returns a new ListStepsPaginator

func (*ListStepsPaginator) HasMorePages

func (p *ListStepsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStepsPaginator) NextPage

func (p *ListStepsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStepsOutput, error)

NextPage retrieves the next ListSteps page.

type ListStepsPaginatorOptions

type ListStepsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStepsPaginatorOptions is the paginator options for ListSteps

type ListStudioSessionMappingsAPIClient

type ListStudioSessionMappingsAPIClient interface {
	ListStudioSessionMappings(context.Context, *ListStudioSessionMappingsInput, ...func(*Options)) (*ListStudioSessionMappingsOutput, error)
}

ListStudioSessionMappingsAPIClient is a client that implements the ListStudioSessionMappings operation.

type ListStudioSessionMappingsInput

type ListStudioSessionMappingsInput struct {

	// Specifies whether to return session mappings for users or groups. If not
	// specified, the results include session mapping details for both users and
	// groups.
	IdentityType types.IdentityType

	// The pagination token that indicates the set of results to retrieve.
	Marker *string

	// The ID of the Amazon EMR Studio.
	StudioId *string
}

type ListStudioSessionMappingsOutput

type ListStudioSessionMappingsOutput struct {

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string

	// A list of session mapping summary objects. Each object includes session mapping
	// details such as creation time, identity type (user or group), and Amazon EMR
	// Studio ID.
	SessionMappings []types.SessionMappingSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListStudioSessionMappingsPaginator

type ListStudioSessionMappingsPaginator struct {
	// contains filtered or unexported fields
}

ListStudioSessionMappingsPaginator is a paginator for ListStudioSessionMappings

func NewListStudioSessionMappingsPaginator

NewListStudioSessionMappingsPaginator returns a new ListStudioSessionMappingsPaginator

func (*ListStudioSessionMappingsPaginator) HasMorePages

func (p *ListStudioSessionMappingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStudioSessionMappingsPaginator) NextPage

NextPage retrieves the next ListStudioSessionMappings page.

type ListStudioSessionMappingsPaginatorOptions

type ListStudioSessionMappingsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStudioSessionMappingsPaginatorOptions is the paginator options for ListStudioSessionMappings

type ListStudiosAPIClient

type ListStudiosAPIClient interface {
	ListStudios(context.Context, *ListStudiosInput, ...func(*Options)) (*ListStudiosOutput, error)
}

ListStudiosAPIClient is a client that implements the ListStudios operation.

type ListStudiosInput

type ListStudiosInput struct {

	// The pagination token that indicates the set of results to retrieve.
	Marker *string
}

type ListStudiosOutput

type ListStudiosOutput struct {

	// The pagination token that indicates the next set of results to retrieve.
	Marker *string

	// The list of Studio summary objects.
	Studios []types.StudioSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListStudiosPaginator

type ListStudiosPaginator struct {
	// contains filtered or unexported fields
}

ListStudiosPaginator is a paginator for ListStudios

func NewListStudiosPaginator

func NewListStudiosPaginator(client ListStudiosAPIClient, params *ListStudiosInput, optFns ...func(*ListStudiosPaginatorOptions)) *ListStudiosPaginator

NewListStudiosPaginator returns a new ListStudiosPaginator

func (*ListStudiosPaginator) HasMorePages

func (p *ListStudiosPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStudiosPaginator) NextPage

func (p *ListStudiosPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStudiosOutput, error)

NextPage retrieves the next ListStudios page.

type ListStudiosPaginatorOptions

type ListStudiosPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStudiosPaginatorOptions is the paginator options for ListStudios

type ModifyClusterInput

type ModifyClusterInput struct {

	// The unique identifier of the cluster.
	//
	// This member is required.
	ClusterId *string

	// The number of steps that can be executed concurrently. You can specify a minimum
	// of 1 step and a maximum of 256 steps.
	StepConcurrencyLevel *int32
}

type ModifyClusterOutput

type ModifyClusterOutput struct {

	// The number of steps that can be executed concurrently.
	StepConcurrencyLevel *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ModifyInstanceFleetInput

type ModifyInstanceFleetInput struct {

	// The unique identifier of the cluster.
	//
	// This member is required.
	ClusterId *string

	// The unique identifier of the instance fleet.
	//
	// This member is required.
	InstanceFleet *types.InstanceFleetModifyConfig
}

type ModifyInstanceFleetOutput

type ModifyInstanceFleetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ModifyInstanceGroupsInput

type ModifyInstanceGroupsInput struct {

	// The ID of the cluster to which the instance group belongs.
	ClusterId *string

	// Instance groups to change.
	InstanceGroups []types.InstanceGroupModifyConfig
}

Change the size of some instance groups.

type ModifyInstanceGroupsOutput

type ModifyInstanceGroupsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PutAutoScalingPolicyInput

type PutAutoScalingPolicyInput struct {

	// Specifies the definition of the automatic scaling policy.
	//
	// This member is required.
	AutoScalingPolicy *types.AutoScalingPolicy

	// Specifies the ID of a cluster. The instance group to which the automatic scaling
	// policy is applied is within this cluster.
	//
	// This member is required.
	ClusterId *string

	// Specifies the ID of the instance group to which the automatic scaling policy is
	// applied.
	//
	// This member is required.
	InstanceGroupId *string
}

type PutAutoScalingPolicyOutput

type PutAutoScalingPolicyOutput struct {

	// The automatic scaling policy definition.
	AutoScalingPolicy *types.AutoScalingPolicyDescription

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string

	// Specifies the ID of a cluster. The instance group to which the automatic scaling
	// policy is applied is within this cluster.
	ClusterId *string

	// Specifies the ID of the instance group to which the scaling policy is applied.
	InstanceGroupId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutBlockPublicAccessConfigurationInput

type PutBlockPublicAccessConfigurationInput struct {

	// A configuration for Amazon EMR block public access. The configuration applies to
	// all clusters created in your account for the current Region. The configuration
	// specifies whether block public access is enabled. If block public access is
	// enabled, security groups associated with the cluster cannot have rules that
	// allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is
	// specified as an exception using PermittedPublicSecurityGroupRuleRanges in the
	// BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and
	// public access is allowed on this port. You can change this by updating
	// BlockPublicSecurityGroupRules to remove the exception. For accounts that created
	// clusters in a Region before November 25, 2019, block public access is disabled
	// by default in that Region. To use this feature, you must manually enable and
	// configure it. For accounts that did not create an EMR cluster in a Region before
	// this date, block public access is enabled by default in that Region.
	//
	// This member is required.
	BlockPublicAccessConfiguration *types.BlockPublicAccessConfiguration
}

type PutBlockPublicAccessConfigurationOutput

type PutBlockPublicAccessConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutManagedScalingPolicyInput

type PutManagedScalingPolicyInput struct {

	// Specifies the ID of an EMR cluster where the managed scaling policy is attached.
	//
	// This member is required.
	ClusterId *string

	// Specifies the constraints for the managed scaling policy.
	//
	// This member is required.
	ManagedScalingPolicy *types.ManagedScalingPolicy
}

type PutManagedScalingPolicyOutput

type PutManagedScalingPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RemoveAutoScalingPolicyInput

type RemoveAutoScalingPolicyInput struct {

	// Specifies the ID of a cluster. The instance group to which the automatic scaling
	// policy is applied is within this cluster.
	//
	// This member is required.
	ClusterId *string

	// Specifies the ID of the instance group to which the scaling policy is applied.
	//
	// This member is required.
	InstanceGroupId *string
}

type RemoveAutoScalingPolicyOutput

type RemoveAutoScalingPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RemoveManagedScalingPolicyInput

type RemoveManagedScalingPolicyInput struct {

	// Specifies the ID of the cluster from which the managed scaling policy will be
	// removed.
	//
	// This member is required.
	ClusterId *string
}

type RemoveManagedScalingPolicyOutput

type RemoveManagedScalingPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RemoveTagsInput

type RemoveTagsInput struct {

	// The Amazon EMR resource identifier from which tags will be removed. This value
	// must be a cluster identifier.
	//
	// This member is required.
	ResourceId *string

	// A list of tag keys to remove from a resource.
	//
	// This member is required.
	TagKeys []string
}

This input identifies a cluster and a list of tags to remove.

type RemoveTagsOutput

type RemoveTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

This output indicates the result of removing tags from a resource.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type RunJobFlowInput

type RunJobFlowInput struct {

	// A specification of the number and type of Amazon EC2 instances.
	//
	// This member is required.
	Instances *types.JobFlowInstancesConfig

	// The name of the job flow.
	//
	// This member is required.
	Name *string

	// A JSON string for selecting additional features.
	AdditionalInfo *string

	// Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0
	// and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
	AmiVersion *string

	// Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of
	// applications for Amazon EMR to install and configure when launching the cluster.
	// For a list of applications available for each Amazon EMR release version, see
	// the Amazon EMR Release Guide
	// (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/).
	Applications []types.Application

	// An IAM role for automatic scaling policies. The default role is
	// EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the
	// automatic scaling feature requires to launch and terminate EC2 instances in an
	// instance group.
	AutoScalingRole *string

	// A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
	BootstrapActions []types.BootstrapActionConfig

	// For Amazon EMR releases 4.0 and later. The list of configurations supplied for
	// the EMR cluster you are creating.
	Configurations []types.Configuration

	// Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon
	// EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches
	// cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see
	// Using a Custom AMI
	// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-custom-ami.html) in
	// the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI
	// for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use
	// AmiVersion instead. For information about creating a custom AMI, see Creating an
	// Amazon EBS-Backed Linux AMI
	// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html)
	// in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For
	// information about finding an AMI ID, see Finding a Linux AMI
	// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html).
	CustomAmiId *string

	// The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is
	// used for each EC2 instance. Available in Amazon EMR version 4.x and later.
	EbsRootVolumeSize *int32

	// Also called instance profile and EC2 role. An IAM role for an EMR cluster. The
	// EC2 instances of the cluster assume this role. The default role is
	// EMR_EC2_DefaultRole. In order to use the default role, you must have already
	// created it using the CLI or console.
	JobFlowRole *string

	// Attributes for Kerberos configuration when Kerberos authentication is enabled
	// using a security configuration. For more information see Use Kerberos
	// Authentication
	// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html) in
	// the Amazon EMR Management Guide.
	KerberosAttributes *types.KerberosAttributes

	// The AWS KMS customer master key (CMK) used for encrypting log files. If a value
	// is not provided, the logs remain encrypted by AES-256. This attribute is only
	// available with Amazon EMR version 5.30.0 and later, excluding Amazon EMR 6.0.0.
	LogEncryptionKmsKeyId *string

	// The location in Amazon S3 to write the log files of the job flow. If a value is
	// not provided, logs are not created.
	LogUri *string

	// The specified managed scaling policy for an Amazon EMR cluster.
	ManagedScalingPolicy *types.ManagedScalingPolicy

	// For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use
	// Applications. A list of strings that indicates third-party software to use with
	// the job flow that accepts a user argument list. EMR accepts and forwards the
	// argument list to the corresponding installation script as bootstrap action
	// arguments. For more information, see "Launch a Job Flow on the MapR Distribution
	// for Hadoop" in the Amazon EMR Developer Guide
	// (https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf). Supported
	// values are:
	//
	// * "mapr-m3" - launch the cluster using MapR M3 Edition.
	//
	// *
	// "mapr-m5" - launch the cluster using MapR M5 Edition.
	//
	// * "mapr" with the user
	// arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow
	// using MapR M3 or M5 Edition respectively.
	//
	// * "mapr-m7" - launch the cluster
	// using MapR M7 Edition.
	//
	// * "hunk" - launch the cluster with the Hunk Big Data
	// Analytics Platform.
	//
	// * "hue"- launch the cluster with Hue installed.
	//
	// * "spark"
	// - launch the cluster with Apache Spark installed.
	//
	// * "ganglia" - launch the
	// cluster with the Ganglia Monitoring System installed.
	NewSupportedProducts []types.SupportedProductConfig

	// The specified placement group configuration for an Amazon EMR cluster.
	PlacementGroupConfigs []types.PlacementGroupConfig

	// The Amazon EMR release label, which determines the version of open-source
	// application packages installed on the cluster. Release labels are in the form
	// emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For
	// more information about Amazon EMR release versions and included application
	// versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/
	// (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). The release label
	// applies only to Amazon EMR releases version 4.0 and later. Earlier versions use
	// AmiVersion.
	ReleaseLabel *string

	// Applies only when CustomAmiID is used. Specifies which updates from the Amazon
	// Linux AMI package repositories to apply automatically when the instance boots
	// using the AMI. If omitted, the default is SECURITY, which indicates that only
	// security updates are applied. If NONE is specified, no updates are applied, and
	// all updates must be applied manually.
	RepoUpgradeOnBoot types.RepoUpgradeOnBoot

	// Specifies the way that individual Amazon EC2 instances terminate when an
	// automatic scale-in activity occurs or an instance group is resized.
	// TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the
	// instance-hour boundary, regardless of when the request to terminate the instance
	// was submitted. This option is only available with Amazon EMR 5.1.0 and later and
	// is the default for clusters created using that version.
	// TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list
	// and drains tasks from nodes before terminating the Amazon EC2 instances,
	// regardless of the instance-hour boundary. With either behavior, Amazon EMR
	// removes the least active nodes first and blocks instance termination if it could
	// lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon
	// EMR version 4.1.0 and later, and is the default for versions of Amazon EMR
	// earlier than 5.1.0.
	ScaleDownBehavior types.ScaleDownBehavior

	// The name of a security configuration to apply to the cluster.
	SecurityConfiguration *string

	// The IAM role that will be assumed by the Amazon EMR service to access AWS
	// resources on your behalf.
	ServiceRole *string

	// Specifies the number of steps that can be executed concurrently. The default
	// value is 1. The maximum value is 256.
	StepConcurrencyLevel *int32

	// A list of steps to run.
	Steps []types.StepConfig

	// For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use
	// Applications. A list of strings that indicates third-party software to use. For
	// more information, see the Amazon EMR Developer Guide
	// (https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf). Currently
	// supported values are:
	//
	// * "mapr-m3" - launch the job flow using MapR M3
	// Edition.
	//
	// * "mapr-m5" - launch the job flow using MapR M5 Edition.
	SupportedProducts []string

	// A list of tags to associate with a cluster and propagate to Amazon EC2
	// instances.
	Tags []types.Tag

	// A value of true indicates that all IAM users in the AWS account can perform
	// cluster actions if they have the proper IAM policy permissions. This is the
	// default. A value of false indicates that only the IAM user who created the
	// cluster can perform actions.
	VisibleToAllUsers bool
}

Input to the RunJobFlow operation.

type RunJobFlowOutput

type RunJobFlowOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string

	// A unique identifier for the job flow.
	JobFlowId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of the RunJobFlow operation.

type SetTerminationProtectionInput

type SetTerminationProtectionInput struct {

	// A list of strings that uniquely identify the clusters to protect. This
	// identifier is returned by RunJobFlow and can also be obtained from
	// DescribeJobFlows .
	//
	// This member is required.
	JobFlowIds []string

	// A Boolean that indicates whether to protect the cluster and prevent the Amazon
	// EC2 instances in the cluster from shutting down due to API calls, user
	// intervention, or job-flow error.
	//
	// This member is required.
	TerminationProtected bool
}

The input argument to the TerminationProtection operation.

type SetTerminationProtectionOutput

type SetTerminationProtectionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetVisibleToAllUsersInput

type SetVisibleToAllUsersInput struct {

	// The unique identifier of the job flow (cluster).
	//
	// This member is required.
	JobFlowIds []string

	// A value of true indicates that all IAM users in the AWS account can perform
	// cluster actions if they have the proper IAM policy permissions. This is the
	// default. A value of false indicates that only the IAM user who created the
	// cluster can perform actions.
	//
	// This member is required.
	VisibleToAllUsers bool
}

The input to the SetVisibleToAllUsers action.

type SetVisibleToAllUsersOutput

type SetVisibleToAllUsersOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartNotebookExecutionInput

type StartNotebookExecutionInput struct {

	// The unique identifier of the EMR Notebook to use for notebook execution.
	//
	// This member is required.
	EditorId *string

	// Specifies the execution engine (cluster) that runs the notebook execution.
	//
	// This member is required.
	ExecutionEngine *types.ExecutionEngineConfig

	// The path and file name of the notebook file for this execution, relative to the
	// path specified for the EMR Notebook. For example, if you specify a path of
	// s3://MyBucket/MyNotebooks when you create an 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.
	//
	// This member is required.
	RelativePath *string

	// The name or ARN of the IAM role that is used as the service role for Amazon EMR
	// (the EMR role) for the notebook execution.
	//
	// This member is required.
	ServiceRole *string

	// An optional name for the notebook execution.
	NotebookExecutionName *string

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

	// Input parameters in JSON format passed to the EMR Notebook at runtime for
	// execution.
	NotebookParams *string

	// 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.
	Tags []types.Tag
}

type StartNotebookExecutionOutput

type StartNotebookExecutionOutput struct {

	// The unique identifier of the notebook execution.
	NotebookExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StepCompleteWaiter

type StepCompleteWaiter struct {
	// contains filtered or unexported fields
}

StepCompleteWaiter defines the waiters for StepComplete

func NewStepCompleteWaiter

func NewStepCompleteWaiter(client DescribeStepAPIClient, optFns ...func(*StepCompleteWaiterOptions)) *StepCompleteWaiter

NewStepCompleteWaiter constructs a StepCompleteWaiter.

func (*StepCompleteWaiter) Wait

func (w *StepCompleteWaiter) Wait(ctx context.Context, params *DescribeStepInput, maxWaitDur time.Duration, optFns ...func(*StepCompleteWaiterOptions)) error

Wait calls the waiter function for StepComplete waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StepCompleteWaiterOptions

type StepCompleteWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StepCompleteWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or set
	// to zero, StepCompleteWaiter will use default max delay of 120 seconds. Note that
	// MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeStepInput, *DescribeStepOutput, error) (bool, error)
}

StepCompleteWaiterOptions are waiter options for StepCompleteWaiter

type StopNotebookExecutionInput

type StopNotebookExecutionInput struct {

	// The unique identifier of the notebook execution.
	//
	// This member is required.
	NotebookExecutionId *string
}

type StopNotebookExecutionOutput

type StopNotebookExecutionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TerminateJobFlowsInput

type TerminateJobFlowsInput struct {

	// A list of job flows to be shut down.
	//
	// This member is required.
	JobFlowIds []string
}

Input to the TerminateJobFlows operation.

type TerminateJobFlowsOutput

type TerminateJobFlowsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateStudioInput

type UpdateStudioInput struct {

	// The ID of the Amazon EMR Studio to update.
	//
	// This member is required.
	StudioId *string

	// The Amazon S3 location to back up Workspaces and notebook files for the Amazon
	// EMR Studio.
	DefaultS3Location *string

	// A detailed description to assign to the Amazon EMR Studio.
	Description *string

	// A descriptive name for the Amazon EMR Studio.
	Name *string

	// A list of subnet IDs to associate with the Amazon EMR Studio. The list can
	// include new subnet IDs, but must also include all of the subnet IDs previously
	// associated with the Studio. The list order does not matter. A Studio can have a
	// maximum of 5 subnets. The subnets must belong to the same VPC as the Studio.
	SubnetIds []string
}

type UpdateStudioOutput

type UpdateStudioOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateStudioSessionMappingInput

type UpdateStudioSessionMappingInput struct {

	// Specifies whether the identity to update is a user or a group.
	//
	// This member is required.
	IdentityType types.IdentityType

	// The Amazon Resource Name (ARN) of the session policy to associate with the
	// specified user or group.
	//
	// This member is required.
	SessionPolicyArn *string

	// The ID of the Amazon EMR Studio.
	//
	// This member is required.
	StudioId *string

	// The globally unique identifier (GUID) of the user or group. For more
	// information, see UserId
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId)
	// and GroupId
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId)
	// in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId
	// must be specified.
	IdentityId *string

	// The name of the user or group to update. For more information, see UserName
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName)
	// and DisplayName
	// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName)
	// in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId
	// must be specified.
	IdentityName *string
}

type UpdateStudioSessionMappingOutput

type UpdateStudioSessionMappingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

api_client.go api_op_AddInstanceFleet.go api_op_AddInstanceGroups.go api_op_AddJobFlowSteps.go api_op_AddTags.go api_op_CancelSteps.go api_op_CreateSecurityConfiguration.go api_op_CreateStudio.go api_op_CreateStudioSessionMapping.go api_op_DeleteSecurityConfiguration.go api_op_DeleteStudio.go api_op_DeleteStudioSessionMapping.go api_op_DescribeCluster.go api_op_DescribeJobFlows.go api_op_DescribeNotebookExecution.go api_op_DescribeSecurityConfiguration.go api_op_DescribeStep.go api_op_DescribeStudio.go api_op_GetBlockPublicAccessConfiguration.go api_op_GetManagedScalingPolicy.go api_op_GetStudioSessionMapping.go api_op_ListBootstrapActions.go api_op_ListClusters.go api_op_ListInstanceFleets.go api_op_ListInstanceGroups.go api_op_ListInstances.go api_op_ListNotebookExecutions.go api_op_ListSecurityConfigurations.go api_op_ListSteps.go api_op_ListStudioSessionMappings.go api_op_ListStudios.go api_op_ModifyCluster.go api_op_ModifyInstanceFleet.go api_op_ModifyInstanceGroups.go api_op_PutAutoScalingPolicy.go api_op_PutBlockPublicAccessConfiguration.go api_op_PutManagedScalingPolicy.go api_op_RemoveAutoScalingPolicy.go api_op_RemoveManagedScalingPolicy.go api_op_RemoveTags.go api_op_RunJobFlow.go api_op_SetTerminationProtection.go api_op_SetVisibleToAllUsers.go api_op_StartNotebookExecution.go api_op_StopNotebookExecution.go api_op_TerminateJobFlows.go api_op_UpdateStudio.go api_op_UpdateStudioSessionMapping.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v1.4.1
Published
Jul 15, 2021
Platform
js/wasm
Imports
31 packages
Last checked
now

Tools for package owners.