types

package
v1.19.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 16, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Application 

type Application struct {

	// The ID of the application.
	//
	// This member is required.
	ApplicationId *string

	// The ARN of the application.
	//
	// This member is required.
	Arn *string

	// The date and time when the application run was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The Amazon EMR release associated with the application.
	//
	// This member is required.
	ReleaseLabel *string

	// The state of the application.
	//
	// This member is required.
	State ApplicationState

	// The type of application, such as Spark or Hive.
	//
	// This member is required.
	Type *string

	// The date and time when the application run was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The CPU architecture of an application.
	Architecture Architecture

	// The configuration for an application to automatically start on job submission.
	AutoStartConfiguration *AutoStartConfig

	// The configuration for an application to automatically stop after a certain
	// amount of time being idle.
	AutoStopConfiguration *AutoStopConfig

	// The image configuration applied to all worker types.
	ImageConfiguration *ImageConfiguration

	// The initial capacity of the application.
	InitialCapacity map[string]InitialCapacityConfig

	// The maximum capacity of the application. This is cumulative across all workers
	// at any given point in time during the lifespan of the application is created. No
	// new resources will be created once any one of the defined limits is hit.
	MaximumCapacity *MaximumAllowedResources

	// The configuration setting for monitoring.
	MonitoringConfiguration *MonitoringConfiguration

	// The name of the application.
	Name *string

	// The network configuration for customer VPC connectivity for the application.
	NetworkConfiguration *NetworkConfiguration

	// The [Configuration] specifications of an application. Each configuration consists of a
	// classification and properties. You use this parameter when creating or updating
	// an application. To see the runtimeConfiguration object of an application, run
	// the [GetApplication]API operation.
	//
	// [Configuration]: https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html
	// [GetApplication]: https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_GetApplication.html
	RuntimeConfiguration []Configuration

	// The state details of the application.
	StateDetails *string

	// The tags assigned to the application.
	Tags map[string]string

	// The specification applied to each worker type.
	WorkerTypeSpecifications map[string]WorkerTypeSpecification
	// contains filtered or unexported fields
}

Information about an application. Amazon EMR Serverless uses applications to run jobs.

type ApplicationState 

type ApplicationState string
const (
	ApplicationStateCreating   ApplicationState = "CREATING"
	ApplicationStateCreated    ApplicationState = "CREATED"
	ApplicationStateStarting   ApplicationState = "STARTING"
	ApplicationStateStarted    ApplicationState = "STARTED"
	ApplicationStateStopping   ApplicationState = "STOPPING"
	ApplicationStateStopped    ApplicationState = "STOPPED"
	ApplicationStateTerminated ApplicationState = "TERMINATED"
)

Enum values for ApplicationState

func (ApplicationState) Values 

func (ApplicationState) Values() []ApplicationState

Values returns all known values for ApplicationState. 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 ApplicationSummary 

type ApplicationSummary struct {

	// The ARN of the application.
	//
	// This member is required.
	Arn *string

	// The date and time when the application was created.
	//
	// This member is required.
	CreatedAt *time.Time

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

	// The Amazon EMR release associated with the application.
	//
	// This member is required.
	ReleaseLabel *string

	// The state of the application.
	//
	// This member is required.
	State ApplicationState

	// The type of application, such as Spark or Hive.
	//
	// This member is required.
	Type *string

	// The date and time when the application was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The CPU architecture of an application.
	Architecture Architecture

	// The name of the application.
	Name *string

	// The state details of the application.
	StateDetails *string
	// contains filtered or unexported fields
}

The summary of attributes associated with an application.

type Architecture added in v1.4.0 

type Architecture string
const (
	ArchitectureArm64 Architecture = "ARM64"
	ArchitectureX8664 Architecture = "X86_64"
)

Enum values for Architecture

func (Architecture) Values added in v1.4.0 

func (Architecture) Values() []Architecture

Values returns all known values for Architecture. 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 AutoStartConfig 

type AutoStartConfig struct {

	// Enables the application to automatically start on job submission. Defaults to
	// true.
	Enabled *bool
	// contains filtered or unexported fields
}

The configuration for an application to automatically start on job submission.

type AutoStopConfig 

type AutoStopConfig struct {

	// Enables the application to automatically stop after a certain amount of time
	// being idle. Defaults to true.
	Enabled *bool

	// The amount of idle time in minutes after which your application will
	// automatically stop. Defaults to 15 minutes.
	IdleTimeoutMinutes *int32
	// contains filtered or unexported fields
}

The configuration for an application to automatically stop after a certain amount of time being idle.

type CloudWatchLoggingConfiguration added in v1.9.0 

type CloudWatchLoggingConfiguration struct {

	// Enables CloudWatch logging.
	//
	// This member is required.
	Enabled *bool

	// The Key Management Service (KMS) key ARN to encrypt the logs that you store in
	// CloudWatch Logs.
	EncryptionKeyArn *string

	// The name of the log group in Amazon CloudWatch Logs where you want to publish
	// your logs.
	LogGroupName *string

	// Prefix for the CloudWatch log stream name.
	LogStreamNamePrefix *string

	// The types of logs that you want to publish to CloudWatch. If you don't specify
	// any log types, driver STDOUT and STDERR logs will be published to CloudWatch
	// Logs by default. For more information including the supported worker types for
	// Hive and Spark, see [Logging for EMR Serverless with CloudWatch].
	//
	//   - Key Valid Values: SPARK_DRIVER , SPARK_EXECUTOR , HIVE_DRIVER , TEZ_TASK
	//
	//   - Array Members Valid Values: STDOUT , STDERR , HIVE_LOG , TEZ_AM ,
	//   SYSTEM_LOGS
	//
	// [Logging for EMR Serverless with CloudWatch]: https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/logging.html#jobs-log-storage-cw
	LogTypes map[string][]string
	// contains filtered or unexported fields
}

The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

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
	// contains filtered or unexported fields
}

A configuration specification to be used when provisioning an application. 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 override configurations for the application.
	ApplicationConfiguration []Configuration

	// The override configurations for monitoring.
	MonitoringConfiguration *MonitoringConfiguration
	// contains filtered or unexported fields
}

A configuration specification to be used to override existing configurations.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request could not be processed because of conflict in the current state of the resource.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

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

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type Hive 

type Hive struct {

	// The query for the Hive job run.
	//
	// This member is required.
	Query *string

	// The query file for the Hive job run.
	InitQueryFile *string

	// The parameters for the Hive job run.
	Parameters *string
	// contains filtered or unexported fields
}

The configurations for the Hive job driver.

type ImageConfiguration added in v1.5.0 

type ImageConfiguration struct {

	// The image URI.
	//
	// This member is required.
	ImageUri *string

	// The SHA256 digest of the image URI. This indicates which specific image the
	// application is configured for. The image digest doesn't exist until an
	// application has started.
	ResolvedImageDigest *string
	// contains filtered or unexported fields
}

The applied image configuration.

type ImageConfigurationInput added in v1.5.0 

type ImageConfigurationInput struct {

	// The URI of an image in the Amazon ECR registry. This field is required when you
	// create a new application. If you leave this field blank in an update, Amazon EMR
	// will remove the image configuration.
	ImageUri *string
	// contains filtered or unexported fields
}

The image configuration.

type InitialCapacityConfig 

type InitialCapacityConfig struct {

	// The number of workers in the initial capacity configuration.
	//
	// This member is required.
	WorkerCount *int64

	// The resource configuration of the initial capacity configuration.
	WorkerConfiguration *WorkerResourceConfig
	// contains filtered or unexported fields
}

The initial capacity configuration per worker.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Request processing failed because of an error or failure with the service.

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 interface {
	// contains filtered or unexported methods
}

The driver that the job runs on.

The following types satisfy this interface: 

JobDriverMemberHive
JobDriverMemberSparkSubmit
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

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

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

	case *types.JobDriverMemberSparkSubmit:
		_ = v.Value // Value is types.SparkSubmit

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

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

	}
}

var _ *types.SparkSubmit
var _ *types.Hive

Output:

type JobDriverMemberHive 

type JobDriverMemberHive struct {
	Value Hive
	// contains filtered or unexported fields
}

The job driver parameters specified for Hive.

type JobDriverMemberSparkSubmit 

type JobDriverMemberSparkSubmit struct {
	Value SparkSubmit
	// contains filtered or unexported fields
}

The job driver parameters specified for Spark.

type JobRun 

type JobRun struct {

	// The ID of the application the job is running on.
	//
	// This member is required.
	ApplicationId *string

	// The execution role ARN of the job run.
	//
	// This member is required.
	Arn *string

	// The date and time when the job run was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user who created the job run.
	//
	// This member is required.
	CreatedBy *string

	// The execution role ARN of the job run.
	//
	// This member is required.
	ExecutionRole *string

	// The job driver for the job run.
	//
	// This member is required.
	JobDriver JobDriver

	// The ID of the job run.
	//
	// This member is required.
	JobRunId *string

	// The Amazon EMR release associated with the application your job is running on.
	//
	// This member is required.
	ReleaseLabel *string

	// The state of the job run.
	//
	// This member is required.
	State JobRunState

	// The state details of the job run.
	//
	// This member is required.
	StateDetails *string

	// The date and time when the job run was updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The aggregate vCPU, memory, and storage that Amazon Web Services has billed for
	// the job run. The billed resources include a 1-minute minimum usage for workers,
	// plus additional storage over 20 GB per worker. Note that billed resources do not
	// include usage for idle pre-initialized workers.
	BilledResourceUtilization *ResourceUtilization

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

	// Returns the job run timeout value from the StartJobRun call. If no timeout was
	// specified, then it returns the default timeout of 720 minutes.
	ExecutionTimeoutMinutes *int64

	// The optional job run name. This doesn't have to be unique.
	Name *string

	// The network configuration for customer VPC connectivity.
	NetworkConfiguration *NetworkConfiguration

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

	// The job run total execution duration in seconds. This field is only available
	// for job runs in a COMPLETED , FAILED , or CANCELLED state.
	TotalExecutionDurationSeconds *int32

	// The aggregate vCPU, memory, and storage resources used from the time the job
	// starts to execute, until the time the job terminates, rounded up to the nearest
	// second.
	TotalResourceUtilization *TotalResourceUtilization
	// contains filtered or unexported fields
}

Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive query, or SparkSQL query, that you submit to an Amazon EMR Serverless application.

type JobRunState 

type JobRunState string
const (
	JobRunStateSubmitted  JobRunState = "SUBMITTED"
	JobRunStatePending    JobRunState = "PENDING"
	JobRunStateScheduled  JobRunState = "SCHEDULED"
	JobRunStateRunning    JobRunState = "RUNNING"
	JobRunStateSuccess    JobRunState = "SUCCESS"
	JobRunStateFailed     JobRunState = "FAILED"
	JobRunStateCancelling JobRunState = "CANCELLING"
	JobRunStateCancelled  JobRunState = "CANCELLED"
)

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 JobRunSummary 

type JobRunSummary struct {

	// The ID of the application the job is running on.
	//
	// This member is required.
	ApplicationId *string

	// The ARN of the job run.
	//
	// This member is required.
	Arn *string

	// The date and time when the job run was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user who created the job run.
	//
	// This member is required.
	CreatedBy *string

	// The execution role ARN of the job run.
	//
	// This member is required.
	ExecutionRole *string

	// The ID of the job run.
	//
	// This member is required.
	Id *string

	// The Amazon EMR release associated with the application your job is running on.
	//
	// This member is required.
	ReleaseLabel *string

	// The state of the job run.
	//
	// This member is required.
	State JobRunState

	// The state details of the job run.
	//
	// This member is required.
	StateDetails *string

	// The date and time when the job run was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The optional job run name. This doesn't have to be unique.
	Name *string

	// The type of job run, such as Spark or Hive.
	Type *string
	// contains filtered or unexported fields
}

The summary of attributes associated with a job run.

type ManagedPersistenceMonitoringConfiguration 

type ManagedPersistenceMonitoringConfiguration struct {

	// Enables managed logging and defaults to true. If set to false, managed logging
	// will be turned off.
	Enabled *bool

	// The KMS key ARN to encrypt the logs stored in managed log persistence.
	EncryptionKeyArn *string
	// contains filtered or unexported fields
}

The managed log persistence configuration for a job run.

type MaximumAllowedResources 

type MaximumAllowedResources struct {

	// The maximum allowed CPU for an application.
	//
	// This member is required.
	Cpu *string

	// The maximum allowed resources for an application.
	//
	// This member is required.
	Memory *string

	// The maximum allowed disk for an application.
	Disk *string
	// contains filtered or unexported fields
}

The maximum allowed cumulative resources for an application. No new resources will be created once the limit is hit.

type MonitoringConfiguration 

type MonitoringConfiguration struct {

	// The Amazon CloudWatch configuration for monitoring logs. You can configure your
	// jobs to send log information to CloudWatch.
	CloudWatchLoggingConfiguration *CloudWatchLoggingConfiguration

	// The managed log persistence configuration for a job run.
	ManagedPersistenceMonitoringConfiguration *ManagedPersistenceMonitoringConfiguration

	// The monitoring configuration object you can configure to send metrics to Amazon
	// Managed Service for Prometheus for a job run.
	PrometheusMonitoringConfiguration *PrometheusMonitoringConfiguration

	// The Amazon S3 configuration for monitoring log publishing.
	S3MonitoringConfiguration *S3MonitoringConfiguration
	// contains filtered or unexported fields
}

The configuration setting for monitoring.

type NetworkConfiguration 

type NetworkConfiguration struct {

	// The array of security group Ids for customer VPC connectivity.
	SecurityGroupIds []string

	// The array of subnet Ids for customer VPC connectivity.
	SubnetIds []string
	// contains filtered or unexported fields
}

The network configuration for customer VPC connectivity.

type PrometheusMonitoringConfiguration added in v1.19.0 

type PrometheusMonitoringConfiguration struct {

	// The remote write URL in the Amazon Managed Service for Prometheus workspace to
	// send metrics to.
	RemoteWriteUrl *string
	// contains filtered or unexported fields
}

The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 ResourceUtilization added in v1.7.0 

type ResourceUtilization struct {

	// The aggregated memory used per hour from the time the job starts executing
	// until the job is terminated.
	MemoryGBHour *float64

	// The aggregated storage used per hour from the time the job starts executing
	// until the job is terminated.
	StorageGBHour *float64

	// The aggregated vCPU used per hour from the time the job starts executing until
	// the job is terminated.
	VCPUHour *float64
	// contains filtered or unexported fields
}

The resource utilization for memory, storage, and vCPU for jobs.

type S3MonitoringConfiguration 

type S3MonitoringConfiguration struct {

	// The KMS key ARN to encrypt the logs published to the given Amazon S3
	// destination.
	EncryptionKeyArn *string

	// The Amazon S3 destination URI for log publishing.
	LogUri *string
	// contains filtered or unexported fields
}

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

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The maximum number of resources per account has been reached.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

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

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SparkSubmit 

type SparkSubmit struct {

	// The entry point for the Spark submit job run.
	//
	// This member is required.
	EntryPoint *string

	// The arguments for the Spark submit job run.
	EntryPointArguments []string

	// The parameters for the Spark submit job run.
	SparkSubmitParameters *string
	// contains filtered or unexported fields
}

The configurations for the Spark submit job driver.

type TotalResourceUtilization 

type TotalResourceUtilization struct {

	// The aggregated memory used per hour from the time job start executing till the
	// time job is terminated.
	MemoryGBHour *float64

	// The aggregated storage used per hour from the time job start executing till the
	// time job is terminated.
	StorageGBHour *float64

	// The aggregated vCPU used per hour from the time job start executing till the
	// time job is terminated.
	VCPUHour *float64
	// contains filtered or unexported fields
}

The aggregate vCPU, memory, and storage resources used from the time job start executing till the time job is terminated, rounded up to the nearest second.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

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

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an Amazon Web Services service.

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 WorkerResourceConfig 

type WorkerResourceConfig struct {

	// The CPU requirements for every worker instance of the worker type.
	//
	// This member is required.
	Cpu *string

	// The memory requirements for every worker instance of the worker type.
	//
	// This member is required.
	Memory *string

	// The disk requirements for every worker instance of the worker type.
	Disk *string

	// The disk type for every worker instance of the work type. Shuffle optimized
	// disks have higher performance characteristics and are better for shuffle heavy
	// workloads. Default is STANDARD .
	DiskType *string
	// contains filtered or unexported fields
}

The cumulative configuration requirements for every worker instance of the worker type.

type WorkerTypeSpecification added in v1.5.0 

type WorkerTypeSpecification struct {

	// The image configuration for a worker type.
	ImageConfiguration *ImageConfiguration
	// contains filtered or unexported fields
}

The specifications for a worker type.

type WorkerTypeSpecificationInput added in v1.5.0 

type WorkerTypeSpecificationInput struct {

	// The image configuration for a worker type.
	ImageConfiguration *ImageConfigurationInput
	// contains filtered or unexported fields
}

The specifications for a worker type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.