emrcontainers

package module
v0.0.0-...-68f2935 Latest Latest
Warning

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

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

Documentation

Overview

Package emrcontainers provides the API client, operations, and parameter types for Amazon EMR Containers.

Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. For more information about Amazon EMR on EKS concepts and tasks, see What is Amazon EMR on EKS.

Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following scenarios:

  • It is the prefix in the CLI commands for Amazon EMR on EKS. For example, aws emr-containers start-job-run .

  • It is the prefix before IAM policy actions for Amazon EMR on EKS. For example, "Action": [ "emr-containers:StartJobRun"] . For more information, see Policy actions for Amazon EMR on EKS .

  • It is the prefix used in Amazon EMR on EKS service endpoints. For example, emr-containers.us-east-2.amazonaws.com . For more information, see Amazon EMR on EKSService Endpoints.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-10-01"
View Source 
const ServiceID = "EMR containers"

Variables

This section is empty.

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 deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelJobRunInput 

type CancelJobRunInput struct {

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

	// The ID of the virtual cluster for which the job run will be canceled.
	//
	// This member is required.
	VirtualClusterId *string
	// contains filtered or unexported fields
}

type CancelJobRunOutput 

type CancelJobRunOutput struct {

	// The output contains the ID of the cancelled job run.
	Id *string

	// The output contains the virtual cluster ID for which the job run is cancelled.
	VirtualClusterId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

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

Client provides the API client to make operations call for Amazon EMR Containers.

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) CancelJobRun 

func (c *Client) CancelJobRun(ctx context.Context, params *CancelJobRunInput, optFns ...func(*Options)) (*CancelJobRunOutput, error)

Cancels 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.

func (*Client) CreateJobTemplate 

func (c *Client) CreateJobTemplate(ctx context.Context, params *CreateJobTemplateInput, optFns ...func(*Options)) (*CreateJobTemplateOutput, error)

Creates a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

func (*Client) CreateManagedEndpoint 

func (c *Client) CreateManagedEndpoint(ctx context.Context, params *CreateManagedEndpointInput, optFns ...func(*Options)) (*CreateManagedEndpointOutput, error)

Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

func (*Client) CreateSecurityConfiguration 

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

Creates a security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

func (*Client) CreateVirtualCluster 

func (c *Client) CreateVirtualCluster(ctx context.Context, params *CreateVirtualClusterInput, optFns ...func(*Options)) (*CreateVirtualClusterOutput, error)

Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

func (*Client) DeleteJobTemplate 

func (c *Client) DeleteJobTemplate(ctx context.Context, params *DeleteJobTemplateInput, optFns ...func(*Options)) (*DeleteJobTemplateOutput, error)

Deletes a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

func (*Client) DeleteManagedEndpoint 

func (c *Client) DeleteManagedEndpoint(ctx context.Context, params *DeleteManagedEndpointInput, optFns ...func(*Options)) (*DeleteManagedEndpointOutput, error)

Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

func (*Client) DeleteVirtualCluster 

func (c *Client) DeleteVirtualCluster(ctx context.Context, params *DeleteVirtualClusterInput, optFns ...func(*Options)) (*DeleteVirtualClusterOutput, error)

Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

func (*Client) DescribeJobRun 

func (c *Client) DescribeJobRun(ctx context.Context, params *DescribeJobRunInput, optFns ...func(*Options)) (*DescribeJobRunOutput, error)

Displays detailed information about 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.

func (*Client) DescribeJobTemplate 

func (c *Client) DescribeJobTemplate(ctx context.Context, params *DescribeJobTemplateInput, optFns ...func(*Options)) (*DescribeJobTemplateOutput, error)

Displays detailed information about a specified job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

func (*Client) DescribeManagedEndpoint 

func (c *Client) DescribeManagedEndpoint(ctx context.Context, params *DescribeManagedEndpointInput, optFns ...func(*Options)) (*DescribeManagedEndpointOutput, error)

Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

func (*Client) DescribeSecurityConfiguration 

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

Displays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

func (*Client) DescribeVirtualCluster 

func (c *Client) DescribeVirtualCluster(ctx context.Context, params *DescribeVirtualClusterInput, optFns ...func(*Options)) (*DescribeVirtualClusterOutput, error)

Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

func (*Client) GetManagedEndpointSessionCredentials 

func (c *Client) GetManagedEndpointSessionCredentials(ctx context.Context, params *GetManagedEndpointSessionCredentialsInput, optFns ...func(*Options)) (*GetManagedEndpointSessionCredentialsOutput, error)

Generate a session token to connect to a managed endpoint.

func (*Client) ListJobRuns 

func (c *Client) ListJobRuns(ctx context.Context, params *ListJobRunsInput, optFns ...func(*Options)) (*ListJobRunsOutput, error)

Lists job runs based on a set of parameters. 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.

func (*Client) ListJobTemplates 

func (c *Client) ListJobTemplates(ctx context.Context, params *ListJobTemplatesInput, optFns ...func(*Options)) (*ListJobTemplatesOutput, error)

Lists job templates based on a set of parameters. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

func (*Client) ListManagedEndpoints 

func (c *Client) ListManagedEndpoints(ctx context.Context, params *ListManagedEndpointsInput, optFns ...func(*Options)) (*ListManagedEndpointsOutput, error)

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

func (*Client) ListSecurityConfigurations 

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

Lists security configurations based on a set of parameters. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags assigned to the resources.

func (*Client) ListVirtualClusters 

func (c *Client) ListVirtualClusters(ctx context.Context, params *ListVirtualClustersInput, optFns ...func(*Options)) (*ListVirtualClustersOutput, error)

Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) StartJobRun 

func (c *Client) StartJobRun(ctx context.Context, params *StartJobRunInput, optFns ...func(*Options)) (*StartJobRunOutput, error)

Starts 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.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your Amazon Web Services resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from resources.

type CreateJobTemplateInput 

type CreateJobTemplateInput struct {

	// The client token of the job template.
	//
	// This member is required.
	ClientToken *string

	// The job template data which holds values of StartJobRun API request.
	//
	// This member is required.
	JobTemplateData *types.JobTemplateData

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

	// The KMS key ARN used to encrypt the job template.
	KmsKeyArn *string

	// The tags that are associated with the job template.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateJobTemplateOutput 

type CreateJobTemplateOutput struct {

	// This output display the ARN of the created job template.
	Arn *string

	// This output displays the date and time when the job template was created.
	CreatedAt *time.Time

	// This output display the created job template ID.
	Id *string

	// This output displays the name of the created job template.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateManagedEndpointInput 

type CreateManagedEndpointInput struct {

	// The client idempotency token for this create call.
	//
	// This member is required.
	ClientToken *string

	// The ARN of the execution role.
	//
	// This member is required.
	ExecutionRoleArn *string

	// The name of the managed endpoint.
	//
	// This member is required.
	Name *string

	// The Amazon EMR release version.
	//
	// This member is required.
	ReleaseLabel *string

	// The type of the managed endpoint.
	//
	// This member is required.
	Type *string

	// The ID of the virtual cluster for which a managed endpoint is created.
	//
	// This member is required.
	VirtualClusterId *string

	// The certificate ARN provided by users for the managed endpoint. This field is
	// under deprecation and will be removed in future releases.
	//
	// Deprecated: Customer provided certificate-arn is deprecated and would be
	// removed in future.
	CertificateArn *string

	// The configuration settings that will be used to override existing
	// configurations.
	ConfigurationOverrides *types.ConfigurationOverrides

	// The tags of the managed endpoint.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateManagedEndpointOutput 

type CreateManagedEndpointOutput struct {

	// The output contains the ARN of the managed endpoint.
	Arn *string

	// The output contains the ID of the managed endpoint.
	Id *string

	// The output contains the name of the managed endpoint.
	Name *string

	// The output contains the ID of the virtual cluster.
	VirtualClusterId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSecurityConfigurationInput 

type CreateSecurityConfigurationInput struct {

	// The client idempotency token to use when creating the security configuration.
	//
	// This member is required.
	ClientToken *string

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

	// Security configuration input for the request.
	//
	// This member is required.
	SecurityConfigurationData *types.SecurityConfigurationData

	// The tags to add to the security configuration.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateSecurityConfigurationOutput 

type CreateSecurityConfigurationOutput struct {

	// The ARN (Amazon Resource Name) of the security configuration.
	Arn *string

	// The ID of the security configuration.
	Id *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateVirtualClusterInput 

type CreateVirtualClusterInput struct {

	// The client token of the virtual cluster.
	//
	// This member is required.
	ClientToken *string

	// The container provider of the virtual cluster.
	//
	// This member is required.
	ContainerProvider *types.ContainerProvider

	// The specified name of the virtual cluster.
	//
	// This member is required.
	Name *string

	// The ID of the security configuration.
	SecurityConfigurationId *string

	// The tags assigned to the virtual cluster.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateVirtualClusterOutput 

type CreateVirtualClusterOutput struct {

	// This output contains the ARN of virtual cluster.
	Arn *string

	// This output contains the virtual cluster ID.
	Id *string

	// This output contains the name of the virtual cluster.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteJobTemplateInput 

type DeleteJobTemplateInput struct {

	// The ID of the job template that will be deleted.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteJobTemplateOutput 

type DeleteJobTemplateOutput struct {

	// This output contains the ID of the job template that was deleted.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteManagedEndpointInput 

type DeleteManagedEndpointInput struct {

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

	// The ID of the endpoint's virtual cluster.
	//
	// This member is required.
	VirtualClusterId *string
	// contains filtered or unexported fields
}

type DeleteManagedEndpointOutput 

type DeleteManagedEndpointOutput struct {

	// The output displays the ID of the managed endpoint.
	Id *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVirtualClusterInput 

type DeleteVirtualClusterInput struct {

	// The ID of the virtual cluster that will be deleted.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteVirtualClusterOutput 

type DeleteVirtualClusterOutput struct {

	// This output contains the ID of the virtual cluster that will be deleted.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeJobRunInput 

type DescribeJobRunInput struct {

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

	// The ID of the virtual cluster for which the job run is submitted.
	//
	// This member is required.
	VirtualClusterId *string
	// contains filtered or unexported fields
}

type DescribeJobRunOutput 

type DescribeJobRunOutput struct {

	// The output displays information about a job run.
	JobRun *types.JobRun

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeJobTemplateInput 

type DescribeJobTemplateInput struct {

	// The ID of the job template that will be described.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DescribeJobTemplateOutput 

type DescribeJobTemplateOutput struct {

	// This output displays information about the specified job template.
	JobTemplate *types.JobTemplate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeManagedEndpointInput 

type DescribeManagedEndpointInput struct {

	// This output displays ID of the managed endpoint.
	//
	// This member is required.
	Id *string

	// The ID of the endpoint's virtual cluster.
	//
	// This member is required.
	VirtualClusterId *string
	// contains filtered or unexported fields
}

type DescribeManagedEndpointOutput 

type DescribeManagedEndpointOutput struct {

	// This output displays information about a managed endpoint.
	Endpoint *types.Endpoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSecurityConfigurationInput 

type DescribeSecurityConfigurationInput struct {

	// The ID of the security configuration.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DescribeSecurityConfigurationOutput 

type DescribeSecurityConfigurationOutput struct {

	// Details of the security configuration.
	SecurityConfiguration *types.SecurityConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeVirtualClusterInput 

type DescribeVirtualClusterInput struct {

	// The ID of the virtual cluster that will be described.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DescribeVirtualClusterOutput 

type DescribeVirtualClusterOutput struct {

	// This output displays information about the specified virtual cluster.
	VirtualCluster *types.VirtualCluster

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

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 EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetManagedEndpointSessionCredentialsInput 

type GetManagedEndpointSessionCredentialsInput struct {

	// Type of the token requested. Currently supported and default value of this
	// field is “TOKEN.”
	//
	// This member is required.
	CredentialType *string

	// The ARN of the managed endpoint for which the request is submitted.
	//
	// This member is required.
	EndpointIdentifier *string

	// The IAM Execution Role ARN that will be used by the job run.
	//
	// This member is required.
	ExecutionRoleArn *string

	// The ARN of the Virtual Cluster which the Managed Endpoint belongs to.
	//
	// This member is required.
	VirtualClusterIdentifier *string

	// The client idempotency token of the job run request.
	ClientToken *string

	// Duration in seconds for which the session token is valid. The default duration
	// is 15 minutes and the maximum is 12 hours.
	DurationInSeconds *int32

	// String identifier used to separate sections of the execution logs uploaded to
	// S3.
	LogContext *string
	// contains filtered or unexported fields
}

type GetManagedEndpointSessionCredentialsOutput 

type GetManagedEndpointSessionCredentialsOutput struct {

	// The structure containing the session credentials.
	Credentials types.Credentials

	// The date and time when the session token will expire.
	ExpiresAt *time.Time

	// The identifier of the session token returned.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListJobRunsAPIClient 

type ListJobRunsAPIClient interface {
	ListJobRuns(context.Context, *ListJobRunsInput, ...func(*Options)) (*ListJobRunsOutput, error)
}

ListJobRunsAPIClient is a client that implements the ListJobRuns operation.

type ListJobRunsInput 

type ListJobRunsInput struct {

	// The ID of the virtual cluster for which to list the job run.
	//
	// This member is required.
	VirtualClusterId *string

	// The date and time after which the job runs were submitted.
	CreatedAfter *time.Time

	// The date and time before which the job runs were submitted.
	CreatedBefore *time.Time

	// The maximum number of job runs that can be listed.
	MaxResults *int32

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

	// The token for the next set of job runs to return.
	NextToken *string

	// The states of the job run.
	States []types.JobRunState
	// contains filtered or unexported fields
}

type ListJobRunsOutput 

type ListJobRunsOutput struct {

	// This output lists information about the specified job runs.
	JobRuns []types.JobRun

	// This output displays the token for the next set of job runs.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListJobRunsPaginator 

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

ListJobRunsPaginator is a paginator for ListJobRuns

func NewListJobRunsPaginator 

func NewListJobRunsPaginator(client ListJobRunsAPIClient, params *ListJobRunsInput, optFns ...func(*ListJobRunsPaginatorOptions)) *ListJobRunsPaginator

NewListJobRunsPaginator returns a new ListJobRunsPaginator

func (*ListJobRunsPaginator) HasMorePages 

func (p *ListJobRunsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobRunsPaginator) NextPage 

func (p *ListJobRunsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobRunsOutput, error)

NextPage retrieves the next ListJobRuns page.

type ListJobRunsPaginatorOptions 

type ListJobRunsPaginatorOptions struct {
	// The maximum number of job runs that can be listed.
	Limit int32

	// 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
}

ListJobRunsPaginatorOptions is the paginator options for ListJobRuns

type ListJobTemplatesAPIClient 

type ListJobTemplatesAPIClient interface {
	ListJobTemplates(context.Context, *ListJobTemplatesInput, ...func(*Options)) (*ListJobTemplatesOutput, error)
}

ListJobTemplatesAPIClient is a client that implements the ListJobTemplates operation.

type ListJobTemplatesInput 

type ListJobTemplatesInput struct {

	// The date and time after which the job templates were created.
	CreatedAfter *time.Time

	//  The date and time before which the job templates were created.
	CreatedBefore *time.Time

	//  The maximum number of job templates that can be listed.
	MaxResults *int32

	//  The token for the next set of job templates to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListJobTemplatesOutput 

type ListJobTemplatesOutput struct {

	//  This output displays the token for the next set of job templates.
	NextToken *string

	// This output lists information about the specified job templates.
	Templates []types.JobTemplate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListJobTemplatesPaginator 

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

ListJobTemplatesPaginator is a paginator for ListJobTemplates

func NewListJobTemplatesPaginator 

func NewListJobTemplatesPaginator(client ListJobTemplatesAPIClient, params *ListJobTemplatesInput, optFns ...func(*ListJobTemplatesPaginatorOptions)) *ListJobTemplatesPaginator

NewListJobTemplatesPaginator returns a new ListJobTemplatesPaginator

func (*ListJobTemplatesPaginator) HasMorePages 

func (p *ListJobTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobTemplatesPaginator) NextPage 

func (p *ListJobTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobTemplatesOutput, error)

NextPage retrieves the next ListJobTemplates page.

type ListJobTemplatesPaginatorOptions 

type ListJobTemplatesPaginatorOptions struct {
	//  The maximum number of job templates that can be listed.
	Limit int32

	// 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
}

ListJobTemplatesPaginatorOptions is the paginator options for ListJobTemplates

type ListManagedEndpointsAPIClient 

type ListManagedEndpointsAPIClient interface {
	ListManagedEndpoints(context.Context, *ListManagedEndpointsInput, ...func(*Options)) (*ListManagedEndpointsOutput, error)
}

ListManagedEndpointsAPIClient is a client that implements the ListManagedEndpoints operation.

type ListManagedEndpointsInput 

type ListManagedEndpointsInput struct {

	// The ID of the virtual cluster.
	//
	// This member is required.
	VirtualClusterId *string

	//  The date and time after which the endpoints are created.
	CreatedAfter *time.Time

	// The date and time before which the endpoints are created.
	CreatedBefore *time.Time

	// The maximum number of managed endpoints that can be listed.
	MaxResults *int32

	//  The token for the next set of managed endpoints to return.
	NextToken *string

	// The states of the managed endpoints.
	States []types.EndpointState

	// The types of the managed endpoints.
	Types []string
	// contains filtered or unexported fields
}

type ListManagedEndpointsOutput 

type ListManagedEndpointsOutput struct {

	// The managed endpoints to be listed.
	Endpoints []types.Endpoint

	//  The token for the next set of endpoints to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListManagedEndpointsPaginator 

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

ListManagedEndpointsPaginator is a paginator for ListManagedEndpoints

func NewListManagedEndpointsPaginator 

func NewListManagedEndpointsPaginator(client ListManagedEndpointsAPIClient, params *ListManagedEndpointsInput, optFns ...func(*ListManagedEndpointsPaginatorOptions)) *ListManagedEndpointsPaginator

NewListManagedEndpointsPaginator returns a new ListManagedEndpointsPaginator

func (*ListManagedEndpointsPaginator) HasMorePages 

func (p *ListManagedEndpointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListManagedEndpointsPaginator) NextPage 

func (p *ListManagedEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListManagedEndpointsOutput, error)

NextPage retrieves the next ListManagedEndpoints page.

type ListManagedEndpointsPaginatorOptions 

type ListManagedEndpointsPaginatorOptions struct {
	// The maximum number of managed endpoints that can be listed.
	Limit int32

	// 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
}

ListManagedEndpointsPaginatorOptions is the paginator options for ListManagedEndpoints

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 date and time after which the security configuration was created.
	CreatedAfter *time.Time

	// The date and time before which the security configuration was created.
	CreatedBefore *time.Time

	// The maximum number of security configurations the operation can list.
	MaxResults *int32

	// The token for the next set of security configurations to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSecurityConfigurationsOutput 

type ListSecurityConfigurationsOutput struct {

	// The token for the next set of security configurations to return.
	NextToken *string

	// The list of returned security configurations.
	SecurityConfigurations []types.SecurityConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSecurityConfigurationsPaginator 

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

ListSecurityConfigurationsPaginator is a paginator for ListSecurityConfigurations

func NewListSecurityConfigurationsPaginator 

func NewListSecurityConfigurationsPaginator(client ListSecurityConfigurationsAPIClient, params *ListSecurityConfigurationsInput, optFns ...func(*ListSecurityConfigurationsPaginatorOptions)) *ListSecurityConfigurationsPaginator

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 

func (p *ListSecurityConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecurityConfigurationsOutput, error)

NextPage retrieves the next ListSecurityConfigurations page.

type ListSecurityConfigurationsPaginatorOptions 

type ListSecurityConfigurationsPaginatorOptions struct {
	// The maximum number of security configurations the operation can list.
	Limit int32

	// 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 ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of tagged resources.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags assigned to resources.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVirtualClustersAPIClient 

type ListVirtualClustersAPIClient interface {
	ListVirtualClusters(context.Context, *ListVirtualClustersInput, ...func(*Options)) (*ListVirtualClustersOutput, error)
}

ListVirtualClustersAPIClient is a client that implements the ListVirtualClusters operation.

type ListVirtualClustersInput 

type ListVirtualClustersInput struct {

	// The container provider ID of the virtual cluster.
	ContainerProviderId *string

	// The container provider type of the virtual cluster. Amazon EKS is the only
	// supported type as of now.
	ContainerProviderType types.ContainerProviderType

	// The date and time after which the virtual clusters are created.
	CreatedAfter *time.Time

	// The date and time before which the virtual clusters are created.
	CreatedBefore *time.Time

	// Optional Boolean that specifies whether the operation should return the virtual
	// clusters that have the access entry integration enabled or disabled. If not
	// specified, the operation returns all applicable virtual clusters.
	EksAccessEntryIntegrated *bool

	// The maximum number of virtual clusters that can be listed.
	MaxResults *int32

	// The token for the next set of virtual clusters to return.
	NextToken *string

	// The states of the requested virtual clusters.
	States []types.VirtualClusterState
	// contains filtered or unexported fields
}

type ListVirtualClustersOutput 

type ListVirtualClustersOutput struct {

	// This output displays the token for the next set of virtual clusters.
	NextToken *string

	// This output lists the specified virtual clusters.
	VirtualClusters []types.VirtualCluster

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVirtualClustersPaginator 

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

ListVirtualClustersPaginator is a paginator for ListVirtualClusters

func NewListVirtualClustersPaginator 

func NewListVirtualClustersPaginator(client ListVirtualClustersAPIClient, params *ListVirtualClustersInput, optFns ...func(*ListVirtualClustersPaginatorOptions)) *ListVirtualClustersPaginator

NewListVirtualClustersPaginator returns a new ListVirtualClustersPaginator

func (*ListVirtualClustersPaginator) HasMorePages 

func (p *ListVirtualClustersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVirtualClustersPaginator) NextPage 

func (p *ListVirtualClustersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVirtualClustersOutput, error)

NextPage retrieves the next ListVirtualClusters page.

type ListVirtualClustersPaginatorOptions 

type ListVirtualClustersPaginatorOptions struct {
	// The maximum number of virtual clusters that can be listed.
	Limit int32

	// 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
}

ListVirtualClustersPaginatorOptions is the paginator options for ListVirtualClusters

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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 configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

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

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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartJobRunInput 

type StartJobRunInput struct {

	// The client idempotency token of the job run request.
	//
	// This member is required.
	ClientToken *string

	// The virtual cluster ID for which the job run request is submitted.
	//
	// This member is required.
	VirtualClusterId *string

	// The configuration overrides for the job run.
	ConfigurationOverrides *types.ConfigurationOverrides

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

	// The job driver for the job run.
	JobDriver *types.JobDriver

	// The job template ID to be used to start the job run.
	JobTemplateId *string

	// The values of job template parameters to start a job run.
	JobTemplateParameters map[string]string

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

	// The Amazon EMR release version to use for the job run.
	ReleaseLabel *string

	// The retry policy configuration for the job run.
	RetryPolicyConfiguration *types.RetryPolicyConfiguration

	// The tags assigned to job runs.
	Tags map[string]string
	// contains filtered or unexported fields
}

type StartJobRunOutput 

type StartJobRunOutput struct {

	// This output lists the ARN of job run.
	Arn *string

	// This output displays the started job run ID.
	Id *string

	// This output displays the name of the started job run.
	Name *string

	// This output displays the virtual cluster ID for which the job run was submitted.
	VirtualClusterId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of resources.
	//
	// This member is required.
	ResourceArn *string

	// The tags assigned to resources.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of resources.
	//
	// This member is required.
	ResourceArn *string

	// The tag keys of the resources.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.