types

Documentation

Index

• type CloudWatchMonitoringConfiguration
• type Configuration
• type ConfigurationOverrides
• type ContainerInfo
• type ContainerInfoMemberEksInfo
• type ContainerProvider
• type ContainerProviderType
  • func (ContainerProviderType) Values() []ContainerProviderType
• type EksInfo
• type Endpoint
• type EndpointState
  • func (EndpointState) Values() []EndpointState
• type FailureReason
  • func (FailureReason) Values() []FailureReason
• type InternalServerException
  • func (e *InternalServerException) Error() string
  • func (e *InternalServerException) ErrorCode() string
  • func (e *InternalServerException) ErrorFault() smithy.ErrorFault
  • func (e *InternalServerException) ErrorMessage() string
• type JobDriver
• type JobRun
• type JobRunState
  • func (JobRunState) Values() []JobRunState
• type MonitoringConfiguration
• type PersistentAppUI
  • func (PersistentAppUI) Values() []PersistentAppUI
• type ResourceNotFoundException
  • func (e *ResourceNotFoundException) Error() string
  • func (e *ResourceNotFoundException) ErrorCode() string
  • func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
  • func (e *ResourceNotFoundException) ErrorMessage() string
• type S3MonitoringConfiguration
• type SparkSubmitJobDriver
• type UnknownUnionMember
• type ValidationException
  • func (e *ValidationException) Error() string
  • func (e *ValidationException) ErrorCode() string
  • func (e *ValidationException) ErrorFault() smithy.ErrorFault
  • func (e *ValidationException) ErrorMessage() string
• type VirtualCluster
• type VirtualClusterState
  • func (VirtualClusterState) Values() []VirtualClusterState

Examples

• ContainerInfo (OutputUsage)

Types

type CloudWatchMonitoringConfiguration

type CloudWatchMonitoringConfiguration struct {

	// The name of the log group for log publishing.
	//
	// This member is required.
	LogGroupName *string

	// The specified name prefix for log streams.
	LogStreamNamePrefix *string
}

A configuration for CloudWatch monitoring. You can configure your jobs to send log information to CloudWatch Logs.

type Configuration

type Configuration struct {

	// The classification within a configuration.
	//
	// This member is required.
	Classification *string

	// A list of additional configurations to apply within a configuration object.
	Configurations []Configuration

	// A set of properties specified within a configuration classification.
	Properties map[string]string
}

A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

type ConfigurationOverrides

type ConfigurationOverrides struct {

	// The configurations for the application running by the job run.
	ApplicationConfiguration []Configuration

	// The configurations for monitoring.
	MonitoringConfiguration *MonitoringConfiguration
}

A configuration specification to be used to override existing configurations.

type ContainerInfo

type ContainerInfo interface {
	// contains filtered or unexported methods
}

The information about the container used for a job run or a managed endpoint.

The following types satisfy this interface:

ContainerInfoMemberEksInfo

Example (OutputUsage)

// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/emrcontainers/types"
)

func main() {
	var union types.ContainerInfo
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ContainerInfoMemberEksInfo:
		_ = v.Value // Value is types.EksInfo

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *types.EksInfo

type ContainerInfoMemberEksInfo

type ContainerInfoMemberEksInfo struct {
	Value EksInfo
}

The information about the EKS cluster.

type ContainerProvider

type ContainerProvider struct {

	// The ID of the container cluster.
	//
	// This member is required.
	Id *string

	// The type of the container provider. EKS is the only supported type as of now.
	//
	// This member is required.
	Type ContainerProviderType

	// The information about the container cluster.
	Info ContainerInfo
}

The information about the container provider.

type ContainerProviderType

type ContainerProviderType string

const (
	ContainerProviderTypeEks ContainerProviderType = "EKS"
)

Enum values for ContainerProviderType

func (ContainerProviderType) Values

func (ContainerProviderType) Values() []ContainerProviderType

Values returns all known values for ContainerProviderType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EksInfo

type EksInfo struct {

	// The namespaces of the EKS cluster.
	Namespace *string
}

The information about the EKS cluster.

type Endpoint

type Endpoint struct {

	// The ARN of the endpoint.
	Arn *string

	// The certificate ARN of the endpoint.
	CertificateArn *string

	// The configuration settings that are used to override existing configurations for
	// endpoints.
	ConfigurationOverrides *ConfigurationOverrides

	// The date and time when the endpoint was created.
	CreatedAt *time.Time

	// The execution role ARN of the endpoint.
	ExecutionRoleArn *string

	// The ID of the endpoint.
	Id *string

	// The name of the endpoint.
	Name *string

	// The EMR release version to be used for the endpoint.
	ReleaseLabel *string

	// The security group configuration of the endpoint.
	SecurityGroup *string

	// The server URL of the endpoint.
	ServerUrl *string

	// The state of the endpoint.
	State EndpointState

	// The subnet IDs of the endpoint.
	SubnetIds []string

	// The tags of the endpoint.
	Tags map[string]string

	// The type of the endpoint.
	Type *string

	// The ID of the endpoint's virtual cluster.
	VirtualClusterId *string
}

This entity represents the endpoint that is managed by Amazon EMR on EKS.

type EndpointState

type EndpointState string

const (
	EndpointStateCreating             EndpointState = "CREATING"
	EndpointStateActive               EndpointState = "ACTIVE"
	EndpointStateTerminating          EndpointState = "TERMINATING"
	EndpointStateTerminated           EndpointState = "TERMINATED"
	EndpointStateTerminatedWithErrors EndpointState = "TERMINATED_WITH_ERRORS"
)

Enum values for EndpointState

func (EndpointState) Values

func (EndpointState) Values() []EndpointState

Values returns all known values for EndpointState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FailureReason

type FailureReason string

const (
	FailureReasonInternalError      FailureReason = "INTERNAL_ERROR"
	FailureReasonUserError          FailureReason = "USER_ERROR"
	FailureReasonValidationError    FailureReason = "VALIDATION_ERROR"
	FailureReasonClusterUnavailable FailureReason = "CLUSTER_UNAVAILABLE"
)

Enum values for FailureReason

func (FailureReason) Values

func (FailureReason) Values() []FailureReason

Values returns all known values for FailureReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException

type InternalServerException struct {
	Message *string
}

This is an internal server exception.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type JobDriver

type JobDriver struct {

	// The job driver parameters specified for spark submit.
	SparkSubmitJobDriver *SparkSubmitJobDriver
}

Specify the driver that the job runs on.

type JobRun

type JobRun struct {

	// The ARN of job run.
	Arn *string

	// The client token used to start a job run.
	ClientToken *string

	// The configuration settings that are used to override default configuration.
	ConfigurationOverrides *ConfigurationOverrides

	// The date and time when the job run was created.
	CreatedAt *time.Time

	// The user who created the job run.
	CreatedBy *string

	// The execution role ARN of the job run.
	ExecutionRoleArn *string

	// The reasons why the job run has failed.
	FailureReason FailureReason

	// The date and time when the job run has finished.
	FinishedAt *time.Time

	// The ID of the job run.
	Id *string

	// Parameters of job driver for the job run.
	JobDriver *JobDriver

	// The name of the job run.
	Name *string

	// The release version of Amazon EMR.
	ReleaseLabel *string

	// The state of the job run.
	State JobRunState

	// Additional details of the job run state.
	StateDetails *string

	// The assigned tags of the job run.
	Tags map[string]string

	// The ID of the job run's virtual cluster.
	VirtualClusterId *string
}

This entity describes a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

type JobRunState

type JobRunState string

const (
	JobRunStatePending       JobRunState = "PENDING"
	JobRunStateSubmitted     JobRunState = "SUBMITTED"
	JobRunStateRunning       JobRunState = "RUNNING"
	JobRunStateFailed        JobRunState = "FAILED"
	JobRunStateCancelled     JobRunState = "CANCELLED"
	JobRunStateCancelPending JobRunState = "CANCEL_PENDING"
	JobRunStateCompleted     JobRunState = "COMPLETED"
)

Enum values for JobRunState

func (JobRunState) Values

func (JobRunState) Values() []JobRunState

Values returns all known values for JobRunState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MonitoringConfiguration

type MonitoringConfiguration struct {

	// Monitoring configurations for CloudWatch.
	CloudWatchMonitoringConfiguration *CloudWatchMonitoringConfiguration

	// Monitoring configurations for the persistent application UI.
	PersistentAppUI PersistentAppUI

	// Amazon S3 configuration for monitoring log publishing.
	S3MonitoringConfiguration *S3MonitoringConfiguration
}

Configuration setting for monitoring.

type PersistentAppUI

type PersistentAppUI string

const (
	PersistentAppUIEnabled  PersistentAppUI = "ENABLED"
	PersistentAppUIDisabled PersistentAppUI = "DISABLED"
)

Enum values for PersistentAppUI

func (PersistentAppUI) Values

func (PersistentAppUI) Values() []PersistentAppUI

Values returns all known values for PersistentAppUI. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string
}

The specified resource was not found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type S3MonitoringConfiguration

type S3MonitoringConfiguration struct {

	// Amazon S3 destination URI for log publishing.
	//
	// This member is required.
	LogUri *string
}

Amazon S3 configuration for monitoring log publishing. You can configure your jobs to send log information to Amazon S3.

type SparkSubmitJobDriver

type SparkSubmitJobDriver struct {

	// The entry point of job application.
	//
	// This member is required.
	EntryPoint *string

	// The arguments for job application.
	EntryPointArguments []string

	// The Spark submit parameters that are used for job runs.
	SparkSubmitParameters *string
}

The information about job driver for Spark submit.

type UnknownUnionMember

type UnknownUnionMember struct {
	Tag   string
	Value []byte
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException

type ValidationException struct {
	Message *string
}

There are invalid parameters in the client request.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

type VirtualCluster

type VirtualCluster struct {

	// The ARN of the virtual cluster.
	Arn *string

	// The container provider of the virtual cluster.
	ContainerProvider *ContainerProvider

	// The date and time when the virtual cluster is created.
	CreatedAt *time.Time

	// The ID of the virtual cluster.
	Id *string

	// The name of the virtual cluster.
	Name *string

	// The state of the virtual cluster.
	State VirtualClusterState

	// The assigned tags of the virtual cluster.
	Tags map[string]string
}

This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run jobs and host endpoints. Multiple virtual clusters can be backed by the same physical cluster. However, each virtual cluster maps to one namespace on an EKS cluster. Virtual clusters do not create any active resources that contribute to your bill or that require lifecycle management outside the service.

type VirtualClusterState

type VirtualClusterState string

const (
	VirtualClusterStateRunning     VirtualClusterState = "RUNNING"
	VirtualClusterStateTerminating VirtualClusterState = "TERMINATING"
	VirtualClusterStateTerminated  VirtualClusterState = "TERMINATED"
	VirtualClusterStateArrested    VirtualClusterState = "ARRESTED"
)

Enum values for VirtualClusterState

func (VirtualClusterState) Values

func (VirtualClusterState) Values() []VirtualClusterState

Values returns all known values for VirtualClusterState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.