elasticbeanstalk

package
v1.99.1 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package elasticbeanstalk provides the client and types for making API requests to AWS Elastic Beanstalk.

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.

For more information about this product, go to the AWS Elastic Beanstalk (http://aws.amazon.com/elasticbeanstalk/) details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl (http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl). To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services (http://aws.amazon.com/tools/).

Endpoints

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region) in the Amazon Web Services Glossary.

See https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01 for more information on this service.

See elasticbeanstalk package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/elasticbeanstalk/

Using the Client

To contact AWS Elastic Beanstalk with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Elastic Beanstalk client ElasticBeanstalk for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/elasticbeanstalk/#New

Index

Examples

Constants

View Source
const (
	// ActionHistoryStatusCompleted is a ActionHistoryStatus enum value
	ActionHistoryStatusCompleted = "Completed"

	// ActionHistoryStatusFailed is a ActionHistoryStatus enum value
	ActionHistoryStatusFailed = "Failed"

	// ActionHistoryStatusUnknown is a ActionHistoryStatus enum value
	ActionHistoryStatusUnknown = "Unknown"
)
View Source
const (
	// ActionStatusScheduled is a ActionStatus enum value
	ActionStatusScheduled = "Scheduled"

	// ActionStatusPending is a ActionStatus enum value
	ActionStatusPending = "Pending"

	// ActionStatusRunning is a ActionStatus enum value
	ActionStatusRunning = "Running"

	// ActionStatusUnknown is a ActionStatus enum value
	ActionStatusUnknown = "Unknown"
)
View Source
const (
	// ActionTypeInstanceRefresh is a ActionType enum value
	ActionTypeInstanceRefresh = "InstanceRefresh"

	// ActionTypePlatformUpdate is a ActionType enum value
	ActionTypePlatformUpdate = "PlatformUpdate"

	// ActionTypeUnknown is a ActionType enum value
	ActionTypeUnknown = "Unknown"
)
View Source
const (
	// ApplicationVersionStatusProcessed is a ApplicationVersionStatus enum value
	ApplicationVersionStatusProcessed = "Processed"

	// ApplicationVersionStatusUnprocessed is a ApplicationVersionStatus enum value
	ApplicationVersionStatusUnprocessed = "Unprocessed"

	// ApplicationVersionStatusFailed is a ApplicationVersionStatus enum value
	ApplicationVersionStatusFailed = "Failed"

	// ApplicationVersionStatusProcessing is a ApplicationVersionStatus enum value
	ApplicationVersionStatusProcessing = "Processing"

	// ApplicationVersionStatusBuilding is a ApplicationVersionStatus enum value
	ApplicationVersionStatusBuilding = "Building"
)
View Source
const (
	// ComputeTypeBuildGeneral1Small is a ComputeType enum value
	ComputeTypeBuildGeneral1Small = "BUILD_GENERAL1_SMALL"

	// ComputeTypeBuildGeneral1Medium is a ComputeType enum value
	ComputeTypeBuildGeneral1Medium = "BUILD_GENERAL1_MEDIUM"

	// ComputeTypeBuildGeneral1Large is a ComputeType enum value
	ComputeTypeBuildGeneral1Large = "BUILD_GENERAL1_LARGE"
)
View Source
const (
	// ConfigurationDeploymentStatusDeployed is a ConfigurationDeploymentStatus enum value
	ConfigurationDeploymentStatusDeployed = "deployed"

	// ConfigurationDeploymentStatusPending is a ConfigurationDeploymentStatus enum value
	ConfigurationDeploymentStatusPending = "pending"

	// ConfigurationDeploymentStatusFailed is a ConfigurationDeploymentStatus enum value
	ConfigurationDeploymentStatusFailed = "failed"
)
View Source
const (
	// ConfigurationOptionValueTypeScalar is a ConfigurationOptionValueType enum value
	ConfigurationOptionValueTypeScalar = "Scalar"

	// ConfigurationOptionValueTypeList is a ConfigurationOptionValueType enum value
	ConfigurationOptionValueTypeList = "List"
)
View Source
const (
	// EnvironmentHealthGreen is a EnvironmentHealth enum value
	EnvironmentHealthGreen = "Green"

	// EnvironmentHealthYellow is a EnvironmentHealth enum value
	EnvironmentHealthYellow = "Yellow"

	// EnvironmentHealthRed is a EnvironmentHealth enum value
	EnvironmentHealthRed = "Red"

	// EnvironmentHealthGrey is a EnvironmentHealth enum value
	EnvironmentHealthGrey = "Grey"
)
View Source
const (
	// EnvironmentHealthAttributeStatus is a EnvironmentHealthAttribute enum value
	EnvironmentHealthAttributeStatus = "Status"

	// EnvironmentHealthAttributeColor is a EnvironmentHealthAttribute enum value
	EnvironmentHealthAttributeColor = "Color"

	// EnvironmentHealthAttributeCauses is a EnvironmentHealthAttribute enum value
	EnvironmentHealthAttributeCauses = "Causes"

	// EnvironmentHealthAttributeApplicationMetrics is a EnvironmentHealthAttribute enum value
	EnvironmentHealthAttributeApplicationMetrics = "ApplicationMetrics"

	// EnvironmentHealthAttributeInstancesHealth is a EnvironmentHealthAttribute enum value
	EnvironmentHealthAttributeInstancesHealth = "InstancesHealth"

	// EnvironmentHealthAttributeAll is a EnvironmentHealthAttribute enum value
	EnvironmentHealthAttributeAll = "All"

	// EnvironmentHealthAttributeHealthStatus is a EnvironmentHealthAttribute enum value
	EnvironmentHealthAttributeHealthStatus = "HealthStatus"

	// EnvironmentHealthAttributeRefreshedAt is a EnvironmentHealthAttribute enum value
	EnvironmentHealthAttributeRefreshedAt = "RefreshedAt"
)
View Source
const (
	// EnvironmentHealthStatusNoData is a EnvironmentHealthStatus enum value
	EnvironmentHealthStatusNoData = "NoData"

	// EnvironmentHealthStatusUnknown is a EnvironmentHealthStatus enum value
	EnvironmentHealthStatusUnknown = "Unknown"

	// EnvironmentHealthStatusPending is a EnvironmentHealthStatus enum value
	EnvironmentHealthStatusPending = "Pending"

	// EnvironmentHealthStatusOk is a EnvironmentHealthStatus enum value
	EnvironmentHealthStatusOk = "Ok"

	// EnvironmentHealthStatusInfo is a EnvironmentHealthStatus enum value
	EnvironmentHealthStatusInfo = "Info"

	// EnvironmentHealthStatusWarning is a EnvironmentHealthStatus enum value
	EnvironmentHealthStatusWarning = "Warning"

	// EnvironmentHealthStatusDegraded is a EnvironmentHealthStatus enum value
	EnvironmentHealthStatusDegraded = "Degraded"

	// EnvironmentHealthStatusSevere is a EnvironmentHealthStatus enum value
	EnvironmentHealthStatusSevere = "Severe"

	// EnvironmentHealthStatusSuspended is a EnvironmentHealthStatus enum value
	EnvironmentHealthStatusSuspended = "Suspended"
)
View Source
const (
	// EnvironmentInfoTypeTail is a EnvironmentInfoType enum value
	EnvironmentInfoTypeTail = "tail"

	// EnvironmentInfoTypeBundle is a EnvironmentInfoType enum value
	EnvironmentInfoTypeBundle = "bundle"
)
View Source
const (
	// EnvironmentStatusLaunching is a EnvironmentStatus enum value
	EnvironmentStatusLaunching = "Launching"

	// EnvironmentStatusUpdating is a EnvironmentStatus enum value
	EnvironmentStatusUpdating = "Updating"

	// EnvironmentStatusReady is a EnvironmentStatus enum value
	EnvironmentStatusReady = "Ready"

	// EnvironmentStatusTerminating is a EnvironmentStatus enum value
	EnvironmentStatusTerminating = "Terminating"

	// EnvironmentStatusTerminated is a EnvironmentStatus enum value
	EnvironmentStatusTerminated = "Terminated"
)
View Source
const (
	// EventSeverityTrace is a EventSeverity enum value
	EventSeverityTrace = "TRACE"

	// EventSeverityDebug is a EventSeverity enum value
	EventSeverityDebug = "DEBUG"

	// EventSeverityInfo is a EventSeverity enum value
	EventSeverityInfo = "INFO"

	// EventSeverityWarn is a EventSeverity enum value
	EventSeverityWarn = "WARN"

	// EventSeverityError is a EventSeverity enum value
	EventSeverityError = "ERROR"

	// EventSeverityFatal is a EventSeverity enum value
	EventSeverityFatal = "FATAL"
)
View Source
const (
	// FailureTypeUpdateCancelled is a FailureType enum value
	FailureTypeUpdateCancelled = "UpdateCancelled"

	// FailureTypeCancellationFailed is a FailureType enum value
	FailureTypeCancellationFailed = "CancellationFailed"

	// FailureTypeRollbackFailed is a FailureType enum value
	FailureTypeRollbackFailed = "RollbackFailed"

	// FailureTypeRollbackSuccessful is a FailureType enum value
	FailureTypeRollbackSuccessful = "RollbackSuccessful"

	// FailureTypeInternalFailure is a FailureType enum value
	FailureTypeInternalFailure = "InternalFailure"

	// FailureTypeInvalidEnvironmentState is a FailureType enum value
	FailureTypeInvalidEnvironmentState = "InvalidEnvironmentState"

	// FailureTypePermissionsError is a FailureType enum value
	FailureTypePermissionsError = "PermissionsError"
)
View Source
const (
	// InstancesHealthAttributeHealthStatus is a InstancesHealthAttribute enum value
	InstancesHealthAttributeHealthStatus = "HealthStatus"

	// InstancesHealthAttributeColor is a InstancesHealthAttribute enum value
	InstancesHealthAttributeColor = "Color"

	// InstancesHealthAttributeCauses is a InstancesHealthAttribute enum value
	InstancesHealthAttributeCauses = "Causes"

	// InstancesHealthAttributeApplicationMetrics is a InstancesHealthAttribute enum value
	InstancesHealthAttributeApplicationMetrics = "ApplicationMetrics"

	// InstancesHealthAttributeRefreshedAt is a InstancesHealthAttribute enum value
	InstancesHealthAttributeRefreshedAt = "RefreshedAt"

	// InstancesHealthAttributeLaunchedAt is a InstancesHealthAttribute enum value
	InstancesHealthAttributeLaunchedAt = "LaunchedAt"

	// InstancesHealthAttributeSystem is a InstancesHealthAttribute enum value
	InstancesHealthAttributeSystem = "System"

	// InstancesHealthAttributeDeployment is a InstancesHealthAttribute enum value
	InstancesHealthAttributeDeployment = "Deployment"

	// InstancesHealthAttributeAvailabilityZone is a InstancesHealthAttribute enum value
	InstancesHealthAttributeAvailabilityZone = "AvailabilityZone"

	// InstancesHealthAttributeInstanceType is a InstancesHealthAttribute enum value
	InstancesHealthAttributeInstanceType = "InstanceType"

	// InstancesHealthAttributeAll is a InstancesHealthAttribute enum value
	InstancesHealthAttributeAll = "All"
)
View Source
const (
	// PlatformStatusCreating is a PlatformStatus enum value
	PlatformStatusCreating = "Creating"

	// PlatformStatusFailed is a PlatformStatus enum value
	PlatformStatusFailed = "Failed"

	// PlatformStatusReady is a PlatformStatus enum value
	PlatformStatusReady = "Ready"

	// PlatformStatusDeleting is a PlatformStatus enum value
	PlatformStatusDeleting = "Deleting"

	// PlatformStatusDeleted is a PlatformStatus enum value
	PlatformStatusDeleted = "Deleted"
)
View Source
const (
	// SourceRepositoryCodeCommit is a SourceRepository enum value
	SourceRepositoryCodeCommit = "CodeCommit"

	// SourceRepositoryS3 is a SourceRepository enum value
	SourceRepositoryS3 = "S3"
)
View Source
const (
	// SourceTypeGit is a SourceType enum value
	SourceTypeGit = "Git"

	// SourceTypeZip is a SourceType enum value
	SourceTypeZip = "Zip"
)
View Source
const (
	// ValidationSeverityError is a ValidationSeverity enum value
	ValidationSeverityError = "error"

	// ValidationSeverityWarning is a ValidationSeverity enum value
	ValidationSeverityWarning = "warning"
)
View Source
const (

	// ErrCodeCodeBuildNotInServiceRegionException for service response error code
	// "CodeBuildNotInServiceRegionException".
	//
	// AWS CodeBuild is not available in the specified region.
	ErrCodeCodeBuildNotInServiceRegionException = "CodeBuildNotInServiceRegionException"

	// ErrCodeInsufficientPrivilegesException for service response error code
	// "InsufficientPrivilegesException".
	//
	// The specified account does not have sufficient privileges for one or more
	// AWS services.
	ErrCodeInsufficientPrivilegesException = "InsufficientPrivilegesException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// One or more input parameters is not valid. Please correct the input parameters
	// and try the operation again.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeManagedActionInvalidStateException for service response error code
	// "ManagedActionInvalidStateException".
	//
	// Cannot modify the managed action in its current state.
	ErrCodeManagedActionInvalidStateException = "ManagedActionInvalidStateException"

	// ErrCodeOperationInProgressException for service response error code
	// "OperationInProgressFailure".
	//
	// Unable to perform the specified operation because another operation that
	// effects an element in this activity is already in progress.
	ErrCodeOperationInProgressException = "OperationInProgressFailure"

	// ErrCodePlatformVersionStillReferencedException for service response error code
	// "PlatformVersionStillReferencedException".
	//
	// You cannot delete the platform version because there are still environments
	// running on it.
	ErrCodePlatformVersionStillReferencedException = "PlatformVersionStillReferencedException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A resource doesn't exist for the specified Amazon Resource Name (ARN).
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceTypeNotSupportedException for service response error code
	// "ResourceTypeNotSupportedException".
	//
	// The type of the specified Amazon Resource Name (ARN) isn't supported for
	// this operation.
	ErrCodeResourceTypeNotSupportedException = "ResourceTypeNotSupportedException"

	// ErrCodeS3LocationNotInServiceRegionException for service response error code
	// "S3LocationNotInServiceRegionException".
	//
	// The specified S3 bucket does not belong to the S3 region in which the service
	// is running. The following regions are supported:
	//
	//    * IAD/us-east-1
	//
	//    * PDX/us-west-2
	//
	//    * DUB/eu-west-1
	ErrCodeS3LocationNotInServiceRegionException = "S3LocationNotInServiceRegionException"

	// ErrCodeS3SubscriptionRequiredException for service response error code
	// "S3SubscriptionRequiredException".
	//
	// The specified account does not have a subscription to Amazon S3.
	ErrCodeS3SubscriptionRequiredException = "S3SubscriptionRequiredException"

	// ErrCodeServiceException for service response error code
	// "ElasticBeanstalkServiceException".
	//
	// A generic service exception has occurred.
	ErrCodeServiceException = "ElasticBeanstalkServiceException"

	// ErrCodeSourceBundleDeletionException for service response error code
	// "SourceBundleDeletionFailure".
	//
	// Unable to delete the Amazon S3 source bundle associated with the application
	// version. The application version was deleted successfully.
	ErrCodeSourceBundleDeletionException = "SourceBundleDeletionFailure"

	// ErrCodeTooManyApplicationVersionsException for service response error code
	// "TooManyApplicationVersionsException".
	//
	// The specified account has reached its limit of application versions.
	ErrCodeTooManyApplicationVersionsException = "TooManyApplicationVersionsException"

	// ErrCodeTooManyApplicationsException for service response error code
	// "TooManyApplicationsException".
	//
	// The specified account has reached its limit of applications.
	ErrCodeTooManyApplicationsException = "TooManyApplicationsException"

	// ErrCodeTooManyBucketsException for service response error code
	// "TooManyBucketsException".
	//
	// The specified account has reached its limit of Amazon S3 buckets.
	ErrCodeTooManyBucketsException = "TooManyBucketsException"

	// ErrCodeTooManyConfigurationTemplatesException for service response error code
	// "TooManyConfigurationTemplatesException".
	//
	// The specified account has reached its limit of configuration templates.
	ErrCodeTooManyConfigurationTemplatesException = "TooManyConfigurationTemplatesException"

	// ErrCodeTooManyEnvironmentsException for service response error code
	// "TooManyEnvironmentsException".
	//
	// The specified account has reached its limit of environments.
	ErrCodeTooManyEnvironmentsException = "TooManyEnvironmentsException"

	// ErrCodeTooManyPlatformsException for service response error code
	// "TooManyPlatformsException".
	//
	// You have exceeded the maximum number of allowed platforms associated with
	// the account.
	ErrCodeTooManyPlatformsException = "TooManyPlatformsException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// The number of tags in the resource would exceed the number of tags that each
	// resource can have.
	//
	// To calculate this, the operation considers both the number of tags the resource
	// already has and the tags this operation would add if it succeeded.
	ErrCodeTooManyTagsException = "TooManyTagsException"
)
View Source
const (
	ServiceName = "elasticbeanstalk"  // Name of service.
	EndpointsID = ServiceName         // ID to lookup a service endpoint with.
	ServiceID   = "Elastic Beanstalk" // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AbortEnvironmentUpdateInput

type AbortEnvironmentUpdateInput struct {

	// This specifies the ID of the environment with the in-progress update that
	// you want to cancel.
	EnvironmentId *string `type:"string"`

	// This specifies the name of the environment with the in-progress update that
	// you want to cancel.
	EnvironmentName *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (AbortEnvironmentUpdateInput) GoString added in v0.6.5

func (s AbortEnvironmentUpdateInput) GoString() string

GoString returns the string representation

func (*AbortEnvironmentUpdateInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*AbortEnvironmentUpdateInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (AbortEnvironmentUpdateInput) String added in v0.6.5

String returns the string representation

func (*AbortEnvironmentUpdateInput) Validate added in v1.1.21

func (s *AbortEnvironmentUpdateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AbortEnvironmentUpdateOutput

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

func (AbortEnvironmentUpdateOutput) GoString added in v0.6.5

func (s AbortEnvironmentUpdateOutput) GoString() string

GoString returns the string representation

func (AbortEnvironmentUpdateOutput) String added in v0.6.5

String returns the string representation

type ApplicationDescription

type ApplicationDescription struct {

	// The Amazon Resource Name (ARN) of the application.
	ApplicationArn *string `type:"string"`

	// The name of the application.
	ApplicationName *string `min:"1" type:"string"`

	// The names of the configuration templates associated with this application.
	ConfigurationTemplates []*string `type:"list"`

	// The date when the application was created.
	DateCreated *time.Time `type:"timestamp"`

	// The date when the application was last modified.
	DateUpdated *time.Time `type:"timestamp"`

	// User-defined description of the application.
	Description *string `type:"string"`

	// The lifecycle settings for the application.
	ResourceLifecycleConfig *ApplicationResourceLifecycleConfig `type:"structure"`

	// The names of the versions for this application.
	Versions []*string `type:"list"`
	// contains filtered or unexported fields
}

Describes the properties of an application.

func (ApplicationDescription) GoString added in v0.6.5

func (s ApplicationDescription) GoString() string

GoString returns the string representation

func (*ApplicationDescription) SetApplicationArn added in v1.13.36

func (s *ApplicationDescription) SetApplicationArn(v string) *ApplicationDescription

SetApplicationArn sets the ApplicationArn field's value.

func (*ApplicationDescription) SetApplicationName added in v1.5.0

func (s *ApplicationDescription) SetApplicationName(v string) *ApplicationDescription

SetApplicationName sets the ApplicationName field's value.

func (*ApplicationDescription) SetConfigurationTemplates added in v1.5.0

func (s *ApplicationDescription) SetConfigurationTemplates(v []*string) *ApplicationDescription

SetConfigurationTemplates sets the ConfigurationTemplates field's value.

func (*ApplicationDescription) SetDateCreated added in v1.5.0

SetDateCreated sets the DateCreated field's value.

func (*ApplicationDescription) SetDateUpdated added in v1.5.0

SetDateUpdated sets the DateUpdated field's value.

func (*ApplicationDescription) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*ApplicationDescription) SetResourceLifecycleConfig added in v1.6.8

SetResourceLifecycleConfig sets the ResourceLifecycleConfig field's value.

func (*ApplicationDescription) SetVersions added in v1.5.0

SetVersions sets the Versions field's value.

func (ApplicationDescription) String added in v0.6.5

func (s ApplicationDescription) String() string

String returns the string representation

type ApplicationDescriptionMessage

type ApplicationDescriptionMessage struct {

	// The ApplicationDescription of the application.
	Application *ApplicationDescription `type:"structure"`
	// contains filtered or unexported fields
}

Result message containing a single description of an application.

func (ApplicationDescriptionMessage) GoString added in v0.6.5

GoString returns the string representation

func (*ApplicationDescriptionMessage) SetApplication added in v1.5.0

SetApplication sets the Application field's value.

func (ApplicationDescriptionMessage) String added in v0.6.5

String returns the string representation

type ApplicationMetrics added in v0.7.4

type ApplicationMetrics struct {

	// The amount of time that the metrics cover (usually 10 seconds). For example,
	// you might have 5 requests (request_count) within the most recent time slice
	// of 10 seconds (duration).
	Duration *int64 `type:"integer"`

	// Represents the average latency for the slowest X percent of requests over
	// the last 10 seconds. Latencies are in seconds with one millisecond resolution.
	Latency *Latency `type:"structure"`

	// Average number of requests handled by the web server per second over the
	// last 10 seconds.
	RequestCount *int64 `type:"integer"`

	// Represents the percentage of requests over the last 10 seconds that resulted
	// in each type of status code response.
	StatusCodes *StatusCodes `type:"structure"`
	// contains filtered or unexported fields
}

Application request metrics for an AWS Elastic Beanstalk environment.

func (ApplicationMetrics) GoString added in v0.7.4

func (s ApplicationMetrics) GoString() string

GoString returns the string representation

func (*ApplicationMetrics) SetDuration added in v1.5.0

func (s *ApplicationMetrics) SetDuration(v int64) *ApplicationMetrics

SetDuration sets the Duration field's value.

func (*ApplicationMetrics) SetLatency added in v1.5.0

func (s *ApplicationMetrics) SetLatency(v *Latency) *ApplicationMetrics

SetLatency sets the Latency field's value.

func (*ApplicationMetrics) SetRequestCount added in v1.5.0

func (s *ApplicationMetrics) SetRequestCount(v int64) *ApplicationMetrics

SetRequestCount sets the RequestCount field's value.

func (*ApplicationMetrics) SetStatusCodes added in v1.5.0

func (s *ApplicationMetrics) SetStatusCodes(v *StatusCodes) *ApplicationMetrics

SetStatusCodes sets the StatusCodes field's value.

func (ApplicationMetrics) String added in v0.7.4

func (s ApplicationMetrics) String() string

String returns the string representation

type ApplicationResourceLifecycleConfig added in v1.6.8

type ApplicationResourceLifecycleConfig struct {

	// The ARN of an IAM service role that Elastic Beanstalk has permission to assume.
	//
	// The ServiceRole property is required the first time that you provide a VersionLifecycleConfig
	// for the application in one of the supporting calls (CreateApplication or
	// UpdateApplicationResourceLifecycle). After you provide it once, in either
	// one of the calls, Elastic Beanstalk persists the Service Role with the application,
	// and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle
	// calls. You can, however, specify it in subsequent calls to change the Service
	// Role to another value.
	ServiceRole *string `type:"string"`

	// The application version lifecycle configuration.
	VersionLifecycleConfig *ApplicationVersionLifecycleConfig `type:"structure"`
	// contains filtered or unexported fields
}

The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.

func (ApplicationResourceLifecycleConfig) GoString added in v1.6.8

GoString returns the string representation

func (*ApplicationResourceLifecycleConfig) SetServiceRole added in v1.6.8

SetServiceRole sets the ServiceRole field's value.

func (*ApplicationResourceLifecycleConfig) SetVersionLifecycleConfig added in v1.6.8

SetVersionLifecycleConfig sets the VersionLifecycleConfig field's value.

func (ApplicationResourceLifecycleConfig) String added in v1.6.8

String returns the string representation

func (*ApplicationResourceLifecycleConfig) Validate added in v1.6.8

Validate inspects the fields of the type to determine if they are valid.

type ApplicationVersionDescription

type ApplicationVersionDescription struct {

	// The name of the application to which the application version belongs.
	ApplicationName *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the application version.
	ApplicationVersionArn *string `type:"string"`

	// Reference to the artifact from the AWS CodeBuild build.
	BuildArn *string `type:"string"`

	// The creation date of the application version.
	DateCreated *time.Time `type:"timestamp"`

	// The last modified date of the application version.
	DateUpdated *time.Time `type:"timestamp"`

	// The description of the application version.
	Description *string `type:"string"`

	// If the version's source code was retrieved from AWS CodeCommit, the location
	// of the source code for the application version.
	SourceBuildInformation *SourceBuildInformation `type:"structure"`

	// The storage location of the application version's source bundle in Amazon
	// S3.
	SourceBundle *S3Location `type:"structure"`

	// The processing status of the application version. Reflects the state of the
	// application version during its creation. Many of the values are only applicable
	// if you specified True for the Process parameter of the CreateApplicationVersion
	// action. The following list describes the possible values.
	//
	//    * Unprocessed – Application version wasn't pre-processed or validated.
	//    Elastic Beanstalk will validate configuration files during deployment
	//    of the application version to an environment.
	//
	//    * Processing – Elastic Beanstalk is currently processing the application
	//    version.
	//
	//    * Building – Application version is currently undergoing an AWS CodeBuild
	//    build.
	//
	//    * Processed – Elastic Beanstalk was successfully pre-processed and validated.
	//
	//    * Failed – Either the AWS CodeBuild build failed or configuration files
	//    didn't pass validation. This application version isn't usable.
	Status *string `type:"string" enum:"ApplicationVersionStatus"`

	// A unique identifier for the application version.
	VersionLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the properties of an application version.

func (ApplicationVersionDescription) GoString added in v0.6.5

GoString returns the string representation

func (*ApplicationVersionDescription) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*ApplicationVersionDescription) SetApplicationVersionArn added in v1.13.36

func (s *ApplicationVersionDescription) SetApplicationVersionArn(v string) *ApplicationVersionDescription

SetApplicationVersionArn sets the ApplicationVersionArn field's value.

func (*ApplicationVersionDescription) SetBuildArn added in v1.5.13

SetBuildArn sets the BuildArn field's value.

func (*ApplicationVersionDescription) SetDateCreated added in v1.5.0

SetDateCreated sets the DateCreated field's value.

func (*ApplicationVersionDescription) SetDateUpdated added in v1.5.0

SetDateUpdated sets the DateUpdated field's value.

func (*ApplicationVersionDescription) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*ApplicationVersionDescription) SetSourceBuildInformation added in v1.5.0

SetSourceBuildInformation sets the SourceBuildInformation field's value.

func (*ApplicationVersionDescription) SetSourceBundle added in v1.5.0

SetSourceBundle sets the SourceBundle field's value.

func (*ApplicationVersionDescription) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (*ApplicationVersionDescription) SetVersionLabel added in v1.5.0

SetVersionLabel sets the VersionLabel field's value.

func (ApplicationVersionDescription) String added in v0.6.5

String returns the string representation

type ApplicationVersionDescriptionMessage

type ApplicationVersionDescriptionMessage struct {

	// The ApplicationVersionDescription of the application version.
	ApplicationVersion *ApplicationVersionDescription `type:"structure"`
	// contains filtered or unexported fields
}

Result message wrapping a single description of an application version.

func (ApplicationVersionDescriptionMessage) GoString added in v0.6.5

GoString returns the string representation

func (*ApplicationVersionDescriptionMessage) SetApplicationVersion added in v1.5.0

SetApplicationVersion sets the ApplicationVersion field's value.

func (ApplicationVersionDescriptionMessage) String added in v0.6.5

String returns the string representation

type ApplicationVersionLifecycleConfig added in v1.6.8

type ApplicationVersionLifecycleConfig struct {

	// Specify a max age rule to restrict the length of time that application versions
	// are retained for an application.
	MaxAgeRule *MaxAgeRule `type:"structure"`

	// Specify a max count rule to restrict the number of application versions that
	// are retained for an application.
	MaxCountRule *MaxCountRule `type:"structure"`
	// contains filtered or unexported fields
}

The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.

When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.

func (ApplicationVersionLifecycleConfig) GoString added in v1.6.8

GoString returns the string representation

func (*ApplicationVersionLifecycleConfig) SetMaxAgeRule added in v1.6.8

SetMaxAgeRule sets the MaxAgeRule field's value.

func (*ApplicationVersionLifecycleConfig) SetMaxCountRule added in v1.6.8

SetMaxCountRule sets the MaxCountRule field's value.

func (ApplicationVersionLifecycleConfig) String added in v1.6.8

String returns the string representation

func (*ApplicationVersionLifecycleConfig) Validate added in v1.6.8

Validate inspects the fields of the type to determine if they are valid.

type ApplyEnvironmentManagedActionInput added in v1.1.19

type ApplyEnvironmentManagedActionInput struct {

	// The action ID of the scheduled managed action to execute.
	//
	// ActionId is a required field
	ActionId *string `type:"string" required:"true"`

	// The environment ID of the target environment.
	EnvironmentId *string `type:"string"`

	// The name of the target environment.
	EnvironmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Request to execute a scheduled managed action immediately.

func (ApplyEnvironmentManagedActionInput) GoString added in v1.1.19

GoString returns the string representation

func (*ApplyEnvironmentManagedActionInput) SetActionId added in v1.5.0

SetActionId sets the ActionId field's value.

func (*ApplyEnvironmentManagedActionInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*ApplyEnvironmentManagedActionInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (ApplyEnvironmentManagedActionInput) String added in v1.1.19

String returns the string representation

func (*ApplyEnvironmentManagedActionInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type ApplyEnvironmentManagedActionOutput added in v1.1.19

type ApplyEnvironmentManagedActionOutput struct {

	// A description of the managed action.
	ActionDescription *string `type:"string"`

	// The action ID of the managed action.
	ActionId *string `type:"string"`

	// The type of managed action.
	ActionType *string `type:"string" enum:"ActionType"`

	// The status of the managed action.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

The result message containing information about the managed action.

func (ApplyEnvironmentManagedActionOutput) GoString added in v1.1.19

GoString returns the string representation

func (*ApplyEnvironmentManagedActionOutput) SetActionDescription added in v1.5.0

SetActionDescription sets the ActionDescription field's value.

func (*ApplyEnvironmentManagedActionOutput) SetActionId added in v1.5.0

SetActionId sets the ActionId field's value.

func (*ApplyEnvironmentManagedActionOutput) SetActionType added in v1.5.0

SetActionType sets the ActionType field's value.

func (*ApplyEnvironmentManagedActionOutput) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (ApplyEnvironmentManagedActionOutput) String added in v1.1.19

String returns the string representation

type AutoScalingGroup

type AutoScalingGroup struct {

	// The name of the AutoScalingGroup .
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Describes an Auto Scaling launch configuration.

func (AutoScalingGroup) GoString added in v0.6.5

func (s AutoScalingGroup) GoString() string

GoString returns the string representation

func (*AutoScalingGroup) SetName added in v1.5.0

func (s *AutoScalingGroup) SetName(v string) *AutoScalingGroup

SetName sets the Name field's value.

func (AutoScalingGroup) String added in v0.6.5

func (s AutoScalingGroup) String() string

String returns the string representation

type BuildConfiguration added in v1.5.13

type BuildConfiguration struct {

	// The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk
	// stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip.
	// If not provided, Elastic Beanstalk stores the build artifact in the S3 location
	// S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.
	ArtifactName *string `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that enables AWS CodeBuild to interact with dependent AWS services
	// on behalf of the AWS account.
	//
	// CodeBuildServiceRole is a required field
	CodeBuildServiceRole *string `type:"string" required:"true"`

	// Information about the compute resources the build project will use.
	//
	//    * BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds
	//
	//    * BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds
	//
	//    * BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds
	ComputeType *string `type:"string" enum:"ComputeType"`

	// The ID of the Docker image to use for this build project.
	//
	// Image is a required field
	Image *string `type:"string" required:"true"`

	// How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until
	// timing out any related build that does not get marked as completed. The default
	// is 60 minutes.
	TimeoutInMinutes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Settings for an AWS CodeBuild build.

func (BuildConfiguration) GoString added in v1.5.13

func (s BuildConfiguration) GoString() string

GoString returns the string representation

func (*BuildConfiguration) SetArtifactName added in v1.5.13

func (s *BuildConfiguration) SetArtifactName(v string) *BuildConfiguration

SetArtifactName sets the ArtifactName field's value.

func (*BuildConfiguration) SetCodeBuildServiceRole added in v1.5.13

func (s *BuildConfiguration) SetCodeBuildServiceRole(v string) *BuildConfiguration

SetCodeBuildServiceRole sets the CodeBuildServiceRole field's value.

func (*BuildConfiguration) SetComputeType added in v1.5.13

func (s *BuildConfiguration) SetComputeType(v string) *BuildConfiguration

SetComputeType sets the ComputeType field's value.

func (*BuildConfiguration) SetImage added in v1.5.13

SetImage sets the Image field's value.

func (*BuildConfiguration) SetTimeoutInMinutes added in v1.5.13

func (s *BuildConfiguration) SetTimeoutInMinutes(v int64) *BuildConfiguration

SetTimeoutInMinutes sets the TimeoutInMinutes field's value.

func (BuildConfiguration) String added in v1.5.13

func (s BuildConfiguration) String() string

String returns the string representation

func (*BuildConfiguration) Validate added in v1.5.13

func (s *BuildConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Builder added in v1.6.27

type Builder struct {

	// The ARN of the builder.
	ARN *string `type:"string"`
	// contains filtered or unexported fields
}

The builder used to build the custom platform.

func (Builder) GoString added in v1.6.27

func (s Builder) GoString() string

GoString returns the string representation

func (*Builder) SetARN added in v1.6.27

func (s *Builder) SetARN(v string) *Builder

SetARN sets the ARN field's value.

func (Builder) String added in v1.6.27

func (s Builder) String() string

String returns the string representation

type CPUUtilization added in v0.7.4

type CPUUtilization struct {

	// Available on Linux environments only.
	//
	// Percentage of time that the CPU has spent in the I/O Wait state over the
	// last 10 seconds.
	IOWait *float64 `type:"double"`

	// Available on Linux environments only.
	//
	// Percentage of time that the CPU has spent in the IRQ state over the last
	// 10 seconds.
	IRQ *float64 `type:"double"`

	// Percentage of time that the CPU has spent in the Idle state over the last
	// 10 seconds.
	Idle *float64 `type:"double"`

	// Available on Linux environments only.
	//
	// Percentage of time that the CPU has spent in the Nice state over the last
	// 10 seconds.
	Nice *float64 `type:"double"`

	// Available on Windows environments only.
	//
	// Percentage of time that the CPU has spent in the Privileged state over the
	// last 10 seconds.
	Privileged *float64 `type:"double"`

	// Available on Linux environments only.
	//
	// Percentage of time that the CPU has spent in the SoftIRQ state over the last
	// 10 seconds.
	SoftIRQ *float64 `type:"double"`

	// Available on Linux environments only.
	//
	// Percentage of time that the CPU has spent in the System state over the last
	// 10 seconds.
	System *float64 `type:"double"`

	// Percentage of time that the CPU has spent in the User state over the last
	// 10 seconds.
	User *float64 `type:"double"`
	// contains filtered or unexported fields
}

CPU utilization metrics for an instance.

func (CPUUtilization) GoString added in v0.7.4

func (s CPUUtilization) GoString() string

GoString returns the string representation

func (*CPUUtilization) SetIOWait added in v1.5.0

func (s *CPUUtilization) SetIOWait(v float64) *CPUUtilization

SetIOWait sets the IOWait field's value.

func (*CPUUtilization) SetIRQ added in v1.5.0

func (s *CPUUtilization) SetIRQ(v float64) *CPUUtilization

SetIRQ sets the IRQ field's value.

func (*CPUUtilization) SetIdle added in v1.5.0

func (s *CPUUtilization) SetIdle(v float64) *CPUUtilization

SetIdle sets the Idle field's value.

func (*CPUUtilization) SetNice added in v1.5.0

func (s *CPUUtilization) SetNice(v float64) *CPUUtilization

SetNice sets the Nice field's value.

func (*CPUUtilization) SetPrivileged added in v1.99.0

func (s *CPUUtilization) SetPrivileged(v float64) *CPUUtilization

SetPrivileged sets the Privileged field's value.

func (*CPUUtilization) SetSoftIRQ added in v1.5.0

func (s *CPUUtilization) SetSoftIRQ(v float64) *CPUUtilization

SetSoftIRQ sets the SoftIRQ field's value.

func (*CPUUtilization) SetSystem added in v1.5.0

func (s *CPUUtilization) SetSystem(v float64) *CPUUtilization

SetSystem sets the System field's value.

func (*CPUUtilization) SetUser added in v1.5.0

func (s *CPUUtilization) SetUser(v float64) *CPUUtilization

SetUser sets the User field's value.

func (CPUUtilization) String added in v0.7.4

func (s CPUUtilization) String() string

String returns the string representation

type CheckDNSAvailabilityInput

type CheckDNSAvailabilityInput struct {

	// The prefix used when this CNAME is reserved.
	//
	// CNAMEPrefix is a required field
	CNAMEPrefix *string `min:"4" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Results message indicating whether a CNAME is available.

func (CheckDNSAvailabilityInput) GoString added in v0.6.5

func (s CheckDNSAvailabilityInput) GoString() string

GoString returns the string representation

func (*CheckDNSAvailabilityInput) SetCNAMEPrefix added in v1.5.0

SetCNAMEPrefix sets the CNAMEPrefix field's value.

func (CheckDNSAvailabilityInput) String added in v0.6.5

func (s CheckDNSAvailabilityInput) String() string

String returns the string representation

func (*CheckDNSAvailabilityInput) Validate added in v1.1.21

func (s *CheckDNSAvailabilityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CheckDNSAvailabilityOutput

type CheckDNSAvailabilityOutput struct {

	// Indicates if the specified CNAME is available:
	//
	//    * true : The CNAME is available.
	//
	//    * false : The CNAME is not available.
	Available *bool `type:"boolean"`

	// The fully qualified CNAME to reserve when CreateEnvironment is called with
	// the provided prefix.
	FullyQualifiedCNAME *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Indicates if the specified CNAME is available.

func (CheckDNSAvailabilityOutput) GoString added in v0.6.5

func (s CheckDNSAvailabilityOutput) GoString() string

GoString returns the string representation

func (*CheckDNSAvailabilityOutput) SetAvailable added in v1.5.0

SetAvailable sets the Available field's value.

func (*CheckDNSAvailabilityOutput) SetFullyQualifiedCNAME added in v1.5.0

func (s *CheckDNSAvailabilityOutput) SetFullyQualifiedCNAME(v string) *CheckDNSAvailabilityOutput

SetFullyQualifiedCNAME sets the FullyQualifiedCNAME field's value.

func (CheckDNSAvailabilityOutput) String added in v0.6.5

String returns the string representation

type ComposeEnvironmentsInput added in v1.0.1

type ComposeEnvironmentsInput struct {

	// The name of the application to which the specified source bundles belong.
	ApplicationName *string `min:"1" type:"string"`

	// The name of the group to which the target environments belong. Specify a
	// group name only if the environment name defined in each target environment's
	// manifest ends with a + (plus) character. See Environment Manifest (env.yaml)
	// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html)
	// for details.
	GroupName *string `min:"1" type:"string"`

	// A list of version labels, specifying one or more application source bundles
	// that belong to the target application. Each source bundle must include an
	// environment manifest that specifies the name of the environment and the name
	// of the solution stack to use, and optionally can specify environment links
	// to create.
	VersionLabels []*string `type:"list"`
	// contains filtered or unexported fields
}

Request to create or update a group of environments.

func (ComposeEnvironmentsInput) GoString added in v1.0.1

func (s ComposeEnvironmentsInput) GoString() string

GoString returns the string representation

func (*ComposeEnvironmentsInput) SetApplicationName added in v1.5.0

func (s *ComposeEnvironmentsInput) SetApplicationName(v string) *ComposeEnvironmentsInput

SetApplicationName sets the ApplicationName field's value.

func (*ComposeEnvironmentsInput) SetGroupName added in v1.5.0

SetGroupName sets the GroupName field's value.

func (*ComposeEnvironmentsInput) SetVersionLabels added in v1.5.0

func (s *ComposeEnvironmentsInput) SetVersionLabels(v []*string) *ComposeEnvironmentsInput

SetVersionLabels sets the VersionLabels field's value.

func (ComposeEnvironmentsInput) String added in v1.0.1

func (s ComposeEnvironmentsInput) String() string

String returns the string representation

func (*ComposeEnvironmentsInput) Validate added in v1.1.21

func (s *ComposeEnvironmentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfigurationOptionDescription

type ConfigurationOptionDescription struct {

	// An indication of which action is required if the value for this configuration
	// option changes:
	//
	//    * NoInterruption : There is no interruption to the environment or application
	//    availability.
	//
	//    * RestartEnvironment : The environment is entirely restarted, all AWS
	//    resources are deleted and recreated, and the environment is unavailable
	//    during the process.
	//
	//    * RestartApplicationServer : The environment is available the entire time.
	//    However, a short application outage occurs when the application servers
	//    on the running Amazon EC2 instances are restarted.
	ChangeSeverity *string `type:"string"`

	// The default value for this configuration option.
	DefaultValue *string `type:"string"`

	// If specified, the configuration option must be a string value no longer than
	// this value.
	MaxLength *int64 `type:"integer"`

	// If specified, the configuration option must be a numeric value less than
	// this value.
	MaxValue *int64 `type:"integer"`

	// If specified, the configuration option must be a numeric value greater than
	// this value.
	MinValue *int64 `type:"integer"`

	// The name of the configuration option.
	Name *string `type:"string"`

	// A unique namespace identifying the option's associated AWS resource.
	Namespace *string `type:"string"`

	// If specified, the configuration option must be a string value that satisfies
	// this regular expression.
	Regex *OptionRestrictionRegex `type:"structure"`

	// An indication of whether the user defined this configuration option:
	//
	//    * true : This configuration option was defined by the user. It is a valid
	//    choice for specifying if this as an Option to Remove when updating configuration
	//    settings.
	//
	//    * false : This configuration was not defined by the user.
	//
	// Constraint: You can remove only UserDefined options from a configuration.
	//
	// Valid Values: true | false
	UserDefined *bool `type:"boolean"`

	// If specified, values for the configuration option are selected from this
	// list.
	ValueOptions []*string `type:"list"`

	// An indication of which type of values this option has and whether it is allowable
	// to select one or more than one of the possible values:
	//
	//    * Scalar : Values for this option are a single selection from the possible
	//    values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex
	//    constraints.
	//
	//    * List : Values for this option are multiple selections from the possible
	//    values.
	//
	//    * Boolean : Values for this option are either true or false .
	//
	//    * Json : Values for this option are a JSON representation of a ConfigDocument.
	ValueType *string `type:"string" enum:"ConfigurationOptionValueType"`
	// contains filtered or unexported fields
}

Describes the possible values for a configuration option.

func (ConfigurationOptionDescription) GoString added in v0.6.5

GoString returns the string representation

func (*ConfigurationOptionDescription) SetChangeSeverity added in v1.5.0

SetChangeSeverity sets the ChangeSeverity field's value.

func (*ConfigurationOptionDescription) SetDefaultValue added in v1.5.0

SetDefaultValue sets the DefaultValue field's value.

func (*ConfigurationOptionDescription) SetMaxLength added in v1.5.0

SetMaxLength sets the MaxLength field's value.

func (*ConfigurationOptionDescription) SetMaxValue added in v1.5.0

SetMaxValue sets the MaxValue field's value.

func (*ConfigurationOptionDescription) SetMinValue added in v1.5.0

SetMinValue sets the MinValue field's value.

func (*ConfigurationOptionDescription) SetName added in v1.5.0

SetName sets the Name field's value.

func (*ConfigurationOptionDescription) SetNamespace added in v1.5.0

SetNamespace sets the Namespace field's value.

func (*ConfigurationOptionDescription) SetRegex added in v1.5.0

SetRegex sets the Regex field's value.

func (*ConfigurationOptionDescription) SetUserDefined added in v1.5.0

SetUserDefined sets the UserDefined field's value.

func (*ConfigurationOptionDescription) SetValueOptions added in v1.5.0

SetValueOptions sets the ValueOptions field's value.

func (*ConfigurationOptionDescription) SetValueType added in v1.5.0

SetValueType sets the ValueType field's value.

func (ConfigurationOptionDescription) String added in v0.6.5

String returns the string representation

type ConfigurationOptionSetting

type ConfigurationOptionSetting struct {

	// A unique namespace identifying the option's associated AWS resource.
	Namespace *string `type:"string"`

	// The name of the configuration option.
	OptionName *string `type:"string"`

	// A unique resource name for a time-based scaling configuration option.
	ResourceName *string `min:"1" type:"string"`

	// The current value for the configuration option.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide.

func (ConfigurationOptionSetting) GoString added in v0.6.5

func (s ConfigurationOptionSetting) GoString() string

GoString returns the string representation

func (*ConfigurationOptionSetting) SetNamespace added in v1.5.0

SetNamespace sets the Namespace field's value.

func (*ConfigurationOptionSetting) SetOptionName added in v1.5.0

SetOptionName sets the OptionName field's value.

func (*ConfigurationOptionSetting) SetResourceName added in v1.5.0

SetResourceName sets the ResourceName field's value.

func (*ConfigurationOptionSetting) SetValue added in v1.5.0

SetValue sets the Value field's value.

func (ConfigurationOptionSetting) String added in v0.6.5

String returns the string representation

func (*ConfigurationOptionSetting) Validate added in v1.1.21

func (s *ConfigurationOptionSetting) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfigurationSettingsDescription

type ConfigurationSettingsDescription struct {

	// The name of the application associated with this configuration set.
	ApplicationName *string `min:"1" type:"string"`

	// The date (in UTC time) when this configuration set was created.
	DateCreated *time.Time `type:"timestamp"`

	// The date (in UTC time) when this configuration set was last modified.
	DateUpdated *time.Time `type:"timestamp"`

	// If this configuration set is associated with an environment, the DeploymentStatus
	// parameter indicates the deployment status of this configuration set:
	//
	//    * null: This configuration is not associated with a running environment.
	//
	//    * pending: This is a draft configuration that is not deployed to the associated
	//    environment but is in the process of deploying.
	//
	//    * deployed: This is the configuration that is currently deployed to the
	//    associated running environment.
	//
	//    * failed: This is a draft configuration that failed to successfully deploy.
	DeploymentStatus *string `type:"string" enum:"ConfigurationDeploymentStatus"`

	// Describes this configuration set.
	Description *string `type:"string"`

	// If not null, the name of the environment for this configuration set.
	EnvironmentName *string `min:"4" type:"string"`

	// A list of the configuration options and their values in this configuration
	// set.
	OptionSettings []*ConfigurationOptionSetting `type:"list"`

	// The ARN of the platform.
	PlatformArn *string `type:"string"`

	// The name of the solution stack this configuration set uses.
	SolutionStackName *string `type:"string"`

	// If not null, the name of the configuration template for this configuration
	// set.
	TemplateName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the settings for a configuration set.

func (ConfigurationSettingsDescription) GoString added in v0.6.5

GoString returns the string representation

func (*ConfigurationSettingsDescription) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*ConfigurationSettingsDescription) SetDateCreated added in v1.5.0

SetDateCreated sets the DateCreated field's value.

func (*ConfigurationSettingsDescription) SetDateUpdated added in v1.5.0

SetDateUpdated sets the DateUpdated field's value.

func (*ConfigurationSettingsDescription) SetDeploymentStatus added in v1.5.0

SetDeploymentStatus sets the DeploymentStatus field's value.

func (*ConfigurationSettingsDescription) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*ConfigurationSettingsDescription) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*ConfigurationSettingsDescription) SetOptionSettings added in v1.5.0

SetOptionSettings sets the OptionSettings field's value.

func (*ConfigurationSettingsDescription) SetPlatformArn added in v1.6.27

SetPlatformArn sets the PlatformArn field's value.

func (*ConfigurationSettingsDescription) SetSolutionStackName added in v1.5.0

SetSolutionStackName sets the SolutionStackName field's value.

func (*ConfigurationSettingsDescription) SetTemplateName added in v1.5.0

SetTemplateName sets the TemplateName field's value.

func (ConfigurationSettingsDescription) String added in v0.6.5

String returns the string representation

type CreateApplicationInput

type CreateApplicationInput struct {

	// The name of the application.
	//
	// Constraint: This name must be unique within your account. If the specified
	// name already exists, the action returns an InvalidParameterValue error.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Describes the application.
	Description *string `type:"string"`

	// Specify an application resource lifecycle configuration to prevent your application
	// from accumulating too many versions.
	ResourceLifecycleConfig *ApplicationResourceLifecycleConfig `type:"structure"`

	// Specifies the tags applied to the application.
	//
	// Elastic Beanstalk applies these tags only to the application. Environments
	// that you create in the application don't inherit the tags.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Request to create an application.

func (CreateApplicationInput) GoString added in v0.6.5

func (s CreateApplicationInput) GoString() string

GoString returns the string representation

func (*CreateApplicationInput) SetApplicationName added in v1.5.0

func (s *CreateApplicationInput) SetApplicationName(v string) *CreateApplicationInput

SetApplicationName sets the ApplicationName field's value.

func (*CreateApplicationInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*CreateApplicationInput) SetResourceLifecycleConfig added in v1.6.8

SetResourceLifecycleConfig sets the ResourceLifecycleConfig field's value.

func (*CreateApplicationInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateApplicationInput) String added in v0.6.5

func (s CreateApplicationInput) String() string

String returns the string representation

func (*CreateApplicationInput) Validate added in v1.1.21

func (s *CreateApplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateApplicationVersionInput

type CreateApplicationVersionInput struct {

	// The name of the application. If no application is found with this name, and
	// AutoCreateApplication is false, returns an InvalidParameterValue error.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Set to true to create an application with the specified name if it doesn't
	// already exist.
	AutoCreateApplication *bool `type:"boolean"`

	// Settings for an AWS CodeBuild build.
	BuildConfiguration *BuildConfiguration `type:"structure"`

	// Describes this version.
	Description *string `type:"string"`

	// Pre-processes and validates the environment manifest (env.yaml) and configuration
	// files (*.config files in the .ebextensions folder) in the source bundle.
	// Validating configuration files can identify issues prior to deploying the
	// application version to an environment.
	//
	// You must turn processing on for application versions that you create using
	// AWS CodeBuild or AWS CodeCommit. For application versions built from a source
	// bundle in Amazon S3, processing is optional.
	//
	// The Process option validates Elastic Beanstalk configuration files. It doesn't
	// validate your application's configuration files, like proxy server or Docker
	// configuration.
	Process *bool `type:"boolean"`

	// Specify a commit in an AWS CodeCommit Git repository to use as the source
	// code for the application version.
	SourceBuildInformation *SourceBuildInformation `type:"structure"`

	// The Amazon S3 bucket and key that identify the location of the source bundle
	// for this version.
	//
	// The Amazon S3 bucket must be in the same region as the environment.
	//
	// Specify a source bundle in S3 or a commit in an AWS CodeCommit repository
	// (with SourceBuildInformation), but not both. If neither SourceBundle nor
	// SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.
	SourceBundle *S3Location `type:"structure"`

	// Specifies the tags applied to the application version.
	//
	// Elastic Beanstalk applies these tags only to the application version. Environments
	// that use the application version don't inherit the tags.
	Tags []*Tag `type:"list"`

	// A label identifying this version.
	//
	// Constraint: Must be unique per application. If an application version already
	// exists with this label for the specified application, AWS Elastic Beanstalk
	// returns an InvalidParameterValue error.
	//
	// VersionLabel is a required field
	VersionLabel *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateApplicationVersionInput) GoString added in v0.6.5

GoString returns the string representation

func (*CreateApplicationVersionInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*CreateApplicationVersionInput) SetAutoCreateApplication added in v1.5.0

func (s *CreateApplicationVersionInput) SetAutoCreateApplication(v bool) *CreateApplicationVersionInput

SetAutoCreateApplication sets the AutoCreateApplication field's value.

func (*CreateApplicationVersionInput) SetBuildConfiguration added in v1.5.13

SetBuildConfiguration sets the BuildConfiguration field's value.

func (*CreateApplicationVersionInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*CreateApplicationVersionInput) SetProcess added in v1.5.0

SetProcess sets the Process field's value.

func (*CreateApplicationVersionInput) SetSourceBuildInformation added in v1.5.0

SetSourceBuildInformation sets the SourceBuildInformation field's value.

func (*CreateApplicationVersionInput) SetSourceBundle added in v1.5.0

SetSourceBundle sets the SourceBundle field's value.

func (*CreateApplicationVersionInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (*CreateApplicationVersionInput) SetVersionLabel added in v1.5.0

SetVersionLabel sets the VersionLabel field's value.

func (CreateApplicationVersionInput) String added in v0.6.5

String returns the string representation

func (*CreateApplicationVersionInput) Validate added in v1.1.21

func (s *CreateApplicationVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConfigurationTemplateInput

type CreateConfigurationTemplateInput struct {

	// The name of the application to associate with this configuration template.
	// If no application is found with this name, AWS Elastic Beanstalk returns
	// an InvalidParameterValue error.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Describes this configuration.
	Description *string `type:"string"`

	// The ID of the environment used with this configuration template.
	EnvironmentId *string `type:"string"`

	// If specified, AWS Elastic Beanstalk sets the specified configuration option
	// to the requested value. The new value overrides the value obtained from the
	// solution stack or the source configuration template.
	OptionSettings []*ConfigurationOptionSetting `type:"list"`

	// The ARN of the custom platform.
	PlatformArn *string `type:"string"`

	// The name of the solution stack used by this configuration. The solution stack
	// specifies the operating system, architecture, and application server for
	// a configuration template. It determines the set of configuration options
	// as well as the possible and default values.
	//
	// Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
	//
	// A solution stack name or a source configuration parameter must be specified,
	// otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.
	//
	// If a solution stack name is not specified and the source configuration parameter
	// is specified, AWS Elastic Beanstalk uses the same solution stack as the source
	// configuration template.
	SolutionStackName *string `type:"string"`

	// If specified, AWS Elastic Beanstalk uses the configuration values from the
	// specified configuration template to create a new configuration.
	//
	// Values specified in the OptionSettings parameter of this call overrides any
	// values obtained from the SourceConfiguration.
	//
	// If no configuration template is found, returns an InvalidParameterValue error.
	//
	// Constraint: If both the solution stack name parameter and the source configuration
	// parameters are specified, the solution stack of the source configuration
	// template must match the specified solution stack name or else AWS Elastic
	// Beanstalk returns an InvalidParameterCombination error.
	SourceConfiguration *SourceConfiguration `type:"structure"`

	// Specifies the tags applied to the configuration template.
	Tags []*Tag `type:"list"`

	// The name of the configuration template.
	//
	// Constraint: This name must be unique per application.
	//
	// Default: If a configuration template already exists with this name, AWS Elastic
	// Beanstalk returns an InvalidParameterValue error.
	//
	// TemplateName is a required field
	TemplateName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to create a configuration template.

func (CreateConfigurationTemplateInput) GoString added in v0.6.5

GoString returns the string representation

func (*CreateConfigurationTemplateInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*CreateConfigurationTemplateInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*CreateConfigurationTemplateInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateConfigurationTemplateInput) SetOptionSettings added in v1.5.0

SetOptionSettings sets the OptionSettings field's value.

func (*CreateConfigurationTemplateInput) SetPlatformArn added in v1.6.27

SetPlatformArn sets the PlatformArn field's value.

func (*CreateConfigurationTemplateInput) SetSolutionStackName added in v1.5.0

SetSolutionStackName sets the SolutionStackName field's value.

func (*CreateConfigurationTemplateInput) SetSourceConfiguration added in v1.5.0

SetSourceConfiguration sets the SourceConfiguration field's value.

func (*CreateConfigurationTemplateInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (*CreateConfigurationTemplateInput) SetTemplateName added in v1.5.0

SetTemplateName sets the TemplateName field's value.

func (CreateConfigurationTemplateInput) String added in v0.6.5

String returns the string representation

func (*CreateConfigurationTemplateInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type CreateEnvironmentInput

type CreateEnvironmentInput struct {

	// The name of the application that contains the version to be deployed.
	//
	// If no application is found with this name, CreateEnvironment returns an InvalidParameterValue
	// error.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// If specified, the environment attempts to use this value as the prefix for
	// the CNAME. If not specified, the CNAME is generated automatically by appending
	// a random alphanumeric string to the environment name.
	CNAMEPrefix *string `min:"4" type:"string"`

	// Describes this environment.
	Description *string `type:"string"`

	// A unique name for the deployment environment. Used in the application URL.
	//
	// Constraint: Must be from 4 to 40 characters in length. The name can contain
	// only letters, numbers, and hyphens. It cannot start or end with a hyphen.
	// This name must be unique within a region in your account. If the specified
	// name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue
	// error.
	//
	// Default: If the CNAME parameter is not specified, the environment name becomes
	// part of the CNAME, and therefore part of the visible URL for your application.
	EnvironmentName *string `min:"4" type:"string"`

	// The name of the group to which the target environment belongs. Specify a
	// group name only if the environment's name is specified in an environment
	// manifest and not with the environment name parameter. See Environment Manifest
	// (env.yaml) (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html)
	// for details.
	GroupName *string `min:"1" type:"string"`

	// If specified, AWS Elastic Beanstalk sets the specified configuration options
	// to the requested value in the configuration set for the new environment.
	// These override the values obtained from the solution stack or the configuration
	// template.
	OptionSettings []*ConfigurationOptionSetting `type:"list"`

	// A list of custom user-defined configuration options to remove from the configuration
	// set for this new environment.
	OptionsToRemove []*OptionSpecification `type:"list"`

	// The ARN of the platform.
	PlatformArn *string `type:"string"`

	// This is an alternative to specifying a template name. If specified, AWS Elastic
	// Beanstalk sets the configuration values to the default values associated
	// with the specified solution stack.
	//
	// For a list of current solution stacks, see Elastic Beanstalk Supported Platforms
	// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html).
	SolutionStackName *string `type:"string"`

	// Specifies the tags applied to resources in the environment.
	Tags []*Tag `type:"list"`

	// The name of the configuration template to use in deployment. If no configuration
	// template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue
	// error.
	TemplateName *string `min:"1" type:"string"`

	// This specifies the tier to use for creating this environment.
	Tier *EnvironmentTier `type:"structure"`

	// The name of the application version to deploy.
	//
	// If the specified application has no associated application versions, AWS
	// Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.
	//
	// Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample
	// application in the container.
	VersionLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateEnvironmentInput) GoString added in v0.6.5

func (s CreateEnvironmentInput) GoString() string

GoString returns the string representation

func (*CreateEnvironmentInput) SetApplicationName added in v1.5.0

func (s *CreateEnvironmentInput) SetApplicationName(v string) *CreateEnvironmentInput

SetApplicationName sets the ApplicationName field's value.

func (*CreateEnvironmentInput) SetCNAMEPrefix added in v1.5.0

SetCNAMEPrefix sets the CNAMEPrefix field's value.

func (*CreateEnvironmentInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*CreateEnvironmentInput) SetEnvironmentName added in v1.5.0

func (s *CreateEnvironmentInput) SetEnvironmentName(v string) *CreateEnvironmentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*CreateEnvironmentInput) SetGroupName added in v1.5.0

SetGroupName sets the GroupName field's value.

func (*CreateEnvironmentInput) SetOptionSettings added in v1.5.0

SetOptionSettings sets the OptionSettings field's value.

func (*CreateEnvironmentInput) SetOptionsToRemove added in v1.5.0

SetOptionsToRemove sets the OptionsToRemove field's value.

func (*CreateEnvironmentInput) SetPlatformArn added in v1.6.27

SetPlatformArn sets the PlatformArn field's value.

func (*CreateEnvironmentInput) SetSolutionStackName added in v1.5.0

func (s *CreateEnvironmentInput) SetSolutionStackName(v string) *CreateEnvironmentInput

SetSolutionStackName sets the SolutionStackName field's value.

func (*CreateEnvironmentInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*CreateEnvironmentInput) SetTemplateName added in v1.5.0

func (s *CreateEnvironmentInput) SetTemplateName(v string) *CreateEnvironmentInput

SetTemplateName sets the TemplateName field's value.

func (*CreateEnvironmentInput) SetTier added in v1.5.0

SetTier sets the Tier field's value.

func (*CreateEnvironmentInput) SetVersionLabel added in v1.5.0

func (s *CreateEnvironmentInput) SetVersionLabel(v string) *CreateEnvironmentInput

SetVersionLabel sets the VersionLabel field's value.

func (CreateEnvironmentInput) String added in v0.6.5

func (s CreateEnvironmentInput) String() string

String returns the string representation

func (*CreateEnvironmentInput) Validate added in v1.1.21

func (s *CreateEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePlatformVersionInput added in v1.6.27

type CreatePlatformVersionInput struct {

	// The name of the builder environment.
	EnvironmentName *string `min:"4" type:"string"`

	// The configuration option settings to apply to the builder environment.
	OptionSettings []*ConfigurationOptionSetting `type:"list"`

	// The location of the platform definition archive in Amazon S3.
	//
	// PlatformDefinitionBundle is a required field
	PlatformDefinitionBundle *S3Location `type:"structure" required:"true"`

	// The name of your custom platform.
	//
	// PlatformName is a required field
	PlatformName *string `type:"string" required:"true"`

	// The number, such as 1.0.2, for the new platform version.
	//
	// PlatformVersion is a required field
	PlatformVersion *string `type:"string" required:"true"`

	// Specifies the tags applied to the new platform version.
	//
	// Elastic Beanstalk applies these tags only to the platform version. Environments
	// that you create using the platform version don't inherit the tags.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Request to create a new platform version.

func (CreatePlatformVersionInput) GoString added in v1.6.27

func (s CreatePlatformVersionInput) GoString() string

GoString returns the string representation

func (*CreatePlatformVersionInput) SetEnvironmentName added in v1.6.27

SetEnvironmentName sets the EnvironmentName field's value.

func (*CreatePlatformVersionInput) SetOptionSettings added in v1.6.27

SetOptionSettings sets the OptionSettings field's value.

func (*CreatePlatformVersionInput) SetPlatformDefinitionBundle added in v1.6.27

func (s *CreatePlatformVersionInput) SetPlatformDefinitionBundle(v *S3Location) *CreatePlatformVersionInput

SetPlatformDefinitionBundle sets the PlatformDefinitionBundle field's value.

func (*CreatePlatformVersionInput) SetPlatformName added in v1.6.27

SetPlatformName sets the PlatformName field's value.

func (*CreatePlatformVersionInput) SetPlatformVersion added in v1.6.27

SetPlatformVersion sets the PlatformVersion field's value.

func (*CreatePlatformVersionInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreatePlatformVersionInput) String added in v1.6.27

String returns the string representation

func (*CreatePlatformVersionInput) Validate added in v1.6.27

func (s *CreatePlatformVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePlatformVersionOutput added in v1.6.27

type CreatePlatformVersionOutput struct {

	// The builder used to create the custom platform.
	Builder *Builder `type:"structure"`

	// Detailed information about the new version of the custom platform.
	PlatformSummary *PlatformSummary `type:"structure"`
	// contains filtered or unexported fields
}

func (CreatePlatformVersionOutput) GoString added in v1.6.27

func (s CreatePlatformVersionOutput) GoString() string

GoString returns the string representation

func (*CreatePlatformVersionOutput) SetBuilder added in v1.6.27

SetBuilder sets the Builder field's value.

func (*CreatePlatformVersionOutput) SetPlatformSummary added in v1.6.27

SetPlatformSummary sets the PlatformSummary field's value.

func (CreatePlatformVersionOutput) String added in v1.6.27

String returns the string representation

type CreateStorageLocationInput

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

func (CreateStorageLocationInput) GoString added in v0.6.5

func (s CreateStorageLocationInput) GoString() string

GoString returns the string representation

func (CreateStorageLocationInput) String added in v0.6.5

String returns the string representation

type CreateStorageLocationOutput

type CreateStorageLocationOutput struct {

	// The name of the Amazon S3 bucket created.
	S3Bucket *string `type:"string"`
	// contains filtered or unexported fields
}

Results of a CreateStorageLocationResult call.

func (CreateStorageLocationOutput) GoString added in v0.6.5

func (s CreateStorageLocationOutput) GoString() string

GoString returns the string representation

func (*CreateStorageLocationOutput) SetS3Bucket added in v1.5.0

SetS3Bucket sets the S3Bucket field's value.

func (CreateStorageLocationOutput) String added in v0.6.5

String returns the string representation

type CustomAmi added in v1.6.27

type CustomAmi struct {

	// THe ID of the image used to create the custom AMI.
	ImageId *string `type:"string"`

	// The type of virtualization used to create the custom AMI.
	VirtualizationType *string `type:"string"`
	// contains filtered or unexported fields
}

A custom AMI available to platforms.

func (CustomAmi) GoString added in v1.6.27

func (s CustomAmi) GoString() string

GoString returns the string representation

func (*CustomAmi) SetImageId added in v1.6.27

func (s *CustomAmi) SetImageId(v string) *CustomAmi

SetImageId sets the ImageId field's value.

func (*CustomAmi) SetVirtualizationType added in v1.6.27

func (s *CustomAmi) SetVirtualizationType(v string) *CustomAmi

SetVirtualizationType sets the VirtualizationType field's value.

func (CustomAmi) String added in v1.6.27

func (s CustomAmi) String() string

String returns the string representation

type DeleteApplicationInput

type DeleteApplicationInput struct {

	// The name of the application to delete.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// When set to true, running environments will be terminated before deleting
	// the application.
	TerminateEnvByForce *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Request to delete an application.

func (DeleteApplicationInput) GoString added in v0.6.5

func (s DeleteApplicationInput) GoString() string

GoString returns the string representation

func (*DeleteApplicationInput) SetApplicationName added in v1.5.0

func (s *DeleteApplicationInput) SetApplicationName(v string) *DeleteApplicationInput

SetApplicationName sets the ApplicationName field's value.

func (*DeleteApplicationInput) SetTerminateEnvByForce added in v1.5.0

func (s *DeleteApplicationInput) SetTerminateEnvByForce(v bool) *DeleteApplicationInput

SetTerminateEnvByForce sets the TerminateEnvByForce field's value.

func (DeleteApplicationInput) String added in v0.6.5

func (s DeleteApplicationInput) String() string

String returns the string representation

func (*DeleteApplicationInput) Validate added in v1.1.21

func (s *DeleteApplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteApplicationOutput

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

func (DeleteApplicationOutput) GoString added in v0.6.5

func (s DeleteApplicationOutput) GoString() string

GoString returns the string representation

func (DeleteApplicationOutput) String added in v0.6.5

func (s DeleteApplicationOutput) String() string

String returns the string representation

type DeleteApplicationVersionInput

type DeleteApplicationVersionInput struct {

	// The name of the application to which the version belongs.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Set to true to delete the source bundle from your storage bucket. Otherwise,
	// the application version is deleted only from Elastic Beanstalk and the source
	// bundle remains in Amazon S3.
	DeleteSourceBundle *bool `type:"boolean"`

	// The label of the version to delete.
	//
	// VersionLabel is a required field
	VersionLabel *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to delete an application version.

func (DeleteApplicationVersionInput) GoString added in v0.6.5

GoString returns the string representation

func (*DeleteApplicationVersionInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*DeleteApplicationVersionInput) SetDeleteSourceBundle added in v1.5.0

SetDeleteSourceBundle sets the DeleteSourceBundle field's value.

func (*DeleteApplicationVersionInput) SetVersionLabel added in v1.5.0

SetVersionLabel sets the VersionLabel field's value.

func (DeleteApplicationVersionInput) String added in v0.6.5

String returns the string representation

func (*DeleteApplicationVersionInput) Validate added in v1.1.21

func (s *DeleteApplicationVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteApplicationVersionOutput

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

func (DeleteApplicationVersionOutput) GoString added in v0.6.5

GoString returns the string representation

func (DeleteApplicationVersionOutput) String added in v0.6.5

String returns the string representation

type DeleteConfigurationTemplateInput

type DeleteConfigurationTemplateInput struct {

	// The name of the application to delete the configuration template from.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// The name of the configuration template to delete.
	//
	// TemplateName is a required field
	TemplateName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to delete a configuration template.

func (DeleteConfigurationTemplateInput) GoString added in v0.6.5

GoString returns the string representation

func (*DeleteConfigurationTemplateInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*DeleteConfigurationTemplateInput) SetTemplateName added in v1.5.0

SetTemplateName sets the TemplateName field's value.

func (DeleteConfigurationTemplateInput) String added in v0.6.5

String returns the string representation

func (*DeleteConfigurationTemplateInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DeleteConfigurationTemplateOutput

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

func (DeleteConfigurationTemplateOutput) GoString added in v0.6.5

GoString returns the string representation

func (DeleteConfigurationTemplateOutput) String added in v0.6.5

String returns the string representation

type DeleteEnvironmentConfigurationInput

type DeleteEnvironmentConfigurationInput struct {

	// The name of the application the environment is associated with.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// The name of the environment to delete the draft configuration from.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `min:"4" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to delete a draft environment configuration.

func (DeleteEnvironmentConfigurationInput) GoString added in v0.6.5

GoString returns the string representation

func (*DeleteEnvironmentConfigurationInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*DeleteEnvironmentConfigurationInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (DeleteEnvironmentConfigurationInput) String added in v0.6.5

String returns the string representation

func (*DeleteEnvironmentConfigurationInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DeleteEnvironmentConfigurationOutput

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

func (DeleteEnvironmentConfigurationOutput) GoString added in v0.6.5

GoString returns the string representation

func (DeleteEnvironmentConfigurationOutput) String added in v0.6.5

String returns the string representation

type DeletePlatformVersionInput added in v1.6.27

type DeletePlatformVersionInput struct {

	// The ARN of the version of the custom platform.
	PlatformArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeletePlatformVersionInput) GoString added in v1.6.27

func (s DeletePlatformVersionInput) GoString() string

GoString returns the string representation

func (*DeletePlatformVersionInput) SetPlatformArn added in v1.6.27

SetPlatformArn sets the PlatformArn field's value.

func (DeletePlatformVersionInput) String added in v1.6.27

String returns the string representation

type DeletePlatformVersionOutput added in v1.6.27

type DeletePlatformVersionOutput struct {

	// Detailed information about the version of the custom platform.
	PlatformSummary *PlatformSummary `type:"structure"`
	// contains filtered or unexported fields
}

func (DeletePlatformVersionOutput) GoString added in v1.6.27

func (s DeletePlatformVersionOutput) GoString() string

GoString returns the string representation

func (*DeletePlatformVersionOutput) SetPlatformSummary added in v1.6.27

SetPlatformSummary sets the PlatformSummary field's value.

func (DeletePlatformVersionOutput) String added in v1.6.27

String returns the string representation

type Deployment added in v1.1.17

type Deployment struct {

	// The ID of the deployment. This number increases by one each time that you
	// deploy source code or change instance configuration settings.
	DeploymentId *int64 `type:"long"`

	// For in-progress deployments, the time that the deployment started.
	//
	// For completed deployments, the time that the deployment ended.
	DeploymentTime *time.Time `type:"timestamp"`

	// The status of the deployment:
	//
	//    * In Progress : The deployment is in progress.
	//
	//    * Deployed : The deployment succeeded.
	//
	//    * Failed : The deployment failed.
	Status *string `type:"string"`

	// The version label of the application version in the deployment.
	VersionLabel *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an application version deployment.

func (Deployment) GoString added in v1.1.17

func (s Deployment) GoString() string

GoString returns the string representation

func (*Deployment) SetDeploymentId added in v1.5.0

func (s *Deployment) SetDeploymentId(v int64) *Deployment

SetDeploymentId sets the DeploymentId field's value.

func (*Deployment) SetDeploymentTime added in v1.5.0

func (s *Deployment) SetDeploymentTime(v time.Time) *Deployment

SetDeploymentTime sets the DeploymentTime field's value.

func (*Deployment) SetStatus added in v1.5.0

func (s *Deployment) SetStatus(v string) *Deployment

SetStatus sets the Status field's value.

func (*Deployment) SetVersionLabel added in v1.5.0

func (s *Deployment) SetVersionLabel(v string) *Deployment

SetVersionLabel sets the VersionLabel field's value.

func (Deployment) String added in v1.1.17

func (s Deployment) String() string

String returns the string representation

type DescribeAccountAttributesInput added in v1.13.16

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

func (DescribeAccountAttributesInput) GoString added in v1.13.16

GoString returns the string representation

func (DescribeAccountAttributesInput) String added in v1.13.16

String returns the string representation

type DescribeAccountAttributesOutput added in v1.13.16

type DescribeAccountAttributesOutput struct {

	// The Elastic Beanstalk resource quotas associated with the calling AWS account.
	ResourceQuotas *ResourceQuotas `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAccountAttributesOutput) GoString added in v1.13.16

GoString returns the string representation

func (*DescribeAccountAttributesOutput) SetResourceQuotas added in v1.13.16

SetResourceQuotas sets the ResourceQuotas field's value.

func (DescribeAccountAttributesOutput) String added in v1.13.16

String returns the string representation

type DescribeApplicationVersionsInput

type DescribeApplicationVersionsInput struct {

	// Specify an application name to show only application versions for that application.
	ApplicationName *string `min:"1" type:"string"`

	// For a paginated request. Specify a maximum number of application versions
	// to include in each response.
	//
	// If no MaxRecords is specified, all available application versions are retrieved
	// in a single response.
	MaxRecords *int64 `min:"1" type:"integer"`

	// For a paginated request. Specify a token from a previous response page to
	// retrieve the next response page. All other parameter values must be identical
	// to the ones specified in the initial request.
	//
	// If no NextToken is specified, the first page is retrieved.
	NextToken *string `type:"string"`

	// Specify a version label to show a specific application version.
	VersionLabels []*string `type:"list"`
	// contains filtered or unexported fields
}

Request to describe application versions.

func (DescribeApplicationVersionsInput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeApplicationVersionsInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*DescribeApplicationVersionsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeApplicationVersionsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeApplicationVersionsInput) SetVersionLabels added in v1.5.0

SetVersionLabels sets the VersionLabels field's value.

func (DescribeApplicationVersionsInput) String added in v0.6.5

String returns the string representation

func (*DescribeApplicationVersionsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeApplicationVersionsOutput

type DescribeApplicationVersionsOutput struct {

	// List of ApplicationVersionDescription objects sorted in order of creation.
	ApplicationVersions []*ApplicationVersionDescription `type:"list"`

	// In a paginated request, the token that you can pass in a subsequent request
	// to get the next response page.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Result message wrapping a list of application version descriptions.

func (DescribeApplicationVersionsOutput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeApplicationVersionsOutput) SetApplicationVersions added in v1.5.0

SetApplicationVersions sets the ApplicationVersions field's value.

func (*DescribeApplicationVersionsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeApplicationVersionsOutput) String added in v0.6.5

String returns the string representation

type DescribeApplicationsInput

type DescribeApplicationsInput struct {

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// only include those with the specified names.
	ApplicationNames []*string `type:"list"`
	// contains filtered or unexported fields
}

Request to describe one or more applications.

func (DescribeApplicationsInput) GoString added in v0.6.5

func (s DescribeApplicationsInput) GoString() string

GoString returns the string representation

func (*DescribeApplicationsInput) SetApplicationNames added in v1.5.0

func (s *DescribeApplicationsInput) SetApplicationNames(v []*string) *DescribeApplicationsInput

SetApplicationNames sets the ApplicationNames field's value.

func (DescribeApplicationsInput) String added in v0.6.5

func (s DescribeApplicationsInput) String() string

String returns the string representation

type DescribeApplicationsOutput

type DescribeApplicationsOutput struct {

	// This parameter contains a list of ApplicationDescription.
	Applications []*ApplicationDescription `type:"list"`
	// contains filtered or unexported fields
}

Result message containing a list of application descriptions.

func (DescribeApplicationsOutput) GoString added in v0.6.5

func (s DescribeApplicationsOutput) GoString() string

GoString returns the string representation

func (*DescribeApplicationsOutput) SetApplications added in v1.5.0

SetApplications sets the Applications field's value.

func (DescribeApplicationsOutput) String added in v0.6.5

String returns the string representation

type DescribeConfigurationOptionsInput

type DescribeConfigurationOptionsInput struct {

	// The name of the application associated with the configuration template or
	// environment. Only needed if you want to describe the configuration options
	// associated with either the configuration template or environment.
	ApplicationName *string `min:"1" type:"string"`

	// The name of the environment whose configuration options you want to describe.
	EnvironmentName *string `min:"4" type:"string"`

	// If specified, restricts the descriptions to only the specified options.
	Options []*OptionSpecification `type:"list"`

	// The ARN of the custom platform.
	PlatformArn *string `type:"string"`

	// The name of the solution stack whose configuration options you want to describe.
	SolutionStackName *string `type:"string"`

	// The name of the configuration template whose configuration options you want
	// to describe.
	TemplateName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Result message containing a list of application version descriptions.

func (DescribeConfigurationOptionsInput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeConfigurationOptionsInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*DescribeConfigurationOptionsInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*DescribeConfigurationOptionsInput) SetOptions added in v1.5.0

SetOptions sets the Options field's value.

func (*DescribeConfigurationOptionsInput) SetPlatformArn added in v1.6.27

SetPlatformArn sets the PlatformArn field's value.

func (*DescribeConfigurationOptionsInput) SetSolutionStackName added in v1.5.0

SetSolutionStackName sets the SolutionStackName field's value.

func (*DescribeConfigurationOptionsInput) SetTemplateName added in v1.5.0

SetTemplateName sets the TemplateName field's value.

func (DescribeConfigurationOptionsInput) String added in v0.6.5

String returns the string representation

func (*DescribeConfigurationOptionsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeConfigurationOptionsOutput

type DescribeConfigurationOptionsOutput struct {

	// A list of ConfigurationOptionDescription.
	Options []*ConfigurationOptionDescription `type:"list"`

	// The ARN of the platform.
	PlatformArn *string `type:"string"`

	// The name of the solution stack these configuration options belong to.
	SolutionStackName *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the settings for a specified configuration set.

func (DescribeConfigurationOptionsOutput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeConfigurationOptionsOutput) SetOptions added in v1.5.0

SetOptions sets the Options field's value.

func (*DescribeConfigurationOptionsOutput) SetPlatformArn added in v1.6.27

SetPlatformArn sets the PlatformArn field's value.

func (*DescribeConfigurationOptionsOutput) SetSolutionStackName added in v1.5.0

SetSolutionStackName sets the SolutionStackName field's value.

func (DescribeConfigurationOptionsOutput) String added in v0.6.5

String returns the string representation

type DescribeConfigurationSettingsInput

type DescribeConfigurationSettingsInput struct {

	// The application for the environment or configuration template.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// The name of the environment to describe.
	//
	// Condition: You must specify either this or a TemplateName, but not both.
	// If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
	// error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string `min:"4" type:"string"`

	// The name of the configuration template to describe.
	//
	// Conditional: You must specify either this parameter or an EnvironmentName,
	// but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
	// error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter
	// error.
	TemplateName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Result message containing all of the configuration settings for a specified solution stack or configuration template.

func (DescribeConfigurationSettingsInput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeConfigurationSettingsInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*DescribeConfigurationSettingsInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*DescribeConfigurationSettingsInput) SetTemplateName added in v1.5.0

SetTemplateName sets the TemplateName field's value.

func (DescribeConfigurationSettingsInput) String added in v0.6.5

String returns the string representation

func (*DescribeConfigurationSettingsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeConfigurationSettingsOutput

type DescribeConfigurationSettingsOutput struct {

	// A list of ConfigurationSettingsDescription.
	ConfigurationSettings []*ConfigurationSettingsDescription `type:"list"`
	// contains filtered or unexported fields
}

The results from a request to change the configuration settings of an environment.

func (DescribeConfigurationSettingsOutput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeConfigurationSettingsOutput) SetConfigurationSettings added in v1.5.0

SetConfigurationSettings sets the ConfigurationSettings field's value.

func (DescribeConfigurationSettingsOutput) String added in v0.6.5

String returns the string representation

type DescribeEnvironmentHealthInput added in v0.7.4

type DescribeEnvironmentHealthInput struct {

	// Specify the response elements to return. To retrieve all attributes, set
	// to All. If no attribute names are specified, returns the name of the environment.
	AttributeNames []*string `type:"list"`

	// Specify the environment by ID.
	//
	// You must specify either this or an EnvironmentName, or both.
	EnvironmentId *string `type:"string"`

	// Specify the environment by name.
	//
	// You must specify either this or an EnvironmentName, or both.
	EnvironmentName *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

See the example below to learn how to create a request body.

func (DescribeEnvironmentHealthInput) GoString added in v0.7.4

GoString returns the string representation

func (*DescribeEnvironmentHealthInput) SetAttributeNames added in v1.5.0

SetAttributeNames sets the AttributeNames field's value.

func (*DescribeEnvironmentHealthInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*DescribeEnvironmentHealthInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (DescribeEnvironmentHealthInput) String added in v0.7.4

String returns the string representation

func (*DescribeEnvironmentHealthInput) Validate added in v1.1.21

func (s *DescribeEnvironmentHealthInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEnvironmentHealthOutput added in v0.7.4

type DescribeEnvironmentHealthOutput struct {

	// Application request metrics for the environment.
	ApplicationMetrics *ApplicationMetrics `type:"structure"`

	// Descriptions of the data that contributed to the environment's current health
	// status.
	Causes []*string `type:"list"`

	// The health color (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html)
	// of the environment.
	Color *string `type:"string"`

	// The environment's name.
	EnvironmentName *string `min:"4" type:"string"`

	// The health status (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html)
	// of the environment. For example, Ok.
	HealthStatus *string `type:"string"`

	// Summary health information for the instances in the environment.
	InstancesHealth *InstanceHealthSummary `type:"structure"`

	// The date and time that the health information was retrieved.
	RefreshedAt *time.Time `type:"timestamp"`

	// The environment's operational status. Ready, Launching, Updating, Terminating,
	// or Terminated.
	Status *string `type:"string" enum:"EnvironmentHealth"`
	// contains filtered or unexported fields
}

Health details for an AWS Elastic Beanstalk environment.

func (DescribeEnvironmentHealthOutput) GoString added in v0.7.4

GoString returns the string representation

func (*DescribeEnvironmentHealthOutput) SetApplicationMetrics added in v1.5.0

SetApplicationMetrics sets the ApplicationMetrics field's value.

func (*DescribeEnvironmentHealthOutput) SetCauses added in v1.5.0

SetCauses sets the Causes field's value.

func (*DescribeEnvironmentHealthOutput) SetColor added in v1.5.0

SetColor sets the Color field's value.

func (*DescribeEnvironmentHealthOutput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*DescribeEnvironmentHealthOutput) SetHealthStatus added in v1.5.0

SetHealthStatus sets the HealthStatus field's value.

func (*DescribeEnvironmentHealthOutput) SetInstancesHealth added in v1.5.0

SetInstancesHealth sets the InstancesHealth field's value.

func (*DescribeEnvironmentHealthOutput) SetRefreshedAt added in v1.5.0

SetRefreshedAt sets the RefreshedAt field's value.

func (*DescribeEnvironmentHealthOutput) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (DescribeEnvironmentHealthOutput) String added in v0.7.4

String returns the string representation

type DescribeEnvironmentManagedActionHistoryInput added in v1.1.19

type DescribeEnvironmentManagedActionHistoryInput struct {

	// The environment ID of the target environment.
	EnvironmentId *string `type:"string"`

	// The name of the target environment.
	EnvironmentName *string `min:"4" type:"string"`

	// The maximum number of items to return for a single request.
	MaxItems *int64 `type:"integer"`

	// The pagination token returned by a previous request.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Request to list completed and failed managed actions.

func (DescribeEnvironmentManagedActionHistoryInput) GoString added in v1.1.19

GoString returns the string representation

func (*DescribeEnvironmentManagedActionHistoryInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*DescribeEnvironmentManagedActionHistoryInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*DescribeEnvironmentManagedActionHistoryInput) SetMaxItems added in v1.5.0

SetMaxItems sets the MaxItems field's value.

func (*DescribeEnvironmentManagedActionHistoryInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeEnvironmentManagedActionHistoryInput) String added in v1.1.19

String returns the string representation

func (*DescribeEnvironmentManagedActionHistoryInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeEnvironmentManagedActionHistoryOutput added in v1.1.19

type DescribeEnvironmentManagedActionHistoryOutput struct {

	// A list of completed and failed managed actions.
	ManagedActionHistoryItems []*ManagedActionHistoryItem `min:"1" type:"list"`

	// A pagination token that you pass to DescribeEnvironmentManagedActionHistory
	// to get the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

A result message containing a list of completed and failed managed actions.

func (DescribeEnvironmentManagedActionHistoryOutput) GoString added in v1.1.19

GoString returns the string representation

func (*DescribeEnvironmentManagedActionHistoryOutput) SetManagedActionHistoryItems added in v1.5.0

SetManagedActionHistoryItems sets the ManagedActionHistoryItems field's value.

func (*DescribeEnvironmentManagedActionHistoryOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeEnvironmentManagedActionHistoryOutput) String added in v1.1.19

String returns the string representation

type DescribeEnvironmentManagedActionsInput added in v1.1.19

type DescribeEnvironmentManagedActionsInput struct {

	// The environment ID of the target environment.
	EnvironmentId *string `type:"string"`

	// The name of the target environment.
	EnvironmentName *string `type:"string"`

	// To show only actions with a particular status, specify a status.
	Status *string `type:"string" enum:"ActionStatus"`
	// contains filtered or unexported fields
}

Request to list an environment's upcoming and in-progress managed actions.

func (DescribeEnvironmentManagedActionsInput) GoString added in v1.1.19

GoString returns the string representation

func (*DescribeEnvironmentManagedActionsInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*DescribeEnvironmentManagedActionsInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*DescribeEnvironmentManagedActionsInput) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (DescribeEnvironmentManagedActionsInput) String added in v1.1.19

String returns the string representation

type DescribeEnvironmentManagedActionsOutput added in v1.1.19

type DescribeEnvironmentManagedActionsOutput struct {

	// A list of upcoming and in-progress managed actions.
	ManagedActions []*ManagedAction `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The result message containing a list of managed actions.

func (DescribeEnvironmentManagedActionsOutput) GoString added in v1.1.19

GoString returns the string representation

func (*DescribeEnvironmentManagedActionsOutput) SetManagedActions added in v1.5.0

SetManagedActions sets the ManagedActions field's value.

func (DescribeEnvironmentManagedActionsOutput) String added in v1.1.19

String returns the string representation

type DescribeEnvironmentResourcesInput

type DescribeEnvironmentResourcesInput struct {

	// The ID of the environment to retrieve AWS resource usage data.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string `type:"string"`

	// The name of the environment to retrieve AWS resource usage data.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

Request to describe the resources in an environment.

func (DescribeEnvironmentResourcesInput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeEnvironmentResourcesInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*DescribeEnvironmentResourcesInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (DescribeEnvironmentResourcesInput) String added in v0.6.5

String returns the string representation

func (*DescribeEnvironmentResourcesInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeEnvironmentResourcesOutput

type DescribeEnvironmentResourcesOutput struct {

	// A list of EnvironmentResourceDescription.
	EnvironmentResources *EnvironmentResourceDescription `type:"structure"`
	// contains filtered or unexported fields
}

Result message containing a list of environment resource descriptions.

func (DescribeEnvironmentResourcesOutput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeEnvironmentResourcesOutput) SetEnvironmentResources added in v1.5.0

SetEnvironmentResources sets the EnvironmentResources field's value.

func (DescribeEnvironmentResourcesOutput) String added in v0.6.5

String returns the string representation

type DescribeEnvironmentsInput

type DescribeEnvironmentsInput struct {

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those that are associated with this application.
	ApplicationName *string `min:"1" type:"string"`

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those that have the specified IDs.
	EnvironmentIds []*string `type:"list"`

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those that have the specified names.
	EnvironmentNames []*string `type:"list"`

	// Indicates whether to include deleted environments:
	//
	// true: Environments that have been deleted after IncludedDeletedBackTo are
	// displayed.
	//
	// false: Do not include deleted environments.
	IncludeDeleted *bool `type:"boolean"`

	// If specified when IncludeDeleted is set to true, then environments deleted
	// after this date are displayed.
	IncludedDeletedBackTo *time.Time `type:"timestamp"`

	// For a paginated request. Specify a maximum number of environments to include
	// in each response.
	//
	// If no MaxRecords is specified, all available environments are retrieved in
	// a single response.
	MaxRecords *int64 `min:"1" type:"integer"`

	// For a paginated request. Specify a token from a previous response page to
	// retrieve the next response page. All other parameter values must be identical
	// to the ones specified in the initial request.
	//
	// If no NextToken is specified, the first page is retrieved.
	NextToken *string `type:"string"`

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those that are associated with this application version.
	VersionLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Request to describe one or more environments.

func (DescribeEnvironmentsInput) GoString added in v0.6.5

func (s DescribeEnvironmentsInput) GoString() string

GoString returns the string representation

func (*DescribeEnvironmentsInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*DescribeEnvironmentsInput) SetEnvironmentIds added in v1.5.0

func (s *DescribeEnvironmentsInput) SetEnvironmentIds(v []*string) *DescribeEnvironmentsInput

SetEnvironmentIds sets the EnvironmentIds field's value.

func (*DescribeEnvironmentsInput) SetEnvironmentNames added in v1.5.0

func (s *DescribeEnvironmentsInput) SetEnvironmentNames(v []*string) *DescribeEnvironmentsInput

SetEnvironmentNames sets the EnvironmentNames field's value.

func (*DescribeEnvironmentsInput) SetIncludeDeleted added in v1.5.0

func (s *DescribeEnvironmentsInput) SetIncludeDeleted(v bool) *DescribeEnvironmentsInput

SetIncludeDeleted sets the IncludeDeleted field's value.

func (*DescribeEnvironmentsInput) SetIncludedDeletedBackTo added in v1.5.0

func (s *DescribeEnvironmentsInput) SetIncludedDeletedBackTo(v time.Time) *DescribeEnvironmentsInput

SetIncludedDeletedBackTo sets the IncludedDeletedBackTo field's value.

func (*DescribeEnvironmentsInput) SetMaxRecords added in v1.10.21

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeEnvironmentsInput) SetNextToken added in v1.10.21

SetNextToken sets the NextToken field's value.

func (*DescribeEnvironmentsInput) SetVersionLabel added in v1.5.0

SetVersionLabel sets the VersionLabel field's value.

func (DescribeEnvironmentsInput) String added in v0.6.5

func (s DescribeEnvironmentsInput) String() string

String returns the string representation

func (*DescribeEnvironmentsInput) Validate added in v1.1.21

func (s *DescribeEnvironmentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventsInput

type DescribeEventsInput struct {

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// include only those associated with this application.
	ApplicationName *string `min:"1" type:"string"`

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those that occur up to, but not including, the EndTime.
	EndTime *time.Time `type:"timestamp"`

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those associated with this environment.
	EnvironmentId *string `type:"string"`

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those associated with this environment.
	EnvironmentName *string `min:"4" type:"string"`

	// Specifies the maximum number of events that can be returned, beginning with
	// the most recent event.
	MaxRecords *int64 `min:"1" type:"integer"`

	// Pagination token. If specified, the events return the next batch of results.
	NextToken *string `type:"string"`

	// The ARN of the version of the custom platform.
	PlatformArn *string `type:"string"`

	// If specified, AWS Elastic Beanstalk restricts the described events to include
	// only those associated with this request ID.
	RequestId *string `type:"string"`

	// If specified, limits the events returned from this call to include only those
	// with the specified severity or higher.
	Severity *string `type:"string" enum:"EventSeverity"`

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those that occur on or after this time.
	StartTime *time.Time `type:"timestamp"`

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those that are associated with this environment configuration.
	TemplateName *string `min:"1" type:"string"`

	// If specified, AWS Elastic Beanstalk restricts the returned descriptions to
	// those associated with this application version.
	VersionLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Request to retrieve a list of events for an environment.

func (DescribeEventsInput) GoString added in v0.6.5

func (s DescribeEventsInput) GoString() string

GoString returns the string representation

func (*DescribeEventsInput) SetApplicationName added in v1.5.0

func (s *DescribeEventsInput) SetApplicationName(v string) *DescribeEventsInput

SetApplicationName sets the ApplicationName field's value.

func (*DescribeEventsInput) SetEndTime added in v1.5.0

SetEndTime sets the EndTime field's value.

func (*DescribeEventsInput) SetEnvironmentId added in v1.5.0

func (s *DescribeEventsInput) SetEnvironmentId(v string) *DescribeEventsInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*DescribeEventsInput) SetEnvironmentName added in v1.5.0

func (s *DescribeEventsInput) SetEnvironmentName(v string) *DescribeEventsInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*DescribeEventsInput) SetMaxRecords added in v1.5.0

func (s *DescribeEventsInput) SetMaxRecords(v int64) *DescribeEventsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeEventsInput) SetNextToken added in v1.5.0

func (s *DescribeEventsInput) SetNextToken(v string) *DescribeEventsInput

SetNextToken sets the NextToken field's value.

func (*DescribeEventsInput) SetPlatformArn added in v1.6.27

func (s *DescribeEventsInput) SetPlatformArn(v string) *DescribeEventsInput

SetPlatformArn sets the PlatformArn field's value.

func (*DescribeEventsInput) SetRequestId added in v1.5.0

func (s *DescribeEventsInput) SetRequestId(v string) *DescribeEventsInput

SetRequestId sets the RequestId field's value.

func (*DescribeEventsInput) SetSeverity added in v1.5.0

func (s *DescribeEventsInput) SetSeverity(v string) *DescribeEventsInput

SetSeverity sets the Severity field's value.

func (*DescribeEventsInput) SetStartTime added in v1.5.0

func (s *DescribeEventsInput) SetStartTime(v time.Time) *DescribeEventsInput

SetStartTime sets the StartTime field's value.

func (*DescribeEventsInput) SetTemplateName added in v1.5.0

func (s *DescribeEventsInput) SetTemplateName(v string) *DescribeEventsInput

SetTemplateName sets the TemplateName field's value.

func (*DescribeEventsInput) SetVersionLabel added in v1.5.0

func (s *DescribeEventsInput) SetVersionLabel(v string) *DescribeEventsInput

SetVersionLabel sets the VersionLabel field's value.

func (DescribeEventsInput) String added in v0.6.5

func (s DescribeEventsInput) String() string

String returns the string representation

func (*DescribeEventsInput) Validate added in v1.1.21

func (s *DescribeEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventsOutput

type DescribeEventsOutput struct {

	// A list of EventDescription.
	Events []*EventDescription `type:"list"`

	// If returned, this indicates that there are more results to obtain. Use this
	// token in the next DescribeEvents call to get the next batch of events.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Result message wrapping a list of event descriptions.

func (DescribeEventsOutput) GoString added in v0.6.5

func (s DescribeEventsOutput) GoString() string

GoString returns the string representation

func (*DescribeEventsOutput) SetEvents added in v1.5.0

SetEvents sets the Events field's value.

func (*DescribeEventsOutput) SetNextToken added in v1.5.0

func (s *DescribeEventsOutput) SetNextToken(v string) *DescribeEventsOutput

SetNextToken sets the NextToken field's value.

func (DescribeEventsOutput) String added in v0.6.5

func (s DescribeEventsOutput) String() string

String returns the string representation

type DescribeInstancesHealthInput added in v0.7.4

type DescribeInstancesHealthInput struct {

	// Specifies the response elements you wish to receive. To retrieve all attributes,
	// set to All. If no attribute names are specified, returns a list of instances.
	AttributeNames []*string `type:"list"`

	// Specify the AWS Elastic Beanstalk environment by ID.
	EnvironmentId *string `type:"string"`

	// Specify the AWS Elastic Beanstalk environment by name.
	EnvironmentName *string `min:"4" type:"string"`

	// Specify the pagination token returned by a previous call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Parameters for a call to DescribeInstancesHealth.

func (DescribeInstancesHealthInput) GoString added in v0.7.4

func (s DescribeInstancesHealthInput) GoString() string

GoString returns the string representation

func (*DescribeInstancesHealthInput) SetAttributeNames added in v1.5.0

SetAttributeNames sets the AttributeNames field's value.

func (*DescribeInstancesHealthInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*DescribeInstancesHealthInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*DescribeInstancesHealthInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeInstancesHealthInput) String added in v0.7.4

String returns the string representation

func (*DescribeInstancesHealthInput) Validate added in v1.1.21

func (s *DescribeInstancesHealthInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeInstancesHealthOutput added in v0.7.4

type DescribeInstancesHealthOutput struct {

	// Detailed health information about each instance.
	//
	// The output differs slightly between Linux and Windows environments. There
	// is a difference in the members that are supported under the <CPUUtilization>
	// type.
	InstanceHealthList []*SingleInstanceHealth `type:"list"`

	// Pagination token for the next page of results, if available.
	NextToken *string `min:"1" type:"string"`

	// The date and time that the health information was retrieved.
	RefreshedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

func (DescribeInstancesHealthOutput) GoString added in v0.7.4

GoString returns the string representation

func (*DescribeInstancesHealthOutput) SetInstanceHealthList added in v1.5.0

SetInstanceHealthList sets the InstanceHealthList field's value.

func (*DescribeInstancesHealthOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeInstancesHealthOutput) SetRefreshedAt added in v1.5.0

SetRefreshedAt sets the RefreshedAt field's value.

func (DescribeInstancesHealthOutput) String added in v0.7.4

String returns the string representation

type DescribePlatformVersionInput added in v1.6.27

type DescribePlatformVersionInput struct {

	// The ARN of the version of the platform.
	PlatformArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribePlatformVersionInput) GoString added in v1.6.27

func (s DescribePlatformVersionInput) GoString() string

GoString returns the string representation

func (*DescribePlatformVersionInput) SetPlatformArn added in v1.6.27

SetPlatformArn sets the PlatformArn field's value.

func (DescribePlatformVersionInput) String added in v1.6.27

String returns the string representation

type DescribePlatformVersionOutput added in v1.6.27

type DescribePlatformVersionOutput struct {

	// Detailed information about the version of the platform.
	PlatformDescription *PlatformDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribePlatformVersionOutput) GoString added in v1.6.27

GoString returns the string representation

func (*DescribePlatformVersionOutput) SetPlatformDescription added in v1.6.27

SetPlatformDescription sets the PlatformDescription field's value.

func (DescribePlatformVersionOutput) String added in v1.6.27

String returns the string representation

type ElasticBeanstalk

type ElasticBeanstalk struct {
	*client.Client
}

ElasticBeanstalk provides the API operation methods for making requests to AWS Elastic Beanstalk. See this package's package overview docs for details on the service.

ElasticBeanstalk methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the ElasticBeanstalk client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a ElasticBeanstalk client from just a session.
svc := elasticbeanstalk.New(mySession)

// Create a ElasticBeanstalk client with additional configuration
svc := elasticbeanstalk.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ElasticBeanstalk) AbortEnvironmentUpdate

AbortEnvironmentUpdate API operation for AWS Elastic Beanstalk.

Cancels in-progress environment configuration update or application version deployment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation AbortEnvironmentUpdate for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate

Example (Shared00)

To abort a deployment

The following code aborts a running application version deployment for an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.AbortEnvironmentUpdateInput{
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.AbortEnvironmentUpdate(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) AbortEnvironmentUpdateRequest

func (c *ElasticBeanstalk) AbortEnvironmentUpdateRequest(input *AbortEnvironmentUpdateInput) (req *request.Request, output *AbortEnvironmentUpdateOutput)

AbortEnvironmentUpdateRequest generates a "aws/request.Request" representing the client's request for the AbortEnvironmentUpdate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AbortEnvironmentUpdate for more information on using the AbortEnvironmentUpdate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AbortEnvironmentUpdateRequest method.
req, resp := client.AbortEnvironmentUpdateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/AbortEnvironmentUpdate

func (*ElasticBeanstalk) AbortEnvironmentUpdateWithContext added in v1.8.0

func (c *ElasticBeanstalk) AbortEnvironmentUpdateWithContext(ctx aws.Context, input *AbortEnvironmentUpdateInput, opts ...request.Option) (*AbortEnvironmentUpdateOutput, error)

AbortEnvironmentUpdateWithContext is the same as AbortEnvironmentUpdate with the addition of the ability to pass a context and additional request options.

See AbortEnvironmentUpdate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) ApplyEnvironmentManagedAction added in v1.1.19

ApplyEnvironmentManagedAction API operation for AWS Elastic Beanstalk.

Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation ApplyEnvironmentManagedAction for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ElasticBeanstalkServiceException" A generic service exception has occurred.

  • ErrCodeManagedActionInvalidStateException "ManagedActionInvalidStateException" Cannot modify the managed action in its current state.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction

func (*ElasticBeanstalk) ApplyEnvironmentManagedActionRequest added in v1.1.19

func (c *ElasticBeanstalk) ApplyEnvironmentManagedActionRequest(input *ApplyEnvironmentManagedActionInput) (req *request.Request, output *ApplyEnvironmentManagedActionOutput)

ApplyEnvironmentManagedActionRequest generates a "aws/request.Request" representing the client's request for the ApplyEnvironmentManagedAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ApplyEnvironmentManagedAction for more information on using the ApplyEnvironmentManagedAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ApplyEnvironmentManagedActionRequest method.
req, resp := client.ApplyEnvironmentManagedActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ApplyEnvironmentManagedAction

func (*ElasticBeanstalk) ApplyEnvironmentManagedActionWithContext added in v1.8.0

func (c *ElasticBeanstalk) ApplyEnvironmentManagedActionWithContext(ctx aws.Context, input *ApplyEnvironmentManagedActionInput, opts ...request.Option) (*ApplyEnvironmentManagedActionOutput, error)

ApplyEnvironmentManagedActionWithContext is the same as ApplyEnvironmentManagedAction with the addition of the ability to pass a context and additional request options.

See ApplyEnvironmentManagedAction for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) CheckDNSAvailability

func (c *ElasticBeanstalk) CheckDNSAvailability(input *CheckDNSAvailabilityInput) (*CheckDNSAvailabilityOutput, error)

CheckDNSAvailability API operation for AWS Elastic Beanstalk.

Checks if the specified CNAME is available.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation CheckDNSAvailability for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CheckDNSAvailability

Example (Shared00)

To check the availability of a CNAME

The following operation checks the availability of the subdomain my-cname:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.CheckDNSAvailabilityInput{
		CNAMEPrefix: aws.String("my-cname"),
	}

	result, err := svc.CheckDNSAvailability(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) CheckDNSAvailabilityRequest

func (c *ElasticBeanstalk) CheckDNSAvailabilityRequest(input *CheckDNSAvailabilityInput) (req *request.Request, output *CheckDNSAvailabilityOutput)

CheckDNSAvailabilityRequest generates a "aws/request.Request" representing the client's request for the CheckDNSAvailability operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CheckDNSAvailability for more information on using the CheckDNSAvailability API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CheckDNSAvailabilityRequest method.
req, resp := client.CheckDNSAvailabilityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CheckDNSAvailability

func (*ElasticBeanstalk) CheckDNSAvailabilityWithContext added in v1.8.0

func (c *ElasticBeanstalk) CheckDNSAvailabilityWithContext(ctx aws.Context, input *CheckDNSAvailabilityInput, opts ...request.Option) (*CheckDNSAvailabilityOutput, error)

CheckDNSAvailabilityWithContext is the same as CheckDNSAvailability with the addition of the ability to pass a context and additional request options.

See CheckDNSAvailability for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) ComposeEnvironments added in v1.0.1

ComposeEnvironments API operation for AWS Elastic Beanstalk.

Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation ComposeEnvironments for usage and error information.

Returned Error Codes:

  • ErrCodeTooManyEnvironmentsException "TooManyEnvironmentsException" The specified account has reached its limit of environments.

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ComposeEnvironments

func (*ElasticBeanstalk) ComposeEnvironmentsRequest added in v1.0.1

func (c *ElasticBeanstalk) ComposeEnvironmentsRequest(input *ComposeEnvironmentsInput) (req *request.Request, output *EnvironmentDescriptionsMessage)

ComposeEnvironmentsRequest generates a "aws/request.Request" representing the client's request for the ComposeEnvironments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ComposeEnvironments for more information on using the ComposeEnvironments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ComposeEnvironmentsRequest method.
req, resp := client.ComposeEnvironmentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ComposeEnvironments

func (*ElasticBeanstalk) ComposeEnvironmentsWithContext added in v1.8.0

func (c *ElasticBeanstalk) ComposeEnvironmentsWithContext(ctx aws.Context, input *ComposeEnvironmentsInput, opts ...request.Option) (*EnvironmentDescriptionsMessage, error)

ComposeEnvironmentsWithContext is the same as ComposeEnvironments with the addition of the ability to pass a context and additional request options.

See ComposeEnvironments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) CreateApplication

CreateApplication API operation for AWS Elastic Beanstalk.

Creates an application that has one configuration template named default and no application versions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation CreateApplication for usage and error information.

Returned Error Codes:

  • ErrCodeTooManyApplicationsException "TooManyApplicationsException" The specified account has reached its limit of applications.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateApplication

Example (Shared00)

To create a new application

The following operation creates a new application named my-app:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.CreateApplicationInput{
		ApplicationName: aws.String("my-app"),
		Description:     aws.String("my application"),
	}

	result, err := svc.CreateApplication(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeTooManyApplicationsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyApplicationsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) CreateApplicationRequest

func (c *ElasticBeanstalk) CreateApplicationRequest(input *CreateApplicationInput) (req *request.Request, output *ApplicationDescriptionMessage)

CreateApplicationRequest generates a "aws/request.Request" representing the client's request for the CreateApplication operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateApplication for more information on using the CreateApplication API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateApplicationRequest method.
req, resp := client.CreateApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateApplication

func (*ElasticBeanstalk) CreateApplicationVersion

CreateApplicationVersion API operation for AWS Elastic Beanstalk.

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.

Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.

Specify a source bundle in S3 with SourceBundle

Omit both SourceBuildInformation and SourceBundle to use the default sample application.

Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation CreateApplicationVersion for usage and error information.

Returned Error Codes:

  • ErrCodeTooManyApplicationsException "TooManyApplicationsException" The specified account has reached its limit of applications.

  • ErrCodeTooManyApplicationVersionsException "TooManyApplicationVersionsException" The specified account has reached its limit of application versions.

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeS3LocationNotInServiceRegionException "S3LocationNotInServiceRegionException" The specified S3 bucket does not belong to the S3 region in which the service is running. The following regions are supported:

  • IAD/us-east-1

  • PDX/us-west-2

  • DUB/eu-west-1

  • ErrCodeCodeBuildNotInServiceRegionException "CodeBuildNotInServiceRegionException" AWS CodeBuild is not available in the specified region.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateApplicationVersion

Example (Shared00)

To create a new application

The following operation creates a new version (v1) of an application named my-app:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.CreateApplicationVersionInput{
		ApplicationName:       aws.String("my-app"),
		AutoCreateApplication: aws.Bool(true),
		Description:           aws.String("my-app-v1"),
		Process:               aws.Bool(true),
		SourceBundle: &elasticbeanstalk.S3Location{
			S3Bucket: aws.String("my-bucket"),
			S3Key:    aws.String("sample.war"),
		},
		VersionLabel: aws.String("v1"),
	}

	result, err := svc.CreateApplicationVersion(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeTooManyApplicationsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyApplicationsException, aerr.Error())
			case elasticbeanstalk.ErrCodeTooManyApplicationVersionsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyApplicationVersionsException, aerr.Error())
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			case elasticbeanstalk.ErrCodeS3LocationNotInServiceRegionException:
				fmt.Println(elasticbeanstalk.ErrCodeS3LocationNotInServiceRegionException, aerr.Error())
			case elasticbeanstalk.ErrCodeCodeBuildNotInServiceRegionException:
				fmt.Println(elasticbeanstalk.ErrCodeCodeBuildNotInServiceRegionException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) CreateApplicationVersionRequest

func (c *ElasticBeanstalk) CreateApplicationVersionRequest(input *CreateApplicationVersionInput) (req *request.Request, output *ApplicationVersionDescriptionMessage)

CreateApplicationVersionRequest generates a "aws/request.Request" representing the client's request for the CreateApplicationVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateApplicationVersion for more information on using the CreateApplicationVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateApplicationVersionRequest method.
req, resp := client.CreateApplicationVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateApplicationVersion

func (*ElasticBeanstalk) CreateApplicationVersionWithContext added in v1.8.0

func (c *ElasticBeanstalk) CreateApplicationVersionWithContext(ctx aws.Context, input *CreateApplicationVersionInput, opts ...request.Option) (*ApplicationVersionDescriptionMessage, error)

CreateApplicationVersionWithContext is the same as CreateApplicationVersion with the addition of the ability to pass a context and additional request options.

See CreateApplicationVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) CreateApplicationWithContext added in v1.8.0

func (c *ElasticBeanstalk) CreateApplicationWithContext(ctx aws.Context, input *CreateApplicationInput, opts ...request.Option) (*ApplicationDescriptionMessage, error)

CreateApplicationWithContext is the same as CreateApplication with the addition of the ability to pass a context and additional request options.

See CreateApplication for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) CreateConfigurationTemplate

CreateConfigurationTemplate API operation for AWS Elastic Beanstalk.

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Templates aren't associated with any environment. The EnvironmentName response element is always null.

Related Topics

  • DescribeConfigurationOptions

  • DescribeConfigurationSettings

  • ListAvailableSolutionStacks

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation CreateConfigurationTemplate for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeTooManyBucketsException "TooManyBucketsException" The specified account has reached its limit of Amazon S3 buckets.

  • ErrCodeTooManyConfigurationTemplatesException "TooManyConfigurationTemplatesException" The specified account has reached its limit of configuration templates.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate

Example (Shared00)

To create a configuration template

The following operation creates a configuration template named my-app-v1 from the settings applied to an environment with the id e-rpqsewtp2j:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.CreateConfigurationTemplateInput{
		ApplicationName: aws.String("my-app"),
		EnvironmentId:   aws.String("e-rpqsewtp2j"),
		TemplateName:    aws.String("my-app-v1"),
	}

	result, err := svc.CreateConfigurationTemplate(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			case elasticbeanstalk.ErrCodeTooManyBucketsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyBucketsException, aerr.Error())
			case elasticbeanstalk.ErrCodeTooManyConfigurationTemplatesException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyConfigurationTemplatesException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) CreateConfigurationTemplateRequest

func (c *ElasticBeanstalk) CreateConfigurationTemplateRequest(input *CreateConfigurationTemplateInput) (req *request.Request, output *ConfigurationSettingsDescription)

CreateConfigurationTemplateRequest generates a "aws/request.Request" representing the client's request for the CreateConfigurationTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConfigurationTemplate for more information on using the CreateConfigurationTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateConfigurationTemplateRequest method.
req, resp := client.CreateConfigurationTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateConfigurationTemplate

func (*ElasticBeanstalk) CreateConfigurationTemplateWithContext added in v1.8.0

func (c *ElasticBeanstalk) CreateConfigurationTemplateWithContext(ctx aws.Context, input *CreateConfigurationTemplateInput, opts ...request.Option) (*ConfigurationSettingsDescription, error)

CreateConfigurationTemplateWithContext is the same as CreateConfigurationTemplate with the addition of the ability to pass a context and additional request options.

See CreateConfigurationTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) CreateEnvironment

func (c *ElasticBeanstalk) CreateEnvironment(input *CreateEnvironmentInput) (*EnvironmentDescription, error)

CreateEnvironment API operation for AWS Elastic Beanstalk.

Launches an environment for the specified application using the specified configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation CreateEnvironment for usage and error information.

Returned Error Codes:

  • ErrCodeTooManyEnvironmentsException "TooManyEnvironmentsException" The specified account has reached its limit of environments.

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateEnvironment

Example (Shared00)

To create a new environment for an application

The following operation creates a new environment for version v1 of a java application named my-app:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.CreateEnvironmentInput{
		ApplicationName:   aws.String("my-app"),
		CNAMEPrefix:       aws.String("my-app"),
		EnvironmentName:   aws.String("my-env"),
		SolutionStackName: aws.String("64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8"),
		VersionLabel:      aws.String("v1"),
	}

	result, err := svc.CreateEnvironment(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeTooManyEnvironmentsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyEnvironmentsException, aerr.Error())
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) CreateEnvironmentRequest

func (c *ElasticBeanstalk) CreateEnvironmentRequest(input *CreateEnvironmentInput) (req *request.Request, output *EnvironmentDescription)

CreateEnvironmentRequest generates a "aws/request.Request" representing the client's request for the CreateEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEnvironment for more information on using the CreateEnvironment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateEnvironmentRequest method.
req, resp := client.CreateEnvironmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateEnvironment

func (*ElasticBeanstalk) CreateEnvironmentWithContext added in v1.8.0

func (c *ElasticBeanstalk) CreateEnvironmentWithContext(ctx aws.Context, input *CreateEnvironmentInput, opts ...request.Option) (*EnvironmentDescription, error)

CreateEnvironmentWithContext is the same as CreateEnvironment with the addition of the ability to pass a context and additional request options.

See CreateEnvironment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) CreatePlatformVersion added in v1.6.27

CreatePlatformVersion API operation for AWS Elastic Beanstalk.

Create a new version of your custom platform.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation CreatePlatformVersion for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeServiceException "ElasticBeanstalkServiceException" A generic service exception has occurred.

  • ErrCodeTooManyPlatformsException "TooManyPlatformsException" You have exceeded the maximum number of allowed platforms associated with the account.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreatePlatformVersion

func (*ElasticBeanstalk) CreatePlatformVersionRequest added in v1.6.27

func (c *ElasticBeanstalk) CreatePlatformVersionRequest(input *CreatePlatformVersionInput) (req *request.Request, output *CreatePlatformVersionOutput)

CreatePlatformVersionRequest generates a "aws/request.Request" representing the client's request for the CreatePlatformVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePlatformVersion for more information on using the CreatePlatformVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreatePlatformVersionRequest method.
req, resp := client.CreatePlatformVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreatePlatformVersion

func (*ElasticBeanstalk) CreatePlatformVersionWithContext added in v1.8.0

func (c *ElasticBeanstalk) CreatePlatformVersionWithContext(ctx aws.Context, input *CreatePlatformVersionInput, opts ...request.Option) (*CreatePlatformVersionOutput, error)

CreatePlatformVersionWithContext is the same as CreatePlatformVersion with the addition of the ability to pass a context and additional request options.

See CreatePlatformVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) CreateStorageLocation

CreateStorageLocation API operation for AWS Elastic Beanstalk.

Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation CreateStorageLocation for usage and error information.

Returned Error Codes:

  • ErrCodeTooManyBucketsException "TooManyBucketsException" The specified account has reached its limit of Amazon S3 buckets.

  • ErrCodeS3SubscriptionRequiredException "S3SubscriptionRequiredException" The specified account does not have a subscription to Amazon S3.

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateStorageLocation

Example (Shared00)

To create a new environment for an application

The following operation creates a new environment for version v1 of a java application named my-app:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.CreateStorageLocationInput{}

	result, err := svc.CreateStorageLocation(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeTooManyBucketsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyBucketsException, aerr.Error())
			case elasticbeanstalk.ErrCodeS3SubscriptionRequiredException:
				fmt.Println(elasticbeanstalk.ErrCodeS3SubscriptionRequiredException, aerr.Error())
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) CreateStorageLocationRequest

func (c *ElasticBeanstalk) CreateStorageLocationRequest(input *CreateStorageLocationInput) (req *request.Request, output *CreateStorageLocationOutput)

CreateStorageLocationRequest generates a "aws/request.Request" representing the client's request for the CreateStorageLocation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStorageLocation for more information on using the CreateStorageLocation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateStorageLocationRequest method.
req, resp := client.CreateStorageLocationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateStorageLocation

func (*ElasticBeanstalk) CreateStorageLocationWithContext added in v1.8.0

func (c *ElasticBeanstalk) CreateStorageLocationWithContext(ctx aws.Context, input *CreateStorageLocationInput, opts ...request.Option) (*CreateStorageLocationOutput, error)

CreateStorageLocationWithContext is the same as CreateStorageLocation with the addition of the ability to pass a context and additional request options.

See CreateStorageLocation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DeleteApplication

func (c *ElasticBeanstalk) DeleteApplication(input *DeleteApplicationInput) (*DeleteApplicationOutput, error)

DeleteApplication API operation for AWS Elastic Beanstalk.

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

You cannot delete an application that has a running environment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DeleteApplication for usage and error information.

Returned Error Codes:

  • ErrCodeOperationInProgressException "OperationInProgressFailure" Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeleteApplication

Example (Shared00)

To delete an application

The following operation deletes an application named my-app:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DeleteApplicationInput{
		ApplicationName: aws.String("my-app"),
	}

	result, err := svc.DeleteApplication(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeOperationInProgressException:
				fmt.Println(elasticbeanstalk.ErrCodeOperationInProgressException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DeleteApplicationRequest

func (c *ElasticBeanstalk) DeleteApplicationRequest(input *DeleteApplicationInput) (req *request.Request, output *DeleteApplicationOutput)

DeleteApplicationRequest generates a "aws/request.Request" representing the client's request for the DeleteApplication operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteApplication for more information on using the DeleteApplication API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteApplicationRequest method.
req, resp := client.DeleteApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeleteApplication

func (*ElasticBeanstalk) DeleteApplicationVersion

DeleteApplicationVersion API operation for AWS Elastic Beanstalk.

Deletes the specified version from the specified application.

You cannot delete an application version that is associated with a running environment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DeleteApplicationVersion for usage and error information.

Returned Error Codes:

  • ErrCodeSourceBundleDeletionException "SourceBundleDeletionFailure" Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully.

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeOperationInProgressException "OperationInProgressFailure" Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

  • ErrCodeS3LocationNotInServiceRegionException "S3LocationNotInServiceRegionException" The specified S3 bucket does not belong to the S3 region in which the service is running. The following regions are supported:

  • IAD/us-east-1

  • PDX/us-west-2

  • DUB/eu-west-1

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeleteApplicationVersion

Example (Shared00)

To delete an application version

The following operation deletes an application version named 22a0-stage-150819_182129 for an application named my-app:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DeleteApplicationVersionInput{
		ApplicationName:    aws.String("my-app"),
		DeleteSourceBundle: aws.Bool(true),
		VersionLabel:       aws.String("22a0-stage-150819_182129"),
	}

	result, err := svc.DeleteApplicationVersion(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeSourceBundleDeletionException:
				fmt.Println(elasticbeanstalk.ErrCodeSourceBundleDeletionException, aerr.Error())
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			case elasticbeanstalk.ErrCodeOperationInProgressException:
				fmt.Println(elasticbeanstalk.ErrCodeOperationInProgressException, aerr.Error())
			case elasticbeanstalk.ErrCodeS3LocationNotInServiceRegionException:
				fmt.Println(elasticbeanstalk.ErrCodeS3LocationNotInServiceRegionException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DeleteApplicationVersionRequest

func (c *ElasticBeanstalk) DeleteApplicationVersionRequest(input *DeleteApplicationVersionInput) (req *request.Request, output *DeleteApplicationVersionOutput)

DeleteApplicationVersionRequest generates a "aws/request.Request" representing the client's request for the DeleteApplicationVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteApplicationVersion for more information on using the DeleteApplicationVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteApplicationVersionRequest method.
req, resp := client.DeleteApplicationVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeleteApplicationVersion

func (*ElasticBeanstalk) DeleteApplicationVersionWithContext added in v1.8.0

func (c *ElasticBeanstalk) DeleteApplicationVersionWithContext(ctx aws.Context, input *DeleteApplicationVersionInput, opts ...request.Option) (*DeleteApplicationVersionOutput, error)

DeleteApplicationVersionWithContext is the same as DeleteApplicationVersion with the addition of the ability to pass a context and additional request options.

See DeleteApplicationVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DeleteApplicationWithContext added in v1.8.0

func (c *ElasticBeanstalk) DeleteApplicationWithContext(ctx aws.Context, input *DeleteApplicationInput, opts ...request.Option) (*DeleteApplicationOutput, error)

DeleteApplicationWithContext is the same as DeleteApplication with the addition of the ability to pass a context and additional request options.

See DeleteApplication for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DeleteConfigurationTemplate

DeleteConfigurationTemplate API operation for AWS Elastic Beanstalk.

Deletes the specified configuration template.

When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DeleteConfigurationTemplate for usage and error information.

Returned Error Codes:

  • ErrCodeOperationInProgressException "OperationInProgressFailure" Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate

Example (Shared00)

To delete a configuration template

The following operation deletes a configuration template named my-template for an application named my-app:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DeleteConfigurationTemplateInput{
		ApplicationName: aws.String("my-app"),
		TemplateName:    aws.String("my-template"),
	}

	result, err := svc.DeleteConfigurationTemplate(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeOperationInProgressException:
				fmt.Println(elasticbeanstalk.ErrCodeOperationInProgressException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DeleteConfigurationTemplateRequest

func (c *ElasticBeanstalk) DeleteConfigurationTemplateRequest(input *DeleteConfigurationTemplateInput) (req *request.Request, output *DeleteConfigurationTemplateOutput)

DeleteConfigurationTemplateRequest generates a "aws/request.Request" representing the client's request for the DeleteConfigurationTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConfigurationTemplate for more information on using the DeleteConfigurationTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteConfigurationTemplateRequest method.
req, resp := client.DeleteConfigurationTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeleteConfigurationTemplate

func (*ElasticBeanstalk) DeleteConfigurationTemplateWithContext added in v1.8.0

func (c *ElasticBeanstalk) DeleteConfigurationTemplateWithContext(ctx aws.Context, input *DeleteConfigurationTemplateInput, opts ...request.Option) (*DeleteConfigurationTemplateOutput, error)

DeleteConfigurationTemplateWithContext is the same as DeleteConfigurationTemplate with the addition of the ability to pass a context and additional request options.

See DeleteConfigurationTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DeleteEnvironmentConfiguration

DeleteEnvironmentConfiguration API operation for AWS Elastic Beanstalk.

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DeleteEnvironmentConfiguration for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration

Example (Shared00)

To delete a draft configuration

The following operation deletes a draft configuration for an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DeleteEnvironmentConfigurationInput{
		ApplicationName: aws.String("my-app"),
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.DeleteEnvironmentConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DeleteEnvironmentConfigurationRequest

func (c *ElasticBeanstalk) DeleteEnvironmentConfigurationRequest(input *DeleteEnvironmentConfigurationInput) (req *request.Request, output *DeleteEnvironmentConfigurationOutput)

DeleteEnvironmentConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteEnvironmentConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEnvironmentConfiguration for more information on using the DeleteEnvironmentConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteEnvironmentConfigurationRequest method.
req, resp := client.DeleteEnvironmentConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeleteEnvironmentConfiguration

func (*ElasticBeanstalk) DeleteEnvironmentConfigurationWithContext added in v1.8.0

func (c *ElasticBeanstalk) DeleteEnvironmentConfigurationWithContext(ctx aws.Context, input *DeleteEnvironmentConfigurationInput, opts ...request.Option) (*DeleteEnvironmentConfigurationOutput, error)

DeleteEnvironmentConfigurationWithContext is the same as DeleteEnvironmentConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteEnvironmentConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DeletePlatformVersion added in v1.6.27

DeletePlatformVersion API operation for AWS Elastic Beanstalk.

Deletes the specified version of a custom platform.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DeletePlatformVersion for usage and error information.

Returned Error Codes:

  • ErrCodeOperationInProgressException "OperationInProgressFailure" Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeServiceException "ElasticBeanstalkServiceException" A generic service exception has occurred.

  • ErrCodePlatformVersionStillReferencedException "PlatformVersionStillReferencedException" You cannot delete the platform version because there are still environments running on it.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeletePlatformVersion

func (*ElasticBeanstalk) DeletePlatformVersionRequest added in v1.6.27

func (c *ElasticBeanstalk) DeletePlatformVersionRequest(input *DeletePlatformVersionInput) (req *request.Request, output *DeletePlatformVersionOutput)

DeletePlatformVersionRequest generates a "aws/request.Request" representing the client's request for the DeletePlatformVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePlatformVersion for more information on using the DeletePlatformVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeletePlatformVersionRequest method.
req, resp := client.DeletePlatformVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeletePlatformVersion

func (*ElasticBeanstalk) DeletePlatformVersionWithContext added in v1.8.0

func (c *ElasticBeanstalk) DeletePlatformVersionWithContext(ctx aws.Context, input *DeletePlatformVersionInput, opts ...request.Option) (*DeletePlatformVersionOutput, error)

DeletePlatformVersionWithContext is the same as DeletePlatformVersion with the addition of the ability to pass a context and additional request options.

See DeletePlatformVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeAccountAttributes added in v1.13.16

DescribeAccountAttributes API operation for AWS Elastic Beanstalk.

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

The result currently has one set of attributes—resource quotas.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeAccountAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeAccountAttributes

func (*ElasticBeanstalk) DescribeAccountAttributesRequest added in v1.13.16

func (c *ElasticBeanstalk) DescribeAccountAttributesRequest(input *DescribeAccountAttributesInput) (req *request.Request, output *DescribeAccountAttributesOutput)

DescribeAccountAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountAttributes for more information on using the DescribeAccountAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAccountAttributesRequest method.
req, resp := client.DescribeAccountAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeAccountAttributes

func (*ElasticBeanstalk) DescribeAccountAttributesWithContext added in v1.13.16

func (c *ElasticBeanstalk) DescribeAccountAttributesWithContext(ctx aws.Context, input *DescribeAccountAttributesInput, opts ...request.Option) (*DescribeAccountAttributesOutput, error)

DescribeAccountAttributesWithContext is the same as DescribeAccountAttributes with the addition of the ability to pass a context and additional request options.

See DescribeAccountAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeApplicationVersions

DescribeApplicationVersions API operation for AWS Elastic Beanstalk.

Retrieve a list of application versions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeApplicationVersions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeApplicationVersions

Example (Shared00)

To view information about an application version

The following operation retrieves information about an application version labeled v2:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DescribeApplicationVersionsInput{
		ApplicationName: aws.String("my-app"),
		VersionLabels: []*string{
			aws.String("v2"),
		},
	}

	result, err := svc.DescribeApplicationVersions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DescribeApplicationVersionsRequest

func (c *ElasticBeanstalk) DescribeApplicationVersionsRequest(input *DescribeApplicationVersionsInput) (req *request.Request, output *DescribeApplicationVersionsOutput)

DescribeApplicationVersionsRequest generates a "aws/request.Request" representing the client's request for the DescribeApplicationVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeApplicationVersions for more information on using the DescribeApplicationVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeApplicationVersionsRequest method.
req, resp := client.DescribeApplicationVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeApplicationVersions

func (*ElasticBeanstalk) DescribeApplicationVersionsWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeApplicationVersionsWithContext(ctx aws.Context, input *DescribeApplicationVersionsInput, opts ...request.Option) (*DescribeApplicationVersionsOutput, error)

DescribeApplicationVersionsWithContext is the same as DescribeApplicationVersions with the addition of the ability to pass a context and additional request options.

See DescribeApplicationVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeApplications

func (c *ElasticBeanstalk) DescribeApplications(input *DescribeApplicationsInput) (*DescribeApplicationsOutput, error)

DescribeApplications API operation for AWS Elastic Beanstalk.

Returns the descriptions of existing applications.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeApplications for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeApplications

Example (Shared00)

To view a list of applications

The following operation retrieves information about applications in the current region:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DescribeApplicationsInput{}

	result, err := svc.DescribeApplications(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DescribeApplicationsRequest

func (c *ElasticBeanstalk) DescribeApplicationsRequest(input *DescribeApplicationsInput) (req *request.Request, output *DescribeApplicationsOutput)

DescribeApplicationsRequest generates a "aws/request.Request" representing the client's request for the DescribeApplications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeApplications for more information on using the DescribeApplications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeApplicationsRequest method.
req, resp := client.DescribeApplicationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeApplications

func (*ElasticBeanstalk) DescribeApplicationsWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeApplicationsWithContext(ctx aws.Context, input *DescribeApplicationsInput, opts ...request.Option) (*DescribeApplicationsOutput, error)

DescribeApplicationsWithContext is the same as DescribeApplications with the addition of the ability to pass a context and additional request options.

See DescribeApplications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeConfigurationOptions

DescribeConfigurationOptions API operation for AWS Elastic Beanstalk.

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeConfigurationOptions for usage and error information.

Returned Error Codes:

  • ErrCodeTooManyBucketsException "TooManyBucketsException" The specified account has reached its limit of Amazon S3 buckets.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions

Example (Shared00)

To view configuration options for an environment

The following operation retrieves descriptions of all available configuration options for an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DescribeConfigurationOptionsInput{
		ApplicationName: aws.String("my-app"),
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.DescribeConfigurationOptions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeTooManyBucketsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyBucketsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DescribeConfigurationOptionsRequest

func (c *ElasticBeanstalk) DescribeConfigurationOptionsRequest(input *DescribeConfigurationOptionsInput) (req *request.Request, output *DescribeConfigurationOptionsOutput)

DescribeConfigurationOptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeConfigurationOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeConfigurationOptions for more information on using the DescribeConfigurationOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeConfigurationOptionsRequest method.
req, resp := client.DescribeConfigurationOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeConfigurationOptions

func (*ElasticBeanstalk) DescribeConfigurationOptionsWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeConfigurationOptionsWithContext(ctx aws.Context, input *DescribeConfigurationOptionsInput, opts ...request.Option) (*DescribeConfigurationOptionsOutput, error)

DescribeConfigurationOptionsWithContext is the same as DescribeConfigurationOptions with the addition of the ability to pass a context and additional request options.

See DescribeConfigurationOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeConfigurationSettings

DescribeConfigurationSettings API operation for AWS Elastic Beanstalk.

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

  • DeleteEnvironmentConfiguration

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeConfigurationSettings for usage and error information.

Returned Error Codes:

  • ErrCodeTooManyBucketsException "TooManyBucketsException" The specified account has reached its limit of Amazon S3 buckets.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings

Example (Shared00)

To view configurations settings for an environment

The following operation retrieves configuration settings for an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DescribeConfigurationSettingsInput{
		ApplicationName: aws.String("my-app"),
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.DescribeConfigurationSettings(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeTooManyBucketsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyBucketsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DescribeConfigurationSettingsRequest

func (c *ElasticBeanstalk) DescribeConfigurationSettingsRequest(input *DescribeConfigurationSettingsInput) (req *request.Request, output *DescribeConfigurationSettingsOutput)

DescribeConfigurationSettingsRequest generates a "aws/request.Request" representing the client's request for the DescribeConfigurationSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeConfigurationSettings for more information on using the DescribeConfigurationSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeConfigurationSettingsRequest method.
req, resp := client.DescribeConfigurationSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings

func (*ElasticBeanstalk) DescribeConfigurationSettingsWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeConfigurationSettingsWithContext(ctx aws.Context, input *DescribeConfigurationSettingsInput, opts ...request.Option) (*DescribeConfigurationSettingsOutput, error)

DescribeConfigurationSettingsWithContext is the same as DescribeConfigurationSettings with the addition of the ability to pass a context and additional request options.

See DescribeConfigurationSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeEnvironmentHealth added in v0.7.4

DescribeEnvironmentHealth API operation for AWS Elastic Beanstalk.

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeEnvironmentHealth for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" One or more input parameters is not valid. Please correct the input parameters and try the operation again.

  • ErrCodeServiceException "ElasticBeanstalkServiceException" A generic service exception has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth

Example (Shared00)

To view environment health

The following operation retrieves overall health information for an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DescribeEnvironmentHealthInput{
		AttributeNames: []*string{
			aws.String("All"),
		},
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.DescribeEnvironmentHealth(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInvalidRequestException:
				fmt.Println(elasticbeanstalk.ErrCodeInvalidRequestException, aerr.Error())
			case elasticbeanstalk.ErrCodeServiceException:
				fmt.Println(elasticbeanstalk.ErrCodeServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DescribeEnvironmentHealthRequest added in v0.7.4

func (c *ElasticBeanstalk) DescribeEnvironmentHealthRequest(input *DescribeEnvironmentHealthInput) (req *request.Request, output *DescribeEnvironmentHealthOutput)

DescribeEnvironmentHealthRequest generates a "aws/request.Request" representing the client's request for the DescribeEnvironmentHealth operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEnvironmentHealth for more information on using the DescribeEnvironmentHealth API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEnvironmentHealthRequest method.
req, resp := client.DescribeEnvironmentHealthRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironmentHealth

func (*ElasticBeanstalk) DescribeEnvironmentHealthWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeEnvironmentHealthWithContext(ctx aws.Context, input *DescribeEnvironmentHealthInput, opts ...request.Option) (*DescribeEnvironmentHealthOutput, error)

DescribeEnvironmentHealthWithContext is the same as DescribeEnvironmentHealth with the addition of the ability to pass a context and additional request options.

See DescribeEnvironmentHealth for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeEnvironmentManagedActionHistory added in v1.1.19

DescribeEnvironmentManagedActionHistory API operation for AWS Elastic Beanstalk.

Lists an environment's completed and failed managed actions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeEnvironmentManagedActionHistory for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ElasticBeanstalkServiceException" A generic service exception has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory

func (*ElasticBeanstalk) DescribeEnvironmentManagedActionHistoryRequest added in v1.1.19

func (c *ElasticBeanstalk) DescribeEnvironmentManagedActionHistoryRequest(input *DescribeEnvironmentManagedActionHistoryInput) (req *request.Request, output *DescribeEnvironmentManagedActionHistoryOutput)

DescribeEnvironmentManagedActionHistoryRequest generates a "aws/request.Request" representing the client's request for the DescribeEnvironmentManagedActionHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEnvironmentManagedActionHistory for more information on using the DescribeEnvironmentManagedActionHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEnvironmentManagedActionHistoryRequest method.
req, resp := client.DescribeEnvironmentManagedActionHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActionHistory

func (*ElasticBeanstalk) DescribeEnvironmentManagedActionHistoryWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeEnvironmentManagedActionHistoryWithContext(ctx aws.Context, input *DescribeEnvironmentManagedActionHistoryInput, opts ...request.Option) (*DescribeEnvironmentManagedActionHistoryOutput, error)

DescribeEnvironmentManagedActionHistoryWithContext is the same as DescribeEnvironmentManagedActionHistory with the addition of the ability to pass a context and additional request options.

See DescribeEnvironmentManagedActionHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeEnvironmentManagedActions added in v1.1.19

DescribeEnvironmentManagedActions API operation for AWS Elastic Beanstalk.

Lists an environment's upcoming and in-progress managed actions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeEnvironmentManagedActions for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ElasticBeanstalkServiceException" A generic service exception has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions

func (*ElasticBeanstalk) DescribeEnvironmentManagedActionsRequest added in v1.1.19

func (c *ElasticBeanstalk) DescribeEnvironmentManagedActionsRequest(input *DescribeEnvironmentManagedActionsInput) (req *request.Request, output *DescribeEnvironmentManagedActionsOutput)

DescribeEnvironmentManagedActionsRequest generates a "aws/request.Request" representing the client's request for the DescribeEnvironmentManagedActions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEnvironmentManagedActions for more information on using the DescribeEnvironmentManagedActions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEnvironmentManagedActionsRequest method.
req, resp := client.DescribeEnvironmentManagedActionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironmentManagedActions

func (*ElasticBeanstalk) DescribeEnvironmentManagedActionsWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeEnvironmentManagedActionsWithContext(ctx aws.Context, input *DescribeEnvironmentManagedActionsInput, opts ...request.Option) (*DescribeEnvironmentManagedActionsOutput, error)

DescribeEnvironmentManagedActionsWithContext is the same as DescribeEnvironmentManagedActions with the addition of the ability to pass a context and additional request options.

See DescribeEnvironmentManagedActions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeEnvironmentResources

DescribeEnvironmentResources API operation for AWS Elastic Beanstalk.

Returns AWS resources for this environment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeEnvironmentResources for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources

Example (Shared00)

To view information about the AWS resources in your environment

The following operation retrieves information about resources in an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DescribeEnvironmentResourcesInput{
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.DescribeEnvironmentResources(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DescribeEnvironmentResourcesRequest

func (c *ElasticBeanstalk) DescribeEnvironmentResourcesRequest(input *DescribeEnvironmentResourcesInput) (req *request.Request, output *DescribeEnvironmentResourcesOutput)

DescribeEnvironmentResourcesRequest generates a "aws/request.Request" representing the client's request for the DescribeEnvironmentResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEnvironmentResources for more information on using the DescribeEnvironmentResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEnvironmentResourcesRequest method.
req, resp := client.DescribeEnvironmentResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironmentResources

func (*ElasticBeanstalk) DescribeEnvironmentResourcesWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeEnvironmentResourcesWithContext(ctx aws.Context, input *DescribeEnvironmentResourcesInput, opts ...request.Option) (*DescribeEnvironmentResourcesOutput, error)

DescribeEnvironmentResourcesWithContext is the same as DescribeEnvironmentResources with the addition of the ability to pass a context and additional request options.

See DescribeEnvironmentResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeEnvironments

DescribeEnvironments API operation for AWS Elastic Beanstalk.

Returns descriptions for existing environments.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeEnvironments for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironments

Example (Shared00)

To view information about an environment

The following operation retrieves information about an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DescribeEnvironmentsInput{
		EnvironmentNames: []*string{
			aws.String("my-env"),
		},
	}

	result, err := svc.DescribeEnvironments(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DescribeEnvironmentsRequest

func (c *ElasticBeanstalk) DescribeEnvironmentsRequest(input *DescribeEnvironmentsInput) (req *request.Request, output *EnvironmentDescriptionsMessage)

DescribeEnvironmentsRequest generates a "aws/request.Request" representing the client's request for the DescribeEnvironments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEnvironments for more information on using the DescribeEnvironments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEnvironmentsRequest method.
req, resp := client.DescribeEnvironmentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironments

func (*ElasticBeanstalk) DescribeEnvironmentsWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeEnvironmentsWithContext(ctx aws.Context, input *DescribeEnvironmentsInput, opts ...request.Option) (*EnvironmentDescriptionsMessage, error)

DescribeEnvironmentsWithContext is the same as DescribeEnvironments with the addition of the ability to pass a context and additional request options.

See DescribeEnvironments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeEvents

func (c *ElasticBeanstalk) DescribeEvents(input *DescribeEventsInput) (*DescribeEventsOutput, error)

DescribeEvents API operation for AWS Elastic Beanstalk.

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeEvents for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEvents

Example (Shared00)

To view events for an environment

The following operation retrieves events for an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DescribeEventsInput{
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.DescribeEvents(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DescribeEventsPages

func (c *ElasticBeanstalk) DescribeEventsPages(input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool) error

DescribeEventsPages iterates over the pages of a DescribeEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeEvents operation.
pageNum := 0
err := client.DescribeEventsPages(params,
    func(page *elasticbeanstalk.DescribeEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElasticBeanstalk) DescribeEventsPagesWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeEventsPagesWithContext(ctx aws.Context, input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool, opts ...request.Option) error

DescribeEventsPagesWithContext same as DescribeEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeEventsRequest

func (c *ElasticBeanstalk) DescribeEventsRequest(input *DescribeEventsInput) (req *request.Request, output *DescribeEventsOutput)

DescribeEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEvents for more information on using the DescribeEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEventsRequest method.
req, resp := client.DescribeEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEvents

func (*ElasticBeanstalk) DescribeEventsWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeEventsWithContext(ctx aws.Context, input *DescribeEventsInput, opts ...request.Option) (*DescribeEventsOutput, error)

DescribeEventsWithContext is the same as DescribeEvents with the addition of the ability to pass a context and additional request options.

See DescribeEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribeInstancesHealth added in v0.7.4

DescribeInstancesHealth API operation for AWS Elastic Beanstalk.

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribeInstancesHealth for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" One or more input parameters is not valid. Please correct the input parameters and try the operation again.

  • ErrCodeServiceException "ElasticBeanstalkServiceException" A generic service exception has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeInstancesHealth

Example (Shared00)

To view environment health

The following operation retrieves health information for instances in an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.DescribeInstancesHealthInput{
		AttributeNames: []*string{
			aws.String("All"),
		},
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.DescribeInstancesHealth(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInvalidRequestException:
				fmt.Println(elasticbeanstalk.ErrCodeInvalidRequestException, aerr.Error())
			case elasticbeanstalk.ErrCodeServiceException:
				fmt.Println(elasticbeanstalk.ErrCodeServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) DescribeInstancesHealthRequest added in v0.7.4

func (c *ElasticBeanstalk) DescribeInstancesHealthRequest(input *DescribeInstancesHealthInput) (req *request.Request, output *DescribeInstancesHealthOutput)

DescribeInstancesHealthRequest generates a "aws/request.Request" representing the client's request for the DescribeInstancesHealth operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeInstancesHealth for more information on using the DescribeInstancesHealth API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeInstancesHealthRequest method.
req, resp := client.DescribeInstancesHealthRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeInstancesHealth

func (*ElasticBeanstalk) DescribeInstancesHealthWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribeInstancesHealthWithContext(ctx aws.Context, input *DescribeInstancesHealthInput, opts ...request.Option) (*DescribeInstancesHealthOutput, error)

DescribeInstancesHealthWithContext is the same as DescribeInstancesHealth with the addition of the ability to pass a context and additional request options.

See DescribeInstancesHealth for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) DescribePlatformVersion added in v1.6.27

DescribePlatformVersion API operation for AWS Elastic Beanstalk.

Describes the version of the platform.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation DescribePlatformVersion for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeServiceException "ElasticBeanstalkServiceException" A generic service exception has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribePlatformVersion

func (*ElasticBeanstalk) DescribePlatformVersionRequest added in v1.6.27

func (c *ElasticBeanstalk) DescribePlatformVersionRequest(input *DescribePlatformVersionInput) (req *request.Request, output *DescribePlatformVersionOutput)

DescribePlatformVersionRequest generates a "aws/request.Request" representing the client's request for the DescribePlatformVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePlatformVersion for more information on using the DescribePlatformVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePlatformVersionRequest method.
req, resp := client.DescribePlatformVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribePlatformVersion

func (*ElasticBeanstalk) DescribePlatformVersionWithContext added in v1.8.0

func (c *ElasticBeanstalk) DescribePlatformVersionWithContext(ctx aws.Context, input *DescribePlatformVersionInput, opts ...request.Option) (*DescribePlatformVersionOutput, error)

DescribePlatformVersionWithContext is the same as DescribePlatformVersion with the addition of the ability to pass a context and additional request options.

See DescribePlatformVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) ListAvailableSolutionStacks

ListAvailableSolutionStacks API operation for AWS Elastic Beanstalk.

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation ListAvailableSolutionStacks for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks

Example (Shared00)

To view solution stacks

The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.ListAvailableSolutionStacksInput{}

	result, err := svc.ListAvailableSolutionStacks(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) ListAvailableSolutionStacksRequest

func (c *ElasticBeanstalk) ListAvailableSolutionStacksRequest(input *ListAvailableSolutionStacksInput) (req *request.Request, output *ListAvailableSolutionStacksOutput)

ListAvailableSolutionStacksRequest generates a "aws/request.Request" representing the client's request for the ListAvailableSolutionStacks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAvailableSolutionStacks for more information on using the ListAvailableSolutionStacks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAvailableSolutionStacksRequest method.
req, resp := client.ListAvailableSolutionStacksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListAvailableSolutionStacks

func (*ElasticBeanstalk) ListAvailableSolutionStacksWithContext added in v1.8.0

func (c *ElasticBeanstalk) ListAvailableSolutionStacksWithContext(ctx aws.Context, input *ListAvailableSolutionStacksInput, opts ...request.Option) (*ListAvailableSolutionStacksOutput, error)

ListAvailableSolutionStacksWithContext is the same as ListAvailableSolutionStacks with the addition of the ability to pass a context and additional request options.

See ListAvailableSolutionStacks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) ListPlatformVersions added in v1.6.27

func (c *ElasticBeanstalk) ListPlatformVersions(input *ListPlatformVersionsInput) (*ListPlatformVersionsOutput, error)

ListPlatformVersions API operation for AWS Elastic Beanstalk.

Lists the available platforms.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation ListPlatformVersions for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeServiceException "ElasticBeanstalkServiceException" A generic service exception has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListPlatformVersions

func (*ElasticBeanstalk) ListPlatformVersionsRequest added in v1.6.27

func (c *ElasticBeanstalk) ListPlatformVersionsRequest(input *ListPlatformVersionsInput) (req *request.Request, output *ListPlatformVersionsOutput)

ListPlatformVersionsRequest generates a "aws/request.Request" representing the client's request for the ListPlatformVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPlatformVersions for more information on using the ListPlatformVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPlatformVersionsRequest method.
req, resp := client.ListPlatformVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListPlatformVersions

func (*ElasticBeanstalk) ListPlatformVersionsWithContext added in v1.8.0

func (c *ElasticBeanstalk) ListPlatformVersionsWithContext(ctx aws.Context, input *ListPlatformVersionsInput, opts ...request.Option) (*ListPlatformVersionsOutput, error)

ListPlatformVersionsWithContext is the same as ListPlatformVersions with the addition of the ability to pass a context and additional request options.

See ListPlatformVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) ListTagsForResource added in v1.12.10

func (c *ElasticBeanstalk) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Elastic Beanstalk.

Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.

Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource doesn't exist for the specified Amazon Resource Name (ARN).

  • ErrCodeResourceTypeNotSupportedException "ResourceTypeNotSupportedException" The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListTagsForResource

func (*ElasticBeanstalk) ListTagsForResourceRequest added in v1.12.10

func (c *ElasticBeanstalk) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListTagsForResource

func (*ElasticBeanstalk) ListTagsForResourceWithContext added in v1.12.10

func (c *ElasticBeanstalk) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) RebuildEnvironment

func (c *ElasticBeanstalk) RebuildEnvironment(input *RebuildEnvironmentInput) (*RebuildEnvironmentOutput, error)

RebuildEnvironment API operation for AWS Elastic Beanstalk.

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation RebuildEnvironment for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/RebuildEnvironment

Example (Shared00)

To rebuild an environment

The following operation terminates and recreates the resources in an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.RebuildEnvironmentInput{
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.RebuildEnvironment(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) RebuildEnvironmentRequest

func (c *ElasticBeanstalk) RebuildEnvironmentRequest(input *RebuildEnvironmentInput) (req *request.Request, output *RebuildEnvironmentOutput)

RebuildEnvironmentRequest generates a "aws/request.Request" representing the client's request for the RebuildEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebuildEnvironment for more information on using the RebuildEnvironment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebuildEnvironmentRequest method.
req, resp := client.RebuildEnvironmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/RebuildEnvironment

func (*ElasticBeanstalk) RebuildEnvironmentWithContext added in v1.8.0

func (c *ElasticBeanstalk) RebuildEnvironmentWithContext(ctx aws.Context, input *RebuildEnvironmentInput, opts ...request.Option) (*RebuildEnvironmentOutput, error)

RebuildEnvironmentWithContext is the same as RebuildEnvironment with the addition of the ability to pass a context and additional request options.

See RebuildEnvironment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) RequestEnvironmentInfo

RequestEnvironmentInfo API operation for AWS Elastic Beanstalk.

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

  • RetrieveEnvironmentInfo

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation RequestEnvironmentInfo for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo

Example (Shared00)

To request tailed logs

The following operation requests logs from an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.RequestEnvironmentInfoInput{
		EnvironmentName: aws.String("my-env"),
		InfoType:        aws.String("tail"),
	}

	result, err := svc.RequestEnvironmentInfo(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) RequestEnvironmentInfoRequest

func (c *ElasticBeanstalk) RequestEnvironmentInfoRequest(input *RequestEnvironmentInfoInput) (req *request.Request, output *RequestEnvironmentInfoOutput)

RequestEnvironmentInfoRequest generates a "aws/request.Request" representing the client's request for the RequestEnvironmentInfo operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RequestEnvironmentInfo for more information on using the RequestEnvironmentInfo API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RequestEnvironmentInfoRequest method.
req, resp := client.RequestEnvironmentInfoRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/RequestEnvironmentInfo

func (*ElasticBeanstalk) RequestEnvironmentInfoWithContext added in v1.8.0

func (c *ElasticBeanstalk) RequestEnvironmentInfoWithContext(ctx aws.Context, input *RequestEnvironmentInfoInput, opts ...request.Option) (*RequestEnvironmentInfoOutput, error)

RequestEnvironmentInfoWithContext is the same as RequestEnvironmentInfo with the addition of the ability to pass a context and additional request options.

See RequestEnvironmentInfo for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) RestartAppServer

func (c *ElasticBeanstalk) RestartAppServer(input *RestartAppServerInput) (*RestartAppServerOutput, error)

RestartAppServer API operation for AWS Elastic Beanstalk.

Causes the environment to restart the application container server running on each Amazon EC2 instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation RestartAppServer for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/RestartAppServer

Example (Shared00)

To restart application servers

The following operation restarts application servers on all instances in an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.RestartAppServerInput{
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.RestartAppServer(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) RestartAppServerRequest

func (c *ElasticBeanstalk) RestartAppServerRequest(input *RestartAppServerInput) (req *request.Request, output *RestartAppServerOutput)

RestartAppServerRequest generates a "aws/request.Request" representing the client's request for the RestartAppServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestartAppServer for more information on using the RestartAppServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RestartAppServerRequest method.
req, resp := client.RestartAppServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/RestartAppServer

func (*ElasticBeanstalk) RestartAppServerWithContext added in v1.8.0

func (c *ElasticBeanstalk) RestartAppServerWithContext(ctx aws.Context, input *RestartAppServerInput, opts ...request.Option) (*RestartAppServerOutput, error)

RestartAppServerWithContext is the same as RestartAppServer with the addition of the ability to pass a context and additional request options.

See RestartAppServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) RetrieveEnvironmentInfo

RetrieveEnvironmentInfo API operation for AWS Elastic Beanstalk.

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

  • RequestEnvironmentInfo

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation RetrieveEnvironmentInfo for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo

Example (Shared00)

To retrieve tailed logs

The following operation retrieves a link to logs from an environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.RetrieveEnvironmentInfoInput{
		EnvironmentName: aws.String("my-env"),
		InfoType:        aws.String("tail"),
	}

	result, err := svc.RetrieveEnvironmentInfo(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) RetrieveEnvironmentInfoRequest

func (c *ElasticBeanstalk) RetrieveEnvironmentInfoRequest(input *RetrieveEnvironmentInfoInput) (req *request.Request, output *RetrieveEnvironmentInfoOutput)

RetrieveEnvironmentInfoRequest generates a "aws/request.Request" representing the client's request for the RetrieveEnvironmentInfo operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RetrieveEnvironmentInfo for more information on using the RetrieveEnvironmentInfo API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RetrieveEnvironmentInfoRequest method.
req, resp := client.RetrieveEnvironmentInfoRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/RetrieveEnvironmentInfo

func (*ElasticBeanstalk) RetrieveEnvironmentInfoWithContext added in v1.8.0

func (c *ElasticBeanstalk) RetrieveEnvironmentInfoWithContext(ctx aws.Context, input *RetrieveEnvironmentInfoInput, opts ...request.Option) (*RetrieveEnvironmentInfoOutput, error)

RetrieveEnvironmentInfoWithContext is the same as RetrieveEnvironmentInfo with the addition of the ability to pass a context and additional request options.

See RetrieveEnvironmentInfo for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) SwapEnvironmentCNAMEs

SwapEnvironmentCNAMEs API operation for AWS Elastic Beanstalk.

Swaps the CNAMEs of two environments.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation SwapEnvironmentCNAMEs for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs

Example (Shared00)

To swap environment CNAMES

The following operation swaps the assigned subdomains of two environments:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.SwapEnvironmentCNAMEsInput{
		DestinationEnvironmentName: aws.String("my-env-green"),
		SourceEnvironmentName:      aws.String("my-env-blue"),
	}

	result, err := svc.SwapEnvironmentCNAMEs(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) SwapEnvironmentCNAMEsRequest

func (c *ElasticBeanstalk) SwapEnvironmentCNAMEsRequest(input *SwapEnvironmentCNAMEsInput) (req *request.Request, output *SwapEnvironmentCNAMEsOutput)

SwapEnvironmentCNAMEsRequest generates a "aws/request.Request" representing the client's request for the SwapEnvironmentCNAMEs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SwapEnvironmentCNAMEs for more information on using the SwapEnvironmentCNAMEs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SwapEnvironmentCNAMEsRequest method.
req, resp := client.SwapEnvironmentCNAMEsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/SwapEnvironmentCNAMEs

func (*ElasticBeanstalk) SwapEnvironmentCNAMEsWithContext added in v1.8.0

func (c *ElasticBeanstalk) SwapEnvironmentCNAMEsWithContext(ctx aws.Context, input *SwapEnvironmentCNAMEsInput, opts ...request.Option) (*SwapEnvironmentCNAMEsOutput, error)

SwapEnvironmentCNAMEsWithContext is the same as SwapEnvironmentCNAMEs with the addition of the ability to pass a context and additional request options.

See SwapEnvironmentCNAMEs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) TerminateEnvironment

func (c *ElasticBeanstalk) TerminateEnvironment(input *TerminateEnvironmentInput) (*EnvironmentDescription, error)

TerminateEnvironment API operation for AWS Elastic Beanstalk.

Terminates the specified environment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation TerminateEnvironment for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/TerminateEnvironment

Example (Shared00)

To terminate an environment

The following operation terminates an Elastic Beanstalk environment named my-env:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.TerminateEnvironmentInput{
		EnvironmentName: aws.String("my-env"),
	}

	result, err := svc.TerminateEnvironment(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) TerminateEnvironmentRequest

func (c *ElasticBeanstalk) TerminateEnvironmentRequest(input *TerminateEnvironmentInput) (req *request.Request, output *EnvironmentDescription)

TerminateEnvironmentRequest generates a "aws/request.Request" representing the client's request for the TerminateEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TerminateEnvironment for more information on using the TerminateEnvironment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TerminateEnvironmentRequest method.
req, resp := client.TerminateEnvironmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/TerminateEnvironment

func (*ElasticBeanstalk) TerminateEnvironmentWithContext added in v1.8.0

func (c *ElasticBeanstalk) TerminateEnvironmentWithContext(ctx aws.Context, input *TerminateEnvironmentInput, opts ...request.Option) (*EnvironmentDescription, error)

TerminateEnvironmentWithContext is the same as TerminateEnvironment with the addition of the ability to pass a context and additional request options.

See TerminateEnvironment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) UpdateApplication

UpdateApplication API operation for AWS Elastic Beanstalk.

Updates the specified application to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation UpdateApplication for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateApplication

Example (Shared00)

To change an application's description

The following operation updates the description of an application named my-app:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.UpdateApplicationInput{
		ApplicationName: aws.String("my-app"),
		Description:     aws.String("my Elastic Beanstalk application"),
	}

	result, err := svc.UpdateApplication(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) UpdateApplicationRequest

func (c *ElasticBeanstalk) UpdateApplicationRequest(input *UpdateApplicationInput) (req *request.Request, output *ApplicationDescriptionMessage)

UpdateApplicationRequest generates a "aws/request.Request" representing the client's request for the UpdateApplication operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateApplication for more information on using the UpdateApplication API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateApplicationRequest method.
req, resp := client.UpdateApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateApplication

func (*ElasticBeanstalk) UpdateApplicationResourceLifecycle added in v1.6.8

UpdateApplicationResourceLifecycle API operation for AWS Elastic Beanstalk.

Modifies lifecycle settings for an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation UpdateApplicationResourceLifecycle for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle

func (*ElasticBeanstalk) UpdateApplicationResourceLifecycleRequest added in v1.6.8

func (c *ElasticBeanstalk) UpdateApplicationResourceLifecycleRequest(input *UpdateApplicationResourceLifecycleInput) (req *request.Request, output *UpdateApplicationResourceLifecycleOutput)

UpdateApplicationResourceLifecycleRequest generates a "aws/request.Request" representing the client's request for the UpdateApplicationResourceLifecycle operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateApplicationResourceLifecycle for more information on using the UpdateApplicationResourceLifecycle API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateApplicationResourceLifecycleRequest method.
req, resp := client.UpdateApplicationResourceLifecycleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateApplicationResourceLifecycle

func (*ElasticBeanstalk) UpdateApplicationResourceLifecycleWithContext added in v1.8.0

func (c *ElasticBeanstalk) UpdateApplicationResourceLifecycleWithContext(ctx aws.Context, input *UpdateApplicationResourceLifecycleInput, opts ...request.Option) (*UpdateApplicationResourceLifecycleOutput, error)

UpdateApplicationResourceLifecycleWithContext is the same as UpdateApplicationResourceLifecycle with the addition of the ability to pass a context and additional request options.

See UpdateApplicationResourceLifecycle for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) UpdateApplicationVersion

UpdateApplicationVersion API operation for AWS Elastic Beanstalk.

Updates the specified application version to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation UpdateApplicationVersion for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateApplicationVersion

Example (Shared00)

To change an application version's description

The following operation updates the description of an application version named 22a0-stage-150819_185942:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.UpdateApplicationVersionInput{
		ApplicationName: aws.String("my-app"),
		Description:     aws.String("new description"),
		VersionLabel:    aws.String("22a0-stage-150819_185942"),
	}

	result, err := svc.UpdateApplicationVersion(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) UpdateApplicationVersionRequest

func (c *ElasticBeanstalk) UpdateApplicationVersionRequest(input *UpdateApplicationVersionInput) (req *request.Request, output *ApplicationVersionDescriptionMessage)

UpdateApplicationVersionRequest generates a "aws/request.Request" representing the client's request for the UpdateApplicationVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateApplicationVersion for more information on using the UpdateApplicationVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateApplicationVersionRequest method.
req, resp := client.UpdateApplicationVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateApplicationVersion

func (*ElasticBeanstalk) UpdateApplicationVersionWithContext added in v1.8.0

func (c *ElasticBeanstalk) UpdateApplicationVersionWithContext(ctx aws.Context, input *UpdateApplicationVersionInput, opts ...request.Option) (*ApplicationVersionDescriptionMessage, error)

UpdateApplicationVersionWithContext is the same as UpdateApplicationVersion with the addition of the ability to pass a context and additional request options.

See UpdateApplicationVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) UpdateApplicationWithContext added in v1.8.0

func (c *ElasticBeanstalk) UpdateApplicationWithContext(ctx aws.Context, input *UpdateApplicationInput, opts ...request.Option) (*ApplicationDescriptionMessage, error)

UpdateApplicationWithContext is the same as UpdateApplication with the addition of the ability to pass a context and additional request options.

See UpdateApplication for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) UpdateConfigurationTemplate

UpdateConfigurationTemplate API operation for AWS Elastic Beanstalk.

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

  • DescribeConfigurationOptions

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation UpdateConfigurationTemplate for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeTooManyBucketsException "TooManyBucketsException" The specified account has reached its limit of Amazon S3 buckets.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate

Example (Shared00)

To update a configuration template

The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.UpdateConfigurationTemplateInput{
		ApplicationName: aws.String("my-app"),
		OptionsToRemove: []*elasticbeanstalk.OptionSpecification{
			{
				Namespace:  aws.String("aws:elasticbeanstalk:healthreporting:system"),
				OptionName: aws.String("ConfigDocument"),
			},
		},
		TemplateName: aws.String("my-template"),
	}

	result, err := svc.UpdateConfigurationTemplate(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			case elasticbeanstalk.ErrCodeTooManyBucketsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyBucketsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) UpdateConfigurationTemplateRequest

func (c *ElasticBeanstalk) UpdateConfigurationTemplateRequest(input *UpdateConfigurationTemplateInput) (req *request.Request, output *ConfigurationSettingsDescription)

UpdateConfigurationTemplateRequest generates a "aws/request.Request" representing the client's request for the UpdateConfigurationTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConfigurationTemplate for more information on using the UpdateConfigurationTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateConfigurationTemplateRequest method.
req, resp := client.UpdateConfigurationTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateConfigurationTemplate

func (*ElasticBeanstalk) UpdateConfigurationTemplateWithContext added in v1.8.0

func (c *ElasticBeanstalk) UpdateConfigurationTemplateWithContext(ctx aws.Context, input *UpdateConfigurationTemplateInput, opts ...request.Option) (*ConfigurationSettingsDescription, error)

UpdateConfigurationTemplateWithContext is the same as UpdateConfigurationTemplate with the addition of the ability to pass a context and additional request options.

See UpdateConfigurationTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) UpdateEnvironment

func (c *ElasticBeanstalk) UpdateEnvironment(input *UpdateEnvironmentInput) (*EnvironmentDescription, error)

UpdateEnvironment API operation for AWS Elastic Beanstalk.

Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.

When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation UpdateEnvironment for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeTooManyBucketsException "TooManyBucketsException" The specified account has reached its limit of Amazon S3 buckets.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateEnvironment

Example (Shared00)

To update an environment to a new version

The following operation updates an environment named "my-env" to version "v2" of the application to which it belongs:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.UpdateEnvironmentInput{
		EnvironmentName: aws.String("my-env"),
		VersionLabel:    aws.String("v2"),
	}

	result, err := svc.UpdateEnvironment(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			case elasticbeanstalk.ErrCodeTooManyBucketsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyBucketsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To configure option settings

The following operation configures several options in the aws:elb:loadbalancer namespace:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.UpdateEnvironmentInput{
		EnvironmentName: aws.String("my-env"),
		OptionSettings: []*elasticbeanstalk.ConfigurationOptionSetting{
			{
				Namespace:  aws.String("aws:elb:healthcheck"),
				OptionName: aws.String("Interval"),
				Value:      aws.String("15"),
			},
			{
				Namespace:  aws.String("aws:elb:healthcheck"),
				OptionName: aws.String("Timeout"),
				Value:      aws.String("8"),
			},
			{
				Namespace:  aws.String("aws:elb:healthcheck"),
				OptionName: aws.String("HealthyThreshold"),
				Value:      aws.String("2"),
			},
			{
				Namespace:  aws.String("aws:elb:healthcheck"),
				OptionName: aws.String("UnhealthyThreshold"),
				Value:      aws.String("3"),
			},
		},
	}

	result, err := svc.UpdateEnvironment(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			case elasticbeanstalk.ErrCodeTooManyBucketsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyBucketsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) UpdateEnvironmentRequest

func (c *ElasticBeanstalk) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) (req *request.Request, output *EnvironmentDescription)

UpdateEnvironmentRequest generates a "aws/request.Request" representing the client's request for the UpdateEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateEnvironment for more information on using the UpdateEnvironment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateEnvironmentRequest method.
req, resp := client.UpdateEnvironmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateEnvironment

func (*ElasticBeanstalk) UpdateEnvironmentWithContext added in v1.8.0

func (c *ElasticBeanstalk) UpdateEnvironmentWithContext(ctx aws.Context, input *UpdateEnvironmentInput, opts ...request.Option) (*EnvironmentDescription, error)

UpdateEnvironmentWithContext is the same as UpdateEnvironment with the addition of the ability to pass a context and additional request options.

See UpdateEnvironment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) UpdateTagsForResource added in v1.12.10

UpdateTagsForResource API operation for AWS Elastic Beanstalk.

Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove.

Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html).

If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:

elasticbeanstalk:AddTags

Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.

elasticbeanstalk:RemoveTags

Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.

For details about creating a custom user policy, see Creating a Custom User Policy (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation UpdateTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeOperationInProgressException "OperationInProgressFailure" Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

  • ErrCodeTooManyTagsException "TooManyTagsException" The number of tags in the resource would exceed the number of tags that each resource can have.

    To calculate this, the operation considers both the number of tags the resource already has and the tags this operation would add if it succeeded.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource doesn't exist for the specified Amazon Resource Name (ARN).

  • ErrCodeResourceTypeNotSupportedException "ResourceTypeNotSupportedException" The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateTagsForResource

func (*ElasticBeanstalk) UpdateTagsForResourceRequest added in v1.12.10

func (c *ElasticBeanstalk) UpdateTagsForResourceRequest(input *UpdateTagsForResourceInput) (req *request.Request, output *UpdateTagsForResourceOutput)

UpdateTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the UpdateTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateTagsForResource for more information on using the UpdateTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateTagsForResourceRequest method.
req, resp := client.UpdateTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateTagsForResource

func (*ElasticBeanstalk) UpdateTagsForResourceWithContext added in v1.12.10

func (c *ElasticBeanstalk) UpdateTagsForResourceWithContext(ctx aws.Context, input *UpdateTagsForResourceInput, opts ...request.Option) (*UpdateTagsForResourceOutput, error)

UpdateTagsForResourceWithContext is the same as UpdateTagsForResource with the addition of the ability to pass a context and additional request options.

See UpdateTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticBeanstalk) ValidateConfigurationSettings

ValidateConfigurationSettings API operation for AWS Elastic Beanstalk.

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elastic Beanstalk's API operation ValidateConfigurationSettings for usage and error information.

Returned Error Codes:

  • ErrCodeInsufficientPrivilegesException "InsufficientPrivilegesException" The specified account does not have sufficient privileges for one or more AWS services.

  • ErrCodeTooManyBucketsException "TooManyBucketsException" The specified account has reached its limit of Amazon S3 buckets.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings

Example (Shared00)

To validate configuration settings

The following operation validates a CloudWatch custom metrics config document:

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticbeanstalk"
)

func main() {
	svc := elasticbeanstalk.New(session.New())
	input := &elasticbeanstalk.ValidateConfigurationSettingsInput{
		ApplicationName: aws.String("my-app"),
		EnvironmentName: aws.String("my-env"),
		OptionSettings: []*elasticbeanstalk.ConfigurationOptionSetting{
			{
				Namespace:  aws.String("aws:elasticbeanstalk:healthreporting:system"),
				OptionName: aws.String("ConfigDocument"),
				Value:      aws.String("{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}"),
			},
		},
	}

	result, err := svc.ValidateConfigurationSettings(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticbeanstalk.ErrCodeInsufficientPrivilegesException:
				fmt.Println(elasticbeanstalk.ErrCodeInsufficientPrivilegesException, aerr.Error())
			case elasticbeanstalk.ErrCodeTooManyBucketsException:
				fmt.Println(elasticbeanstalk.ErrCodeTooManyBucketsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ElasticBeanstalk) ValidateConfigurationSettingsRequest

func (c *ElasticBeanstalk) ValidateConfigurationSettingsRequest(input *ValidateConfigurationSettingsInput) (req *request.Request, output *ValidateConfigurationSettingsOutput)

ValidateConfigurationSettingsRequest generates a "aws/request.Request" representing the client's request for the ValidateConfigurationSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ValidateConfigurationSettings for more information on using the ValidateConfigurationSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ValidateConfigurationSettingsRequest method.
req, resp := client.ValidateConfigurationSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ValidateConfigurationSettings

func (*ElasticBeanstalk) ValidateConfigurationSettingsWithContext added in v1.8.0

func (c *ElasticBeanstalk) ValidateConfigurationSettingsWithContext(ctx aws.Context, input *ValidateConfigurationSettingsInput, opts ...request.Option) (*ValidateConfigurationSettingsOutput, error)

ValidateConfigurationSettingsWithContext is the same as ValidateConfigurationSettings with the addition of the ability to pass a context and additional request options.

See ValidateConfigurationSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type EnvironmentDescription

type EnvironmentDescription struct {

	// Indicates if there is an in-progress environment configuration update or
	// application version deployment that you can cancel.
	//
	// true: There is an update in progress.
	//
	// false: There are no updates currently in progress.
	AbortableOperationInProgress *bool `type:"boolean"`

	// The name of the application associated with this environment.
	ApplicationName *string `min:"1" type:"string"`

	// The URL to the CNAME for this environment.
	CNAME *string `min:"1" type:"string"`

	// The creation date for this environment.
	DateCreated *time.Time `type:"timestamp"`

	// The last modified date for this environment.
	DateUpdated *time.Time `type:"timestamp"`

	// Describes this environment.
	Description *string `type:"string"`

	// For load-balanced, autoscaling environments, the URL to the LoadBalancer.
	// For single-instance environments, the IP address of the instance.
	EndpointURL *string `type:"string"`

	// The environment's Amazon Resource Name (ARN), which can be used in other
	// API requests that require an ARN.
	EnvironmentArn *string `type:"string"`

	// The ID of this environment.
	EnvironmentId *string `type:"string"`

	// A list of links to other environments in the same group.
	EnvironmentLinks []*EnvironmentLink `type:"list"`

	// The name of this environment.
	EnvironmentName *string `min:"4" type:"string"`

	// Describes the health status of the environment. AWS Elastic Beanstalk indicates
	// the failure levels for a running environment:
	//
	//    * Red: Indicates the environment is not responsive. Occurs when three
	//    or more consecutive failures occur for an environment.
	//
	//    * Yellow: Indicates that something is wrong. Occurs when two consecutive
	//    failures occur for an environment.
	//
	//    * Green: Indicates the environment is healthy and fully functional.
	//
	//    * Grey: Default health for a new environment. The environment is not fully
	//    launched and health checks have not started or health checks are suspended
	//    during an UpdateEnvironment or RestartEnvironment request.
	//
	// Default: Grey
	Health *string `type:"string" enum:"EnvironmentHealth"`

	// Returns the health status of the application running in your environment.
	// For more information, see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html).
	HealthStatus *string `type:"string" enum:"EnvironmentHealthStatus"`

	// The ARN of the platform.
	PlatformArn *string `type:"string"`

	// The description of the AWS resources used by this environment.
	Resources *EnvironmentResourcesDescription `type:"structure"`

	// The name of the SolutionStack deployed with this environment.
	SolutionStackName *string `type:"string"`

	// The current operational status of the environment:
	//
	//    * Launching: Environment is in the process of initial deployment.
	//
	//    * Updating: Environment is in the process of updating its configuration
	//    settings or application version.
	//
	//    * Ready: Environment is available to have an action performed on it, such
	//    as update or terminate.
	//
	//    * Terminating: Environment is in the shut-down process.
	//
	//    * Terminated: Environment is not running.
	Status *string `type:"string" enum:"EnvironmentStatus"`

	// The name of the configuration template used to originally launch this environment.
	TemplateName *string `min:"1" type:"string"`

	// Describes the current tier of this environment.
	Tier *EnvironmentTier `type:"structure"`

	// The application version deployed in this environment.
	VersionLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the properties of an environment.

func (EnvironmentDescription) GoString added in v0.6.5

func (s EnvironmentDescription) GoString() string

GoString returns the string representation

func (*EnvironmentDescription) SetAbortableOperationInProgress added in v1.5.0

func (s *EnvironmentDescription) SetAbortableOperationInProgress(v bool) *EnvironmentDescription

SetAbortableOperationInProgress sets the AbortableOperationInProgress field's value.

func (*EnvironmentDescription) SetApplicationName added in v1.5.0

func (s *EnvironmentDescription) SetApplicationName(v string) *EnvironmentDescription

SetApplicationName sets the ApplicationName field's value.

func (*EnvironmentDescription) SetCNAME added in v1.5.0

SetCNAME sets the CNAME field's value.

func (*EnvironmentDescription) SetDateCreated added in v1.5.0

SetDateCreated sets the DateCreated field's value.

func (*EnvironmentDescription) SetDateUpdated added in v1.5.0

SetDateUpdated sets the DateUpdated field's value.

func (*EnvironmentDescription) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*EnvironmentDescription) SetEndpointURL added in v1.5.0

SetEndpointURL sets the EndpointURL field's value.

func (*EnvironmentDescription) SetEnvironmentArn added in v1.10.21

func (s *EnvironmentDescription) SetEnvironmentArn(v string) *EnvironmentDescription

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*EnvironmentDescription) SetEnvironmentId added in v1.5.0

func (s *EnvironmentDescription) SetEnvironmentId(v string) *EnvironmentDescription

SetEnvironmentId sets the EnvironmentId field's value.

func (s *EnvironmentDescription) SetEnvironmentLinks(v []*EnvironmentLink) *EnvironmentDescription

SetEnvironmentLinks sets the EnvironmentLinks field's value.

func (*EnvironmentDescription) SetEnvironmentName added in v1.5.0

func (s *EnvironmentDescription) SetEnvironmentName(v string) *EnvironmentDescription

SetEnvironmentName sets the EnvironmentName field's value.

func (*EnvironmentDescription) SetHealth added in v1.5.0

SetHealth sets the Health field's value.

func (*EnvironmentDescription) SetHealthStatus added in v1.5.0

func (s *EnvironmentDescription) SetHealthStatus(v string) *EnvironmentDescription

SetHealthStatus sets the HealthStatus field's value.

func (*EnvironmentDescription) SetPlatformArn added in v1.6.27

SetPlatformArn sets the PlatformArn field's value.

func (*EnvironmentDescription) SetResources added in v1.5.0

SetResources sets the Resources field's value.

func (*EnvironmentDescription) SetSolutionStackName added in v1.5.0

func (s *EnvironmentDescription) SetSolutionStackName(v string) *EnvironmentDescription

SetSolutionStackName sets the SolutionStackName field's value.

func (*EnvironmentDescription) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (*EnvironmentDescription) SetTemplateName added in v1.5.0

func (s *EnvironmentDescription) SetTemplateName(v string) *EnvironmentDescription

SetTemplateName sets the TemplateName field's value.

func (*EnvironmentDescription) SetTier added in v1.5.0

SetTier sets the Tier field's value.

func (*EnvironmentDescription) SetVersionLabel added in v1.5.0

func (s *EnvironmentDescription) SetVersionLabel(v string) *EnvironmentDescription

SetVersionLabel sets the VersionLabel field's value.

func (EnvironmentDescription) String added in v0.6.5

func (s EnvironmentDescription) String() string

String returns the string representation

type EnvironmentDescriptionsMessage added in v1.0.1

type EnvironmentDescriptionsMessage struct {

	// Returns an EnvironmentDescription list.
	Environments []*EnvironmentDescription `type:"list"`

	// In a paginated request, the token that you can pass in a subsequent request
	// to get the next response page.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Result message containing a list of environment descriptions.

func (EnvironmentDescriptionsMessage) GoString added in v1.0.1

GoString returns the string representation

func (*EnvironmentDescriptionsMessage) SetEnvironments added in v1.5.0

SetEnvironments sets the Environments field's value.

func (*EnvironmentDescriptionsMessage) SetNextToken added in v1.10.21

SetNextToken sets the NextToken field's value.

func (EnvironmentDescriptionsMessage) String added in v1.0.1

String returns the string representation

type EnvironmentInfoDescription

type EnvironmentInfoDescription struct {

	// The Amazon EC2 Instance ID for this information.
	Ec2InstanceId *string `type:"string"`

	// The type of information retrieved.
	InfoType *string `type:"string" enum:"EnvironmentInfoType"`

	// The retrieved information. Currently contains a presigned Amazon S3 URL.
	// The files are deleted after 15 minutes.
	//
	// Anyone in possession of this URL can access the files before they are deleted.
	// Make the URL available only to trusted parties.
	Message *string `type:"string"`

	// The time stamp when this information was retrieved.
	SampleTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The information retrieved from the Amazon EC2 instances.

func (EnvironmentInfoDescription) GoString added in v0.6.5

func (s EnvironmentInfoDescription) GoString() string

GoString returns the string representation

func (*EnvironmentInfoDescription) SetEc2InstanceId added in v1.5.0

SetEc2InstanceId sets the Ec2InstanceId field's value.

func (*EnvironmentInfoDescription) SetInfoType added in v1.5.0

SetInfoType sets the InfoType field's value.

func (*EnvironmentInfoDescription) SetMessage added in v1.5.0

SetMessage sets the Message field's value.

func (*EnvironmentInfoDescription) SetSampleTimestamp added in v1.5.0

SetSampleTimestamp sets the SampleTimestamp field's value.

func (EnvironmentInfoDescription) String added in v0.6.5

String returns the string representation

type EnvironmentLink struct {

	// The name of the linked environment (the dependency).
	EnvironmentName *string `type:"string"`

	// The name of the link.
	LinkName *string `type:"string"`
	// contains filtered or unexported fields
}

A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) for details.

func (EnvironmentLink) GoString added in v1.0.1

func (s EnvironmentLink) GoString() string

GoString returns the string representation

func (*EnvironmentLink) SetEnvironmentName added in v1.5.0

func (s *EnvironmentLink) SetEnvironmentName(v string) *EnvironmentLink

SetEnvironmentName sets the EnvironmentName field's value.

func (*EnvironmentLink) SetLinkName added in v1.5.0

func (s *EnvironmentLink) SetLinkName(v string) *EnvironmentLink

SetLinkName sets the LinkName field's value.

func (EnvironmentLink) String added in v1.0.1

func (s EnvironmentLink) String() string

String returns the string representation

type EnvironmentResourceDescription

type EnvironmentResourceDescription struct {

	// The AutoScalingGroups used by this environment.
	AutoScalingGroups []*AutoScalingGroup `type:"list"`

	// The name of the environment.
	EnvironmentName *string `min:"4" type:"string"`

	// The Amazon EC2 instances used by this environment.
	Instances []*Instance `type:"list"`

	// The Auto Scaling launch configurations in use by this environment.
	LaunchConfigurations []*LaunchConfiguration `type:"list"`

	// The Amazon EC2 launch templates in use by this environment.
	LaunchTemplates []*LaunchTemplate `type:"list"`

	// The LoadBalancers in use by this environment.
	LoadBalancers []*LoadBalancer `type:"list"`

	// The queues used by this environment.
	Queues []*Queue `type:"list"`

	// The AutoScaling triggers in use by this environment.
	Triggers []*Trigger `type:"list"`
	// contains filtered or unexported fields
}

Describes the AWS resources in use by this environment. This data is live.

func (EnvironmentResourceDescription) GoString added in v0.6.5

GoString returns the string representation

func (*EnvironmentResourceDescription) SetAutoScalingGroups added in v1.5.0

SetAutoScalingGroups sets the AutoScalingGroups field's value.

func (*EnvironmentResourceDescription) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*EnvironmentResourceDescription) SetInstances added in v1.5.0

SetInstances sets the Instances field's value.

func (*EnvironmentResourceDescription) SetLaunchConfigurations added in v1.5.0

SetLaunchConfigurations sets the LaunchConfigurations field's value.

func (*EnvironmentResourceDescription) SetLaunchTemplates added in v1.99.0

SetLaunchTemplates sets the LaunchTemplates field's value.

func (*EnvironmentResourceDescription) SetLoadBalancers added in v1.5.0

SetLoadBalancers sets the LoadBalancers field's value.

func (*EnvironmentResourceDescription) SetQueues added in v1.5.0

SetQueues sets the Queues field's value.

func (*EnvironmentResourceDescription) SetTriggers added in v1.5.0

SetTriggers sets the Triggers field's value.

func (EnvironmentResourceDescription) String added in v0.6.5

String returns the string representation

type EnvironmentResourcesDescription

type EnvironmentResourcesDescription struct {

	// Describes the LoadBalancer.
	LoadBalancer *LoadBalancerDescription `type:"structure"`
	// contains filtered or unexported fields
}

Describes the AWS resources in use by this environment. This data is not live data.

func (EnvironmentResourcesDescription) GoString added in v0.6.5

GoString returns the string representation

func (*EnvironmentResourcesDescription) SetLoadBalancer added in v1.5.0

SetLoadBalancer sets the LoadBalancer field's value.

func (EnvironmentResourcesDescription) String added in v0.6.5

String returns the string representation

type EnvironmentTier

type EnvironmentTier struct {

	// The name of this environment tier.
	//
	// Valid values:
	//
	//    * For Web server tier – WebServer
	//
	//    * For Worker tier – Worker
	Name *string `type:"string"`

	// The type of this environment tier.
	//
	// Valid values:
	//
	//    * For Web server tier – Standard
	//
	//    * For Worker tier – SQS/HTTP
	Type *string `type:"string"`

	// The version of this environment tier. When you don't set a value to it, Elastic
	// Beanstalk uses the latest compatible worker tier version.
	//
	// This member is deprecated. Any specific version that you set may become out
	// of date. We recommend leaving it unspecified.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the properties of an environment tier

func (EnvironmentTier) GoString added in v0.6.5

func (s EnvironmentTier) GoString() string

GoString returns the string representation

func (*EnvironmentTier) SetName added in v1.5.0

func (s *EnvironmentTier) SetName(v string) *EnvironmentTier

SetName sets the Name field's value.

func (*EnvironmentTier) SetType added in v1.5.0

func (s *EnvironmentTier) SetType(v string) *EnvironmentTier

SetType sets the Type field's value.

func (*EnvironmentTier) SetVersion added in v1.5.0

func (s *EnvironmentTier) SetVersion(v string) *EnvironmentTier

SetVersion sets the Version field's value.

func (EnvironmentTier) String added in v0.6.5

func (s EnvironmentTier) String() string

String returns the string representation

type EventDescription

type EventDescription struct {

	// The application associated with the event.
	ApplicationName *string `min:"1" type:"string"`

	// The name of the environment associated with this event.
	EnvironmentName *string `min:"4" type:"string"`

	// The date when the event occurred.
	EventDate *time.Time `type:"timestamp"`

	// The event message.
	Message *string `type:"string"`

	// The ARN of the platform.
	PlatformArn *string `type:"string"`

	// The web service request ID for the activity of this event.
	RequestId *string `type:"string"`

	// The severity level of this event.
	Severity *string `type:"string" enum:"EventSeverity"`

	// The name of the configuration associated with this event.
	TemplateName *string `min:"1" type:"string"`

	// The release label for the application version associated with this event.
	VersionLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an event.

func (EventDescription) GoString added in v0.6.5

func (s EventDescription) GoString() string

GoString returns the string representation

func (*EventDescription) SetApplicationName added in v1.5.0

func (s *EventDescription) SetApplicationName(v string) *EventDescription

SetApplicationName sets the ApplicationName field's value.

func (*EventDescription) SetEnvironmentName added in v1.5.0

func (s *EventDescription) SetEnvironmentName(v string) *EventDescription

SetEnvironmentName sets the EnvironmentName field's value.

func (*EventDescription) SetEventDate added in v1.5.0

func (s *EventDescription) SetEventDate(v time.Time) *EventDescription

SetEventDate sets the EventDate field's value.

func (*EventDescription) SetMessage added in v1.5.0

func (s *EventDescription) SetMessage(v string) *EventDescription

SetMessage sets the Message field's value.

func (*EventDescription) SetPlatformArn added in v1.6.27

func (s *EventDescription) SetPlatformArn(v string) *EventDescription

SetPlatformArn sets the PlatformArn field's value.

func (*EventDescription) SetRequestId added in v1.5.0

func (s *EventDescription) SetRequestId(v string) *EventDescription

SetRequestId sets the RequestId field's value.

func (*EventDescription) SetSeverity added in v1.5.0

func (s *EventDescription) SetSeverity(v string) *EventDescription

SetSeverity sets the Severity field's value.

func (*EventDescription) SetTemplateName added in v1.5.0

func (s *EventDescription) SetTemplateName(v string) *EventDescription

SetTemplateName sets the TemplateName field's value.

func (*EventDescription) SetVersionLabel added in v1.5.0

func (s *EventDescription) SetVersionLabel(v string) *EventDescription

SetVersionLabel sets the VersionLabel field's value.

func (EventDescription) String added in v0.6.5

func (s EventDescription) String() string

String returns the string representation

type Instance

type Instance struct {

	// The ID of the Amazon EC2 instance.
	Id *string `type:"string"`
	// contains filtered or unexported fields
}

The description of an Amazon EC2 instance.

func (Instance) GoString added in v0.6.5

func (s Instance) GoString() string

GoString returns the string representation

func (*Instance) SetId added in v1.5.0

func (s *Instance) SetId(v string) *Instance

SetId sets the Id field's value.

func (Instance) String added in v0.6.5

func (s Instance) String() string

String returns the string representation

type InstanceHealthSummary added in v0.7.4

type InstanceHealthSummary struct {

	// Red. The health agent is reporting a high number of request failures or other
	// issues for an instance or environment.
	Degraded *int64 `type:"integer"`

	// Green. An operation is in progress on an instance.
	Info *int64 `type:"integer"`

	// Grey. AWS Elastic Beanstalk and the health agent are reporting no data on
	// an instance.
	NoData *int64 `type:"integer"`

	// Green. An instance is passing health checks and the health agent is not reporting
	// any problems.
	Ok *int64 `type:"integer"`

	// Grey. An operation is in progress on an instance within the command timeout.
	Pending *int64 `type:"integer"`

	// Red. The health agent is reporting a very high number of request failures
	// or other issues for an instance or environment.
	Severe *int64 `type:"integer"`

	// Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient
	// amount of data on an instance.
	Unknown *int64 `type:"integer"`

	// Yellow. The health agent is reporting a moderate number of request failures
	// or other issues for an instance or environment.
	Warning *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents summary information about the health of an instance. For more information, see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html).

func (InstanceHealthSummary) GoString added in v0.7.4

func (s InstanceHealthSummary) GoString() string

GoString returns the string representation

func (*InstanceHealthSummary) SetDegraded added in v1.5.0

SetDegraded sets the Degraded field's value.

func (*InstanceHealthSummary) SetInfo added in v1.5.0

SetInfo sets the Info field's value.

func (*InstanceHealthSummary) SetNoData added in v1.5.0

SetNoData sets the NoData field's value.

func (*InstanceHealthSummary) SetOk added in v1.5.0

SetOk sets the Ok field's value.

func (*InstanceHealthSummary) SetPending added in v1.5.0

SetPending sets the Pending field's value.

func (*InstanceHealthSummary) SetSevere added in v1.5.0

SetSevere sets the Severe field's value.

func (*InstanceHealthSummary) SetUnknown added in v1.5.0

SetUnknown sets the Unknown field's value.

func (*InstanceHealthSummary) SetWarning added in v1.5.0

SetWarning sets the Warning field's value.

func (InstanceHealthSummary) String added in v0.7.4

func (s InstanceHealthSummary) String() string

String returns the string representation

type Latency added in v0.7.4

type Latency struct {

	// The average latency for the slowest 90 percent of requests over the last
	// 10 seconds.
	P10 *float64 `type:"double"`

	// The average latency for the slowest 50 percent of requests over the last
	// 10 seconds.
	P50 *float64 `type:"double"`

	// The average latency for the slowest 25 percent of requests over the last
	// 10 seconds.
	P75 *float64 `type:"double"`

	// The average latency for the slowest 15 percent of requests over the last
	// 10 seconds.
	P85 *float64 `type:"double"`

	// The average latency for the slowest 10 percent of requests over the last
	// 10 seconds.
	P90 *float64 `type:"double"`

	// The average latency for the slowest 5 percent of requests over the last 10
	// seconds.
	P95 *float64 `type:"double"`

	// The average latency for the slowest 1 percent of requests over the last 10
	// seconds.
	P99 *float64 `type:"double"`

	// The average latency for the slowest 0.1 percent of requests over the last
	// 10 seconds.
	P999 *float64 `type:"double"`
	// contains filtered or unexported fields
}

Represents the average latency for the slowest X percent of requests over the last 10 seconds.

func (Latency) GoString added in v0.7.4

func (s Latency) GoString() string

GoString returns the string representation

func (*Latency) SetP10 added in v1.5.0

func (s *Latency) SetP10(v float64) *Latency

SetP10 sets the P10 field's value.

func (*Latency) SetP50 added in v1.5.0

func (s *Latency) SetP50(v float64) *Latency

SetP50 sets the P50 field's value.

func (*Latency) SetP75 added in v1.5.0

func (s *Latency) SetP75(v float64) *Latency

SetP75 sets the P75 field's value.

func (*Latency) SetP85 added in v1.5.0

func (s *Latency) SetP85(v float64) *Latency

SetP85 sets the P85 field's value.

func (*Latency) SetP90 added in v1.5.0

func (s *Latency) SetP90(v float64) *Latency

SetP90 sets the P90 field's value.

func (*Latency) SetP95 added in v1.5.0

func (s *Latency) SetP95(v float64) *Latency

SetP95 sets the P95 field's value.

func (*Latency) SetP99 added in v1.5.0

func (s *Latency) SetP99(v float64) *Latency

SetP99 sets the P99 field's value.

func (*Latency) SetP999 added in v1.5.0

func (s *Latency) SetP999(v float64) *Latency

SetP999 sets the P999 field's value.

func (Latency) String added in v0.7.4

func (s Latency) String() string

String returns the string representation

type LaunchConfiguration

type LaunchConfiguration struct {

	// The name of the launch configuration.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Describes an Auto Scaling launch configuration.

func (LaunchConfiguration) GoString added in v0.6.5

func (s LaunchConfiguration) GoString() string

GoString returns the string representation

func (*LaunchConfiguration) SetName added in v1.5.0

SetName sets the Name field's value.

func (LaunchConfiguration) String added in v0.6.5

func (s LaunchConfiguration) String() string

String returns the string representation

type LaunchTemplate added in v1.99.0

type LaunchTemplate struct {

	// The ID of the launch template.
	Id *string `type:"string"`
	// contains filtered or unexported fields
}

Describes an Amazon EC2 launch template.

func (LaunchTemplate) GoString added in v1.99.0

func (s LaunchTemplate) GoString() string

GoString returns the string representation

func (*LaunchTemplate) SetId added in v1.99.0

func (s *LaunchTemplate) SetId(v string) *LaunchTemplate

SetId sets the Id field's value.

func (LaunchTemplate) String added in v1.99.0

func (s LaunchTemplate) String() string

String returns the string representation

type ListAvailableSolutionStacksInput

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

func (ListAvailableSolutionStacksInput) GoString added in v0.6.5

GoString returns the string representation

func (ListAvailableSolutionStacksInput) String added in v0.6.5

String returns the string representation

type ListAvailableSolutionStacksOutput

type ListAvailableSolutionStacksOutput struct {

	// A list of available solution stacks and their SolutionStackDescription.
	SolutionStackDetails []*SolutionStackDescription `type:"list"`

	// A list of available solution stacks.
	SolutionStacks []*string `type:"list"`
	// contains filtered or unexported fields
}

A list of available AWS Elastic Beanstalk solution stacks.

func (ListAvailableSolutionStacksOutput) GoString added in v0.6.5

GoString returns the string representation

func (*ListAvailableSolutionStacksOutput) SetSolutionStackDetails added in v1.5.0

SetSolutionStackDetails sets the SolutionStackDetails field's value.

func (*ListAvailableSolutionStacksOutput) SetSolutionStacks added in v1.5.0

SetSolutionStacks sets the SolutionStacks field's value.

func (ListAvailableSolutionStacksOutput) String added in v0.6.5

String returns the string representation

type ListPlatformVersionsInput added in v1.6.27

type ListPlatformVersionsInput struct {

	// List only the platforms where the platform member value relates to one of
	// the supplied values.
	Filters []*PlatformFilter `type:"list"`

	// The maximum number of platform values returned in one call.
	MaxRecords *int64 `min:"1" type:"integer"`

	// The starting index into the remaining list of platforms. Use the NextToken
	// value from a previous ListPlatformVersion call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListPlatformVersionsInput) GoString added in v1.6.27

func (s ListPlatformVersionsInput) GoString() string

GoString returns the string representation

func (*ListPlatformVersionsInput) SetFilters added in v1.6.27

SetFilters sets the Filters field's value.

func (*ListPlatformVersionsInput) SetMaxRecords added in v1.6.27

SetMaxRecords sets the MaxRecords field's value.

func (*ListPlatformVersionsInput) SetNextToken added in v1.6.27

SetNextToken sets the NextToken field's value.

func (ListPlatformVersionsInput) String added in v1.6.27

func (s ListPlatformVersionsInput) String() string

String returns the string representation

func (*ListPlatformVersionsInput) Validate added in v1.6.27

func (s *ListPlatformVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPlatformVersionsOutput added in v1.6.27

type ListPlatformVersionsOutput struct {

	// The starting index into the remaining list of platforms. if this value is
	// not null, you can use it in a subsequent ListPlatformVersion call.
	NextToken *string `type:"string"`

	// Detailed information about the platforms.
	PlatformSummaryList []*PlatformSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListPlatformVersionsOutput) GoString added in v1.6.27

func (s ListPlatformVersionsOutput) GoString() string

GoString returns the string representation

func (*ListPlatformVersionsOutput) SetNextToken added in v1.6.27

SetNextToken sets the NextToken field's value.

func (*ListPlatformVersionsOutput) SetPlatformSummaryList added in v1.6.27

SetPlatformSummaryList sets the PlatformSummaryList field's value.

func (ListPlatformVersionsOutput) String added in v1.6.27

String returns the string representation

type ListTagsForResourceInput added in v1.12.10

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.
	//
	// Must be the ARN of an Elastic Beanstalk environment.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.12.10

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn added in v1.12.10

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.12.10

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.12.10

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.12.10

type ListTagsForResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resouce for which a tag list was requested.
	ResourceArn *string `type:"string"`

	// A list of tag key-value pairs.
	ResourceTags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.12.10

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetResourceArn added in v1.12.10

SetResourceArn sets the ResourceArn field's value.

func (*ListTagsForResourceOutput) SetResourceTags added in v1.12.10

func (s *ListTagsForResourceOutput) SetResourceTags(v []*Tag) *ListTagsForResourceOutput

SetResourceTags sets the ResourceTags field's value.

func (ListTagsForResourceOutput) String added in v1.12.10

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type Listener

type Listener struct {

	// The port that is used by the Listener.
	Port *int64 `type:"integer"`

	// The protocol that is used by the Listener.
	Protocol *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the properties of a Listener for the LoadBalancer.

func (Listener) GoString added in v0.6.5

func (s Listener) GoString() string

GoString returns the string representation

func (*Listener) SetPort added in v1.5.0

func (s *Listener) SetPort(v int64) *Listener

SetPort sets the Port field's value.

func (*Listener) SetProtocol added in v1.5.0

func (s *Listener) SetProtocol(v string) *Listener

SetProtocol sets the Protocol field's value.

func (Listener) String added in v0.6.5

func (s Listener) String() string

String returns the string representation

type LoadBalancer

type LoadBalancer struct {

	// The name of the LoadBalancer.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a LoadBalancer.

func (LoadBalancer) GoString added in v0.6.5

func (s LoadBalancer) GoString() string

GoString returns the string representation

func (*LoadBalancer) SetName added in v1.5.0

func (s *LoadBalancer) SetName(v string) *LoadBalancer

SetName sets the Name field's value.

func (LoadBalancer) String added in v0.6.5

func (s LoadBalancer) String() string

String returns the string representation

type LoadBalancerDescription

type LoadBalancerDescription struct {

	// The domain name of the LoadBalancer.
	Domain *string `type:"string"`

	// A list of Listeners used by the LoadBalancer.
	Listeners []*Listener `type:"list"`

	// The name of the LoadBalancer.
	LoadBalancerName *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the details of a LoadBalancer.

func (LoadBalancerDescription) GoString added in v0.6.5

func (s LoadBalancerDescription) GoString() string

GoString returns the string representation

func (*LoadBalancerDescription) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*LoadBalancerDescription) SetListeners added in v1.5.0

SetListeners sets the Listeners field's value.

func (*LoadBalancerDescription) SetLoadBalancerName added in v1.5.0

func (s *LoadBalancerDescription) SetLoadBalancerName(v string) *LoadBalancerDescription

SetLoadBalancerName sets the LoadBalancerName field's value.

func (LoadBalancerDescription) String added in v0.6.5

func (s LoadBalancerDescription) String() string

String returns the string representation

type ManagedAction added in v1.1.19

type ManagedAction struct {

	// A description of the managed action.
	ActionDescription *string `type:"string"`

	// A unique identifier for the managed action.
	ActionId *string `type:"string"`

	// The type of managed action.
	ActionType *string `type:"string" enum:"ActionType"`

	// The status of the managed action. If the action is Scheduled, you can apply
	// it immediately with ApplyEnvironmentManagedAction.
	Status *string `type:"string" enum:"ActionStatus"`

	// The start time of the maintenance window in which the managed action will
	// execute.
	WindowStartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The record of an upcoming or in-progress managed action.

func (ManagedAction) GoString added in v1.1.19

func (s ManagedAction) GoString() string

GoString returns the string representation

func (*ManagedAction) SetActionDescription added in v1.5.0

func (s *ManagedAction) SetActionDescription(v string) *ManagedAction

SetActionDescription sets the ActionDescription field's value.

func (*ManagedAction) SetActionId added in v1.5.0

func (s *ManagedAction) SetActionId(v string) *ManagedAction

SetActionId sets the ActionId field's value.

func (*ManagedAction) SetActionType added in v1.5.0

func (s *ManagedAction) SetActionType(v string) *ManagedAction

SetActionType sets the ActionType field's value.

func (*ManagedAction) SetStatus added in v1.5.0

func (s *ManagedAction) SetStatus(v string) *ManagedAction

SetStatus sets the Status field's value.

func (*ManagedAction) SetWindowStartTime added in v1.5.0

func (s *ManagedAction) SetWindowStartTime(v time.Time) *ManagedAction

SetWindowStartTime sets the WindowStartTime field's value.

func (ManagedAction) String added in v1.1.19

func (s ManagedAction) String() string

String returns the string representation

type ManagedActionHistoryItem added in v1.1.19

type ManagedActionHistoryItem struct {

	// A description of the managed action.
	ActionDescription *string `type:"string"`

	// A unique identifier for the managed action.
	ActionId *string `type:"string"`

	// The type of the managed action.
	ActionType *string `type:"string" enum:"ActionType"`

	// The date and time that the action started executing.
	ExecutedTime *time.Time `type:"timestamp"`

	// If the action failed, a description of the failure.
	FailureDescription *string `type:"string"`

	// If the action failed, the type of failure.
	FailureType *string `type:"string" enum:"FailureType"`

	// The date and time that the action finished executing.
	FinishedTime *time.Time `type:"timestamp"`

	// The status of the action.
	Status *string `type:"string" enum:"ActionHistoryStatus"`
	// contains filtered or unexported fields
}

The record of a completed or failed managed action.

func (ManagedActionHistoryItem) GoString added in v1.1.19

func (s ManagedActionHistoryItem) GoString() string

GoString returns the string representation

func (*ManagedActionHistoryItem) SetActionDescription added in v1.5.0

func (s *ManagedActionHistoryItem) SetActionDescription(v string) *ManagedActionHistoryItem

SetActionDescription sets the ActionDescription field's value.

func (*ManagedActionHistoryItem) SetActionId added in v1.5.0

SetActionId sets the ActionId field's value.

func (*ManagedActionHistoryItem) SetActionType added in v1.5.0

SetActionType sets the ActionType field's value.

func (*ManagedActionHistoryItem) SetExecutedTime added in v1.5.0

SetExecutedTime sets the ExecutedTime field's value.

func (*ManagedActionHistoryItem) SetFailureDescription added in v1.5.0

func (s *ManagedActionHistoryItem) SetFailureDescription(v string) *ManagedActionHistoryItem

SetFailureDescription sets the FailureDescription field's value.

func (*ManagedActionHistoryItem) SetFailureType added in v1.5.0

SetFailureType sets the FailureType field's value.

func (*ManagedActionHistoryItem) SetFinishedTime added in v1.5.0

SetFinishedTime sets the FinishedTime field's value.

func (*ManagedActionHistoryItem) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (ManagedActionHistoryItem) String added in v1.1.19

func (s ManagedActionHistoryItem) String() string

String returns the string representation

type MaxAgeRule added in v1.6.8

type MaxAgeRule struct {

	// Set to true to delete a version's source bundle from Amazon S3 when Elastic
	// Beanstalk deletes the application version.
	DeleteSourceFromS3 *bool `type:"boolean"`

	// Specify true to apply the rule, or false to disable it.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`

	// Specify the number of days to retain an application versions.
	MaxAgeInDays *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A lifecycle rule that deletes application versions after the specified number of days.

func (MaxAgeRule) GoString added in v1.6.8

func (s MaxAgeRule) GoString() string

GoString returns the string representation

func (*MaxAgeRule) SetDeleteSourceFromS3 added in v1.6.8

func (s *MaxAgeRule) SetDeleteSourceFromS3(v bool) *MaxAgeRule

SetDeleteSourceFromS3 sets the DeleteSourceFromS3 field's value.

func (*MaxAgeRule) SetEnabled added in v1.6.8

func (s *MaxAgeRule) SetEnabled(v bool) *MaxAgeRule

SetEnabled sets the Enabled field's value.

func (*MaxAgeRule) SetMaxAgeInDays added in v1.6.8

func (s *MaxAgeRule) SetMaxAgeInDays(v int64) *MaxAgeRule

SetMaxAgeInDays sets the MaxAgeInDays field's value.

func (MaxAgeRule) String added in v1.6.8

func (s MaxAgeRule) String() string

String returns the string representation

func (*MaxAgeRule) Validate added in v1.6.8

func (s *MaxAgeRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MaxCountRule added in v1.6.8

type MaxCountRule struct {

	// Set to true to delete a version's source bundle from Amazon S3 when Elastic
	// Beanstalk deletes the application version.
	DeleteSourceFromS3 *bool `type:"boolean"`

	// Specify true to apply the rule, or false to disable it.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`

	// Specify the maximum number of application versions to retain.
	MaxCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.

func (MaxCountRule) GoString added in v1.6.8

func (s MaxCountRule) GoString() string

GoString returns the string representation

func (*MaxCountRule) SetDeleteSourceFromS3 added in v1.6.8

func (s *MaxCountRule) SetDeleteSourceFromS3(v bool) *MaxCountRule

SetDeleteSourceFromS3 sets the DeleteSourceFromS3 field's value.

func (*MaxCountRule) SetEnabled added in v1.6.8

func (s *MaxCountRule) SetEnabled(v bool) *MaxCountRule

SetEnabled sets the Enabled field's value.

func (*MaxCountRule) SetMaxCount added in v1.6.8

func (s *MaxCountRule) SetMaxCount(v int64) *MaxCountRule

SetMaxCount sets the MaxCount field's value.

func (MaxCountRule) String added in v1.6.8

func (s MaxCountRule) String() string

String returns the string representation

func (*MaxCountRule) Validate added in v1.6.8

func (s *MaxCountRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OptionRestrictionRegex

type OptionRestrictionRegex struct {

	// A unique name representing this regular expression.
	Label *string `type:"string"`

	// The regular expression pattern that a string configuration option value with
	// this restriction must match.
	Pattern *string `type:"string"`
	// contains filtered or unexported fields
}

A regular expression representing a restriction on a string configuration option value.

func (OptionRestrictionRegex) GoString added in v0.6.5

func (s OptionRestrictionRegex) GoString() string

GoString returns the string representation

func (*OptionRestrictionRegex) SetLabel added in v1.5.0

SetLabel sets the Label field's value.

func (*OptionRestrictionRegex) SetPattern added in v1.5.0

SetPattern sets the Pattern field's value.

func (OptionRestrictionRegex) String added in v0.6.5

func (s OptionRestrictionRegex) String() string

String returns the string representation

type OptionSpecification

type OptionSpecification struct {

	// A unique namespace identifying the option's associated AWS resource.
	Namespace *string `type:"string"`

	// The name of the configuration option.
	OptionName *string `type:"string"`

	// A unique resource name for a time-based scaling configuration option.
	ResourceName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A specification identifying an individual configuration option.

func (OptionSpecification) GoString added in v0.6.5

func (s OptionSpecification) GoString() string

GoString returns the string representation

func (*OptionSpecification) SetNamespace added in v1.5.0

func (s *OptionSpecification) SetNamespace(v string) *OptionSpecification

SetNamespace sets the Namespace field's value.

func (*OptionSpecification) SetOptionName added in v1.5.0

func (s *OptionSpecification) SetOptionName(v string) *OptionSpecification

SetOptionName sets the OptionName field's value.

func (*OptionSpecification) SetResourceName added in v1.5.0

func (s *OptionSpecification) SetResourceName(v string) *OptionSpecification

SetResourceName sets the ResourceName field's value.

func (OptionSpecification) String added in v0.6.5

func (s OptionSpecification) String() string

String returns the string representation

func (*OptionSpecification) Validate added in v1.1.21

func (s *OptionSpecification) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PlatformDescription added in v1.6.27

type PlatformDescription struct {

	// The custom AMIs supported by the platform.
	CustomAmiList []*CustomAmi `type:"list"`

	// The date when the platform was created.
	DateCreated *time.Time `type:"timestamp"`

	// The date when the platform was last updated.
	DateUpdated *time.Time `type:"timestamp"`

	// The description of the platform.
	Description *string `type:"string"`

	// The frameworks supported by the platform.
	Frameworks []*PlatformFramework `type:"list"`

	// Information about the maintainer of the platform.
	Maintainer *string `type:"string"`

	// The operating system used by the platform.
	OperatingSystemName *string `type:"string"`

	// The version of the operating system used by the platform.
	OperatingSystemVersion *string `type:"string"`

	// The ARN of the platform.
	PlatformArn *string `type:"string"`

	// The category of the platform.
	PlatformCategory *string `type:"string"`

	// The name of the platform.
	PlatformName *string `type:"string"`

	// The AWS account ID of the person who created the platform.
	PlatformOwner *string `type:"string"`

	// The status of the platform.
	PlatformStatus *string `type:"string" enum:"PlatformStatus"`

	// The version of the platform.
	PlatformVersion *string `type:"string"`

	// The programming languages supported by the platform.
	ProgrammingLanguages []*PlatformProgrammingLanguage `type:"list"`

	// The name of the solution stack used by the platform.
	SolutionStackName *string `type:"string"`

	// The additions supported by the platform.
	SupportedAddonList []*string `type:"list"`

	// The tiers supported by the platform.
	SupportedTierList []*string `type:"list"`
	// contains filtered or unexported fields
}

Detailed information about a platform.

func (PlatformDescription) GoString added in v1.6.27

func (s PlatformDescription) GoString() string

GoString returns the string representation

func (*PlatformDescription) SetCustomAmiList added in v1.6.27

func (s *PlatformDescription) SetCustomAmiList(v []*CustomAmi) *PlatformDescription

SetCustomAmiList sets the CustomAmiList field's value.

func (*PlatformDescription) SetDateCreated added in v1.6.27

func (s *PlatformDescription) SetDateCreated(v time.Time) *PlatformDescription

SetDateCreated sets the DateCreated field's value.

func (*PlatformDescription) SetDateUpdated added in v1.6.27

func (s *PlatformDescription) SetDateUpdated(v time.Time) *PlatformDescription

SetDateUpdated sets the DateUpdated field's value.

func (*PlatformDescription) SetDescription added in v1.6.27

func (s *PlatformDescription) SetDescription(v string) *PlatformDescription

SetDescription sets the Description field's value.

func (*PlatformDescription) SetFrameworks added in v1.6.27

SetFrameworks sets the Frameworks field's value.

func (*PlatformDescription) SetMaintainer added in v1.6.27

func (s *PlatformDescription) SetMaintainer(v string) *PlatformDescription

SetMaintainer sets the Maintainer field's value.

func (*PlatformDescription) SetOperatingSystemName added in v1.6.27

func (s *PlatformDescription) SetOperatingSystemName(v string) *PlatformDescription

SetOperatingSystemName sets the OperatingSystemName field's value.

func (*PlatformDescription) SetOperatingSystemVersion added in v1.6.27

func (s *PlatformDescription) SetOperatingSystemVersion(v string) *PlatformDescription

SetOperatingSystemVersion sets the OperatingSystemVersion field's value.

func (*PlatformDescription) SetPlatformArn added in v1.6.27

func (s *PlatformDescription) SetPlatformArn(v string) *PlatformDescription

SetPlatformArn sets the PlatformArn field's value.

func (*PlatformDescription) SetPlatformCategory added in v1.6.27

func (s *PlatformDescription) SetPlatformCategory(v string) *PlatformDescription

SetPlatformCategory sets the PlatformCategory field's value.

func (*PlatformDescription) SetPlatformName added in v1.6.27

func (s *PlatformDescription) SetPlatformName(v string) *PlatformDescription

SetPlatformName sets the PlatformName field's value.

func (*PlatformDescription) SetPlatformOwner added in v1.6.27

func (s *PlatformDescription) SetPlatformOwner(v string) *PlatformDescription

SetPlatformOwner sets the PlatformOwner field's value.

func (*PlatformDescription) SetPlatformStatus added in v1.6.27

func (s *PlatformDescription) SetPlatformStatus(v string) *PlatformDescription

SetPlatformStatus sets the PlatformStatus field's value.

func (*PlatformDescription) SetPlatformVersion added in v1.6.27

func (s *PlatformDescription) SetPlatformVersion(v string) *PlatformDescription

SetPlatformVersion sets the PlatformVersion field's value.

func (*PlatformDescription) SetProgrammingLanguages added in v1.6.27

func (s *PlatformDescription) SetProgrammingLanguages(v []*PlatformProgrammingLanguage) *PlatformDescription

SetProgrammingLanguages sets the ProgrammingLanguages field's value.

func (*PlatformDescription) SetSolutionStackName added in v1.6.27

func (s *PlatformDescription) SetSolutionStackName(v string) *PlatformDescription

SetSolutionStackName sets the SolutionStackName field's value.

func (*PlatformDescription) SetSupportedAddonList added in v1.6.27

func (s *PlatformDescription) SetSupportedAddonList(v []*string) *PlatformDescription

SetSupportedAddonList sets the SupportedAddonList field's value.

func (*PlatformDescription) SetSupportedTierList added in v1.6.27

func (s *PlatformDescription) SetSupportedTierList(v []*string) *PlatformDescription

SetSupportedTierList sets the SupportedTierList field's value.

func (PlatformDescription) String added in v1.6.27

func (s PlatformDescription) String() string

String returns the string representation

type PlatformFilter added in v1.6.27

type PlatformFilter struct {

	// The operator to apply to the Type with each of the Values.
	//
	// Valid Values: = (equal to) | != (not equal to) | < (less than) | <= (less
	// than or equal to) | > (greater than) | >= (greater than or equal to) | contains
	// | begins_with | ends_with
	Operator *string `type:"string"`

	// The custom platform attribute to which the filter values are applied.
	//
	// Valid Values: PlatformName | PlatformVersion | PlatformStatus | PlatformOwner
	Type *string `type:"string"`

	// The list of values applied to the custom platform attribute.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Specify criteria to restrict the results when listing custom platforms.

The filter is evaluated as the expression:

Type Operator Values[i]

func (PlatformFilter) GoString added in v1.6.27

func (s PlatformFilter) GoString() string

GoString returns the string representation

func (*PlatformFilter) SetOperator added in v1.6.27

func (s *PlatformFilter) SetOperator(v string) *PlatformFilter

SetOperator sets the Operator field's value.

func (*PlatformFilter) SetType added in v1.6.27

func (s *PlatformFilter) SetType(v string) *PlatformFilter

SetType sets the Type field's value.

func (*PlatformFilter) SetValues added in v1.6.27

func (s *PlatformFilter) SetValues(v []*string) *PlatformFilter

SetValues sets the Values field's value.

func (PlatformFilter) String added in v1.6.27

func (s PlatformFilter) String() string

String returns the string representation

type PlatformFramework added in v1.6.27

type PlatformFramework struct {

	// The name of the framework.
	Name *string `type:"string"`

	// The version of the framework.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

A framework supported by the custom platform.

func (PlatformFramework) GoString added in v1.6.27

func (s PlatformFramework) GoString() string

GoString returns the string representation

func (*PlatformFramework) SetName added in v1.6.27

SetName sets the Name field's value.

func (*PlatformFramework) SetVersion added in v1.6.27

func (s *PlatformFramework) SetVersion(v string) *PlatformFramework

SetVersion sets the Version field's value.

func (PlatformFramework) String added in v1.6.27

func (s PlatformFramework) String() string

String returns the string representation

type PlatformProgrammingLanguage added in v1.6.27

type PlatformProgrammingLanguage struct {

	// The name of the programming language.
	Name *string `type:"string"`

	// The version of the programming language.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

A programming language supported by the platform.

func (PlatformProgrammingLanguage) GoString added in v1.6.27

func (s PlatformProgrammingLanguage) GoString() string

GoString returns the string representation

func (*PlatformProgrammingLanguage) SetName added in v1.6.27

SetName sets the Name field's value.

func (*PlatformProgrammingLanguage) SetVersion added in v1.6.27

SetVersion sets the Version field's value.

func (PlatformProgrammingLanguage) String added in v1.6.27

String returns the string representation

type PlatformSummary added in v1.6.27

type PlatformSummary struct {

	// The operating system used by the platform.
	OperatingSystemName *string `type:"string"`

	// The version of the operating system used by the platform.
	OperatingSystemVersion *string `type:"string"`

	// The ARN of the platform.
	PlatformArn *string `type:"string"`

	// The category of platform.
	PlatformCategory *string `type:"string"`

	// The AWS account ID of the person who created the platform.
	PlatformOwner *string `type:"string"`

	// The status of the platform. You can create an environment from the platform
	// once it is ready.
	PlatformStatus *string `type:"string" enum:"PlatformStatus"`

	// The additions associated with the platform.
	SupportedAddonList []*string `type:"list"`

	// The tiers in which the platform runs.
	SupportedTierList []*string `type:"list"`
	// contains filtered or unexported fields
}

Detailed information about a platform.

func (PlatformSummary) GoString added in v1.6.27

func (s PlatformSummary) GoString() string

GoString returns the string representation

func (*PlatformSummary) SetOperatingSystemName added in v1.6.27

func (s *PlatformSummary) SetOperatingSystemName(v string) *PlatformSummary

SetOperatingSystemName sets the OperatingSystemName field's value.

func (*PlatformSummary) SetOperatingSystemVersion added in v1.6.27

func (s *PlatformSummary) SetOperatingSystemVersion(v string) *PlatformSummary

SetOperatingSystemVersion sets the OperatingSystemVersion field's value.

func (*PlatformSummary) SetPlatformArn added in v1.6.27

func (s *PlatformSummary) SetPlatformArn(v string) *PlatformSummary

SetPlatformArn sets the PlatformArn field's value.

func (*PlatformSummary) SetPlatformCategory added in v1.6.27

func (s *PlatformSummary) SetPlatformCategory(v string) *PlatformSummary

SetPlatformCategory sets the PlatformCategory field's value.

func (*PlatformSummary) SetPlatformOwner added in v1.6.27

func (s *PlatformSummary) SetPlatformOwner(v string) *PlatformSummary

SetPlatformOwner sets the PlatformOwner field's value.

func (*PlatformSummary) SetPlatformStatus added in v1.6.27

func (s *PlatformSummary) SetPlatformStatus(v string) *PlatformSummary

SetPlatformStatus sets the PlatformStatus field's value.

func (*PlatformSummary) SetSupportedAddonList added in v1.6.27

func (s *PlatformSummary) SetSupportedAddonList(v []*string) *PlatformSummary

SetSupportedAddonList sets the SupportedAddonList field's value.

func (*PlatformSummary) SetSupportedTierList added in v1.6.27

func (s *PlatformSummary) SetSupportedTierList(v []*string) *PlatformSummary

SetSupportedTierList sets the SupportedTierList field's value.

func (PlatformSummary) String added in v1.6.27

func (s PlatformSummary) String() string

String returns the string representation

type Queue

type Queue struct {

	// The name of the queue.
	Name *string `type:"string"`

	// The URL of the queue.
	URL *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a queue.

func (Queue) GoString added in v0.6.5

func (s Queue) GoString() string

GoString returns the string representation

func (*Queue) SetName added in v1.5.0

func (s *Queue) SetName(v string) *Queue

SetName sets the Name field's value.

func (*Queue) SetURL added in v1.5.0

func (s *Queue) SetURL(v string) *Queue

SetURL sets the URL field's value.

func (Queue) String added in v0.6.5

func (s Queue) String() string

String returns the string representation

type RebuildEnvironmentInput

type RebuildEnvironmentInput struct {

	// The ID of the environment to rebuild.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string `type:"string"`

	// The name of the environment to rebuild.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (RebuildEnvironmentInput) GoString added in v0.6.5

func (s RebuildEnvironmentInput) GoString() string

GoString returns the string representation

func (*RebuildEnvironmentInput) SetEnvironmentId added in v1.5.0

func (s *RebuildEnvironmentInput) SetEnvironmentId(v string) *RebuildEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*RebuildEnvironmentInput) SetEnvironmentName added in v1.5.0

func (s *RebuildEnvironmentInput) SetEnvironmentName(v string) *RebuildEnvironmentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (RebuildEnvironmentInput) String added in v0.6.5

func (s RebuildEnvironmentInput) String() string

String returns the string representation

func (*RebuildEnvironmentInput) Validate added in v1.1.21

func (s *RebuildEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RebuildEnvironmentOutput

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

func (RebuildEnvironmentOutput) GoString added in v0.6.5

func (s RebuildEnvironmentOutput) GoString() string

GoString returns the string representation

func (RebuildEnvironmentOutput) String added in v0.6.5

func (s RebuildEnvironmentOutput) String() string

String returns the string representation

type RequestEnvironmentInfoInput

type RequestEnvironmentInfoInput struct {

	// The ID of the environment of the requested data.
	//
	// If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue
	// error.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string `type:"string"`

	// The name of the environment of the requested data.
	//
	// If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue
	// error.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string `min:"4" type:"string"`

	// The type of information to request.
	//
	// InfoType is a required field
	InfoType *string `type:"string" required:"true" enum:"EnvironmentInfoType"`
	// contains filtered or unexported fields
}

Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.

func (RequestEnvironmentInfoInput) GoString added in v0.6.5

func (s RequestEnvironmentInfoInput) GoString() string

GoString returns the string representation

func (*RequestEnvironmentInfoInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*RequestEnvironmentInfoInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*RequestEnvironmentInfoInput) SetInfoType added in v1.5.0

SetInfoType sets the InfoType field's value.

func (RequestEnvironmentInfoInput) String added in v0.6.5

String returns the string representation

func (*RequestEnvironmentInfoInput) Validate added in v1.1.21

func (s *RequestEnvironmentInfoInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RequestEnvironmentInfoOutput

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

func (RequestEnvironmentInfoOutput) GoString added in v0.6.5

func (s RequestEnvironmentInfoOutput) GoString() string

GoString returns the string representation

func (RequestEnvironmentInfoOutput) String added in v0.6.5

String returns the string representation

type ResourceQuota added in v1.13.16

type ResourceQuota struct {

	// The maximum number of instances of this Elastic Beanstalk resource type that
	// an AWS account can use.
	Maximum *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The AWS Elastic Beanstalk quota information for a single resource type in an AWS account. It reflects the resource's limits for this account.

func (ResourceQuota) GoString added in v1.13.16

func (s ResourceQuota) GoString() string

GoString returns the string representation

func (*ResourceQuota) SetMaximum added in v1.13.16

func (s *ResourceQuota) SetMaximum(v int64) *ResourceQuota

SetMaximum sets the Maximum field's value.

func (ResourceQuota) String added in v1.13.16

func (s ResourceQuota) String() string

String returns the string representation

type ResourceQuotas added in v1.13.16

type ResourceQuotas struct {

	// The quota for applications in the AWS account.
	ApplicationQuota *ResourceQuota `type:"structure"`

	// The quota for application versions in the AWS account.
	ApplicationVersionQuota *ResourceQuota `type:"structure"`

	// The quota for configuration templates in the AWS account.
	ConfigurationTemplateQuota *ResourceQuota `type:"structure"`

	// The quota for custom platforms in the AWS account.
	CustomPlatformQuota *ResourceQuota `type:"structure"`

	// The quota for environments in the AWS account.
	EnvironmentQuota *ResourceQuota `type:"structure"`
	// contains filtered or unexported fields
}

A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account. They reflect Elastic Beanstalk resource limits for this account.

func (ResourceQuotas) GoString added in v1.13.16

func (s ResourceQuotas) GoString() string

GoString returns the string representation

func (*ResourceQuotas) SetApplicationQuota added in v1.13.16

func (s *ResourceQuotas) SetApplicationQuota(v *ResourceQuota) *ResourceQuotas

SetApplicationQuota sets the ApplicationQuota field's value.

func (*ResourceQuotas) SetApplicationVersionQuota added in v1.13.16

func (s *ResourceQuotas) SetApplicationVersionQuota(v *ResourceQuota) *ResourceQuotas

SetApplicationVersionQuota sets the ApplicationVersionQuota field's value.

func (*ResourceQuotas) SetConfigurationTemplateQuota added in v1.13.16

func (s *ResourceQuotas) SetConfigurationTemplateQuota(v *ResourceQuota) *ResourceQuotas

SetConfigurationTemplateQuota sets the ConfigurationTemplateQuota field's value.

func (*ResourceQuotas) SetCustomPlatformQuota added in v1.13.16

func (s *ResourceQuotas) SetCustomPlatformQuota(v *ResourceQuota) *ResourceQuotas

SetCustomPlatformQuota sets the CustomPlatformQuota field's value.

func (*ResourceQuotas) SetEnvironmentQuota added in v1.13.16

func (s *ResourceQuotas) SetEnvironmentQuota(v *ResourceQuota) *ResourceQuotas

SetEnvironmentQuota sets the EnvironmentQuota field's value.

func (ResourceQuotas) String added in v1.13.16

func (s ResourceQuotas) String() string

String returns the string representation

type RestartAppServerInput

type RestartAppServerInput struct {

	// The ID of the environment to restart the server for.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string `type:"string"`

	// The name of the environment to restart the server for.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (RestartAppServerInput) GoString added in v0.6.5

func (s RestartAppServerInput) GoString() string

GoString returns the string representation

func (*RestartAppServerInput) SetEnvironmentId added in v1.5.0

func (s *RestartAppServerInput) SetEnvironmentId(v string) *RestartAppServerInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*RestartAppServerInput) SetEnvironmentName added in v1.5.0

func (s *RestartAppServerInput) SetEnvironmentName(v string) *RestartAppServerInput

SetEnvironmentName sets the EnvironmentName field's value.

func (RestartAppServerInput) String added in v0.6.5

func (s RestartAppServerInput) String() string

String returns the string representation

func (*RestartAppServerInput) Validate added in v1.1.21

func (s *RestartAppServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestartAppServerOutput

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

func (RestartAppServerOutput) GoString added in v0.6.5

func (s RestartAppServerOutput) GoString() string

GoString returns the string representation

func (RestartAppServerOutput) String added in v0.6.5

func (s RestartAppServerOutput) String() string

String returns the string representation

type RetrieveEnvironmentInfoInput

type RetrieveEnvironmentInfoInput struct {

	// The ID of the data's environment.
	//
	// If no such environment is found, returns an InvalidParameterValue error.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string `type:"string"`

	// The name of the data's environment.
	//
	// If no such environment is found, returns an InvalidParameterValue error.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string `min:"4" type:"string"`

	// The type of information to retrieve.
	//
	// InfoType is a required field
	InfoType *string `type:"string" required:"true" enum:"EnvironmentInfoType"`
	// contains filtered or unexported fields
}

Request to download logs retrieved with RequestEnvironmentInfo.

func (RetrieveEnvironmentInfoInput) GoString added in v0.6.5

func (s RetrieveEnvironmentInfoInput) GoString() string

GoString returns the string representation

func (*RetrieveEnvironmentInfoInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*RetrieveEnvironmentInfoInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*RetrieveEnvironmentInfoInput) SetInfoType added in v1.5.0

SetInfoType sets the InfoType field's value.

func (RetrieveEnvironmentInfoInput) String added in v0.6.5

String returns the string representation

func (*RetrieveEnvironmentInfoInput) Validate added in v1.1.21

func (s *RetrieveEnvironmentInfoInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetrieveEnvironmentInfoOutput

type RetrieveEnvironmentInfoOutput struct {

	// The EnvironmentInfoDescription of the environment.
	EnvironmentInfo []*EnvironmentInfoDescription `type:"list"`
	// contains filtered or unexported fields
}

Result message containing a description of the requested environment info.

func (RetrieveEnvironmentInfoOutput) GoString added in v0.6.5

GoString returns the string representation

func (*RetrieveEnvironmentInfoOutput) SetEnvironmentInfo added in v1.5.0

SetEnvironmentInfo sets the EnvironmentInfo field's value.

func (RetrieveEnvironmentInfoOutput) String added in v0.6.5

String returns the string representation

type S3Location

type S3Location struct {

	// The Amazon S3 bucket where the data is located.
	S3Bucket *string `type:"string"`

	// The Amazon S3 key where the data is located.
	S3Key *string `type:"string"`
	// contains filtered or unexported fields
}

The bucket and key of an item stored in Amazon S3.

func (S3Location) GoString added in v0.6.5

func (s S3Location) GoString() string

GoString returns the string representation

func (*S3Location) SetS3Bucket added in v1.5.0

func (s *S3Location) SetS3Bucket(v string) *S3Location

SetS3Bucket sets the S3Bucket field's value.

func (*S3Location) SetS3Key added in v1.5.0

func (s *S3Location) SetS3Key(v string) *S3Location

SetS3Key sets the S3Key field's value.

func (S3Location) String added in v0.6.5

func (s S3Location) String() string

String returns the string representation

type SingleInstanceHealth added in v0.7.4

type SingleInstanceHealth struct {

	// Request metrics from your application.
	ApplicationMetrics *ApplicationMetrics `type:"structure"`

	// The availability zone in which the instance runs.
	AvailabilityZone *string `type:"string"`

	// Represents the causes, which provide more information about the current health
	// status.
	Causes []*string `type:"list"`

	// Represents the color indicator that gives you information about the health
	// of the EC2 instance. For more information, see Health Colors and Statuses
	// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html).
	Color *string `type:"string"`

	// Information about the most recent deployment to an instance.
	Deployment *Deployment `type:"structure"`

	// Returns the health status of the specified instance. For more information,
	// see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html).
	HealthStatus *string `type:"string"`

	// The ID of the Amazon EC2 instance.
	InstanceId *string `min:"1" type:"string"`

	// The instance's type.
	InstanceType *string `type:"string"`

	// The time at which the EC2 instance was launched.
	LaunchedAt *time.Time `type:"timestamp"`

	// Operating system metrics from the instance.
	System *SystemStatus `type:"structure"`
	// contains filtered or unexported fields
}

Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.

func (SingleInstanceHealth) GoString added in v0.7.4

func (s SingleInstanceHealth) GoString() string

GoString returns the string representation

func (*SingleInstanceHealth) SetApplicationMetrics added in v1.5.0

func (s *SingleInstanceHealth) SetApplicationMetrics(v *ApplicationMetrics) *SingleInstanceHealth

SetApplicationMetrics sets the ApplicationMetrics field's value.

func (*SingleInstanceHealth) SetAvailabilityZone added in v1.5.0

func (s *SingleInstanceHealth) SetAvailabilityZone(v string) *SingleInstanceHealth

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*SingleInstanceHealth) SetCauses added in v1.5.0

func (s *SingleInstanceHealth) SetCauses(v []*string) *SingleInstanceHealth

SetCauses sets the Causes field's value.

func (*SingleInstanceHealth) SetColor added in v1.5.0

SetColor sets the Color field's value.

func (*SingleInstanceHealth) SetDeployment added in v1.5.0

SetDeployment sets the Deployment field's value.

func (*SingleInstanceHealth) SetHealthStatus added in v1.5.0

func (s *SingleInstanceHealth) SetHealthStatus(v string) *SingleInstanceHealth

SetHealthStatus sets the HealthStatus field's value.

func (*SingleInstanceHealth) SetInstanceId added in v1.5.0

func (s *SingleInstanceHealth) SetInstanceId(v string) *SingleInstanceHealth

SetInstanceId sets the InstanceId field's value.

func (*SingleInstanceHealth) SetInstanceType added in v1.5.0

func (s *SingleInstanceHealth) SetInstanceType(v string) *SingleInstanceHealth

SetInstanceType sets the InstanceType field's value.

func (*SingleInstanceHealth) SetLaunchedAt added in v1.5.0

func (s *SingleInstanceHealth) SetLaunchedAt(v time.Time) *SingleInstanceHealth

SetLaunchedAt sets the LaunchedAt field's value.

func (*SingleInstanceHealth) SetSystem added in v1.5.0

SetSystem sets the System field's value.

func (SingleInstanceHealth) String added in v0.7.4

func (s SingleInstanceHealth) String() string

String returns the string representation

type SolutionStackDescription

type SolutionStackDescription struct {

	// The permitted file types allowed for a solution stack.
	PermittedFileTypes []*string `type:"list"`

	// The name of the solution stack.
	SolutionStackName *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the solution stack.

func (SolutionStackDescription) GoString added in v0.6.5

func (s SolutionStackDescription) GoString() string

GoString returns the string representation

func (*SolutionStackDescription) SetPermittedFileTypes added in v1.5.0

func (s *SolutionStackDescription) SetPermittedFileTypes(v []*string) *SolutionStackDescription

SetPermittedFileTypes sets the PermittedFileTypes field's value.

func (*SolutionStackDescription) SetSolutionStackName added in v1.5.0

func (s *SolutionStackDescription) SetSolutionStackName(v string) *SolutionStackDescription

SetSolutionStackName sets the SolutionStackName field's value.

func (SolutionStackDescription) String added in v0.6.5

func (s SolutionStackDescription) String() string

String returns the string representation

type SourceBuildInformation added in v1.4.17

type SourceBuildInformation struct {

	// The location of the source code, as a formatted string, depending on the
	// value of SourceRepository
	//
	//    * For CodeCommit, the format is the repository name and commit ID, separated
	//    by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.
	//
	//    * For S3, the format is the S3 bucket name and object key, separated by
	//    a forward slash. For example, my-s3-bucket/Folders/my-source-file.
	//
	// SourceLocation is a required field
	SourceLocation *string `min:"3" type:"string" required:"true"`

	// Location where the repository is stored.
	//
	//    * CodeCommit
	//
	//    * S3
	//
	// SourceRepository is a required field
	SourceRepository *string `type:"string" required:"true" enum:"SourceRepository"`

	// The type of repository.
	//
	//    * Git
	//
	//    * Zip
	//
	// SourceType is a required field
	SourceType *string `type:"string" required:"true" enum:"SourceType"`
	// contains filtered or unexported fields
}

Location of the source code for an application version.

func (SourceBuildInformation) GoString added in v1.4.17

func (s SourceBuildInformation) GoString() string

GoString returns the string representation

func (*SourceBuildInformation) SetSourceLocation added in v1.5.0

func (s *SourceBuildInformation) SetSourceLocation(v string) *SourceBuildInformation

SetSourceLocation sets the SourceLocation field's value.

func (*SourceBuildInformation) SetSourceRepository added in v1.5.0

func (s *SourceBuildInformation) SetSourceRepository(v string) *SourceBuildInformation

SetSourceRepository sets the SourceRepository field's value.

func (*SourceBuildInformation) SetSourceType added in v1.5.0

SetSourceType sets the SourceType field's value.

func (SourceBuildInformation) String added in v1.4.17

func (s SourceBuildInformation) String() string

String returns the string representation

func (*SourceBuildInformation) Validate added in v1.4.17

func (s *SourceBuildInformation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SourceConfiguration

type SourceConfiguration struct {

	// The name of the application associated with the configuration.
	ApplicationName *string `min:"1" type:"string"`

	// The name of the configuration template.
	TemplateName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A specification for an environment configuration

func (SourceConfiguration) GoString added in v0.6.5

func (s SourceConfiguration) GoString() string

GoString returns the string representation

func (*SourceConfiguration) SetApplicationName added in v1.5.0

func (s *SourceConfiguration) SetApplicationName(v string) *SourceConfiguration

SetApplicationName sets the ApplicationName field's value.

func (*SourceConfiguration) SetTemplateName added in v1.5.0

func (s *SourceConfiguration) SetTemplateName(v string) *SourceConfiguration

SetTemplateName sets the TemplateName field's value.

func (SourceConfiguration) String added in v0.6.5

func (s SourceConfiguration) String() string

String returns the string representation

func (*SourceConfiguration) Validate added in v1.1.21

func (s *SourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StatusCodes added in v0.7.4

type StatusCodes struct {

	// The percentage of requests over the last 10 seconds that resulted in a 2xx
	// (200, 201, etc.) status code.
	Status2xx *int64 `type:"integer"`

	// The percentage of requests over the last 10 seconds that resulted in a 3xx
	// (300, 301, etc.) status code.
	Status3xx *int64 `type:"integer"`

	// The percentage of requests over the last 10 seconds that resulted in a 4xx
	// (400, 401, etc.) status code.
	Status4xx *int64 `type:"integer"`

	// The percentage of requests over the last 10 seconds that resulted in a 5xx
	// (500, 501, etc.) status code.
	Status5xx *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. For more information, see Status Code Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).

func (StatusCodes) GoString added in v0.7.4

func (s StatusCodes) GoString() string

GoString returns the string representation

func (*StatusCodes) SetStatus2xx added in v1.5.0

func (s *StatusCodes) SetStatus2xx(v int64) *StatusCodes

SetStatus2xx sets the Status2xx field's value.

func (*StatusCodes) SetStatus3xx added in v1.5.0

func (s *StatusCodes) SetStatus3xx(v int64) *StatusCodes

SetStatus3xx sets the Status3xx field's value.

func (*StatusCodes) SetStatus4xx added in v1.5.0

func (s *StatusCodes) SetStatus4xx(v int64) *StatusCodes

SetStatus4xx sets the Status4xx field's value.

func (*StatusCodes) SetStatus5xx added in v1.5.0

func (s *StatusCodes) SetStatus5xx(v int64) *StatusCodes

SetStatus5xx sets the Status5xx field's value.

func (StatusCodes) String added in v0.7.4

func (s StatusCodes) String() string

String returns the string representation

type SwapEnvironmentCNAMEsInput

type SwapEnvironmentCNAMEsInput struct {

	// The ID of the destination environment.
	//
	// Condition: You must specify at least the DestinationEnvironmentID or the
	// DestinationEnvironmentName. You may also specify both. You must specify the
	// SourceEnvironmentId with the DestinationEnvironmentId.
	DestinationEnvironmentId *string `type:"string"`

	// The name of the destination environment.
	//
	// Condition: You must specify at least the DestinationEnvironmentID or the
	// DestinationEnvironmentName. You may also specify both. You must specify the
	// SourceEnvironmentName with the DestinationEnvironmentName.
	DestinationEnvironmentName *string `min:"4" type:"string"`

	// The ID of the source environment.
	//
	// Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName.
	// You may also specify both. If you specify the SourceEnvironmentId, you must
	// specify the DestinationEnvironmentId.
	SourceEnvironmentId *string `type:"string"`

	// The name of the source environment.
	//
	// Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName.
	// You may also specify both. If you specify the SourceEnvironmentName, you
	// must specify the DestinationEnvironmentName.
	SourceEnvironmentName *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

Swaps the CNAMEs of two environments.

func (SwapEnvironmentCNAMEsInput) GoString added in v0.6.5

func (s SwapEnvironmentCNAMEsInput) GoString() string

GoString returns the string representation

func (*SwapEnvironmentCNAMEsInput) SetDestinationEnvironmentId added in v1.5.0

func (s *SwapEnvironmentCNAMEsInput) SetDestinationEnvironmentId(v string) *SwapEnvironmentCNAMEsInput

SetDestinationEnvironmentId sets the DestinationEnvironmentId field's value.

func (*SwapEnvironmentCNAMEsInput) SetDestinationEnvironmentName added in v1.5.0

func (s *SwapEnvironmentCNAMEsInput) SetDestinationEnvironmentName(v string) *SwapEnvironmentCNAMEsInput

SetDestinationEnvironmentName sets the DestinationEnvironmentName field's value.

func (*SwapEnvironmentCNAMEsInput) SetSourceEnvironmentId added in v1.5.0

func (s *SwapEnvironmentCNAMEsInput) SetSourceEnvironmentId(v string) *SwapEnvironmentCNAMEsInput

SetSourceEnvironmentId sets the SourceEnvironmentId field's value.

func (*SwapEnvironmentCNAMEsInput) SetSourceEnvironmentName added in v1.5.0

func (s *SwapEnvironmentCNAMEsInput) SetSourceEnvironmentName(v string) *SwapEnvironmentCNAMEsInput

SetSourceEnvironmentName sets the SourceEnvironmentName field's value.

func (SwapEnvironmentCNAMEsInput) String added in v0.6.5

String returns the string representation

func (*SwapEnvironmentCNAMEsInput) Validate added in v1.1.21

func (s *SwapEnvironmentCNAMEsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SwapEnvironmentCNAMEsOutput

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

func (SwapEnvironmentCNAMEsOutput) GoString added in v0.6.5

func (s SwapEnvironmentCNAMEsOutput) GoString() string

GoString returns the string representation

func (SwapEnvironmentCNAMEsOutput) String added in v0.6.5

String returns the string representation

type SystemStatus added in v0.7.4

type SystemStatus struct {

	// CPU utilization metrics for the instance.
	CPUUtilization *CPUUtilization `type:"structure"`

	// Load average in the last 1-minute, 5-minute, and 15-minute periods. For more
	// information, see Operating System Metrics (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-metrics.html#health-enhanced-metrics-os).
	LoadAverage []*float64 `type:"list"`
	// contains filtered or unexported fields
}

CPU utilization and load average metrics for an Amazon EC2 instance.

func (SystemStatus) GoString added in v0.7.4

func (s SystemStatus) GoString() string

GoString returns the string representation

func (*SystemStatus) SetCPUUtilization added in v1.5.0

func (s *SystemStatus) SetCPUUtilization(v *CPUUtilization) *SystemStatus

SetCPUUtilization sets the CPUUtilization field's value.

func (*SystemStatus) SetLoadAverage added in v1.5.0

func (s *SystemStatus) SetLoadAverage(v []*float64) *SystemStatus

SetLoadAverage sets the LoadAverage field's value.

func (SystemStatus) String added in v0.7.4

func (s SystemStatus) String() string

String returns the string representation

type Tag

type Tag struct {

	// The key of the tag.
	Key *string `min:"1" type:"string"`

	// The value of the tag.
	Value *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a tag applied to a resource in an environment.

func (Tag) GoString added in v0.6.5

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.5.0

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.6.5

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.1.21

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TerminateEnvironmentInput

type TerminateEnvironmentInput struct {

	// The ID of the environment to terminate.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string `type:"string"`

	// The name of the environment to terminate.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string `min:"4" type:"string"`

	// Terminates the target environment even if another environment in the same
	// group is dependent on it.
	ForceTerminate *bool `type:"boolean"`

	// Indicates whether the associated AWS resources should shut down when the
	// environment is terminated:
	//
	//    * true: The specified environment as well as the associated AWS resources,
	//    such as Auto Scaling group and LoadBalancer, are terminated.
	//
	//    * false: AWS Elastic Beanstalk resource management is removed from the
	//    environment, but the AWS resources continue to operate.
	//
	// For more information, see the AWS Elastic Beanstalk User Guide. (https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/)
	//
	// Default: true
	//
	// Valid Values: true | false
	TerminateResources *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Request to terminate an environment.

func (TerminateEnvironmentInput) GoString added in v0.6.5

func (s TerminateEnvironmentInput) GoString() string

GoString returns the string representation

func (*TerminateEnvironmentInput) SetEnvironmentId added in v1.5.0

SetEnvironmentId sets the EnvironmentId field's value.

func (*TerminateEnvironmentInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*TerminateEnvironmentInput) SetForceTerminate added in v1.5.0

func (s *TerminateEnvironmentInput) SetForceTerminate(v bool) *TerminateEnvironmentInput

SetForceTerminate sets the ForceTerminate field's value.

func (*TerminateEnvironmentInput) SetTerminateResources added in v1.5.0

func (s *TerminateEnvironmentInput) SetTerminateResources(v bool) *TerminateEnvironmentInput

SetTerminateResources sets the TerminateResources field's value.

func (TerminateEnvironmentInput) String added in v0.6.5

func (s TerminateEnvironmentInput) String() string

String returns the string representation

func (*TerminateEnvironmentInput) Validate added in v1.1.21

func (s *TerminateEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Trigger

type Trigger struct {

	// The name of the trigger.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a trigger.

func (Trigger) GoString added in v0.6.5

func (s Trigger) GoString() string

GoString returns the string representation

func (*Trigger) SetName added in v1.5.0

func (s *Trigger) SetName(v string) *Trigger

SetName sets the Name field's value.

func (Trigger) String added in v0.6.5

func (s Trigger) String() string

String returns the string representation

type UpdateApplicationInput

type UpdateApplicationInput struct {

	// The name of the application to update. If no such application is found, UpdateApplication
	// returns an InvalidParameterValue error.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// A new description for the application.
	//
	// Default: If not specified, AWS Elastic Beanstalk does not update the description.
	Description *string `type:"string"`
	// contains filtered or unexported fields
}

Request to update an application.

func (UpdateApplicationInput) GoString added in v0.6.5

func (s UpdateApplicationInput) GoString() string

GoString returns the string representation

func (*UpdateApplicationInput) SetApplicationName added in v1.5.0

func (s *UpdateApplicationInput) SetApplicationName(v string) *UpdateApplicationInput

SetApplicationName sets the ApplicationName field's value.

func (*UpdateApplicationInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (UpdateApplicationInput) String added in v0.6.5

func (s UpdateApplicationInput) String() string

String returns the string representation

func (*UpdateApplicationInput) Validate added in v1.1.21

func (s *UpdateApplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApplicationResourceLifecycleInput added in v1.6.8

type UpdateApplicationResourceLifecycleInput struct {

	// The name of the application.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// The lifecycle configuration.
	//
	// ResourceLifecycleConfig is a required field
	ResourceLifecycleConfig *ApplicationResourceLifecycleConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationResourceLifecycleInput) GoString added in v1.6.8

GoString returns the string representation

func (*UpdateApplicationResourceLifecycleInput) SetApplicationName added in v1.6.8

SetApplicationName sets the ApplicationName field's value.

func (*UpdateApplicationResourceLifecycleInput) SetResourceLifecycleConfig added in v1.6.8

SetResourceLifecycleConfig sets the ResourceLifecycleConfig field's value.

func (UpdateApplicationResourceLifecycleInput) String added in v1.6.8

String returns the string representation

func (*UpdateApplicationResourceLifecycleInput) Validate added in v1.6.8

Validate inspects the fields of the type to determine if they are valid.

type UpdateApplicationResourceLifecycleOutput added in v1.6.8

type UpdateApplicationResourceLifecycleOutput struct {

	// The name of the application.
	ApplicationName *string `min:"1" type:"string"`

	// The lifecycle configuration.
	ResourceLifecycleConfig *ApplicationResourceLifecycleConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateApplicationResourceLifecycleOutput) GoString added in v1.6.8

GoString returns the string representation

func (*UpdateApplicationResourceLifecycleOutput) SetApplicationName added in v1.6.8

SetApplicationName sets the ApplicationName field's value.

func (*UpdateApplicationResourceLifecycleOutput) SetResourceLifecycleConfig added in v1.6.8

SetResourceLifecycleConfig sets the ResourceLifecycleConfig field's value.

func (UpdateApplicationResourceLifecycleOutput) String added in v1.6.8

String returns the string representation

type UpdateApplicationVersionInput

type UpdateApplicationVersionInput struct {

	// The name of the application associated with this version.
	//
	// If no application is found with this name, UpdateApplication returns an InvalidParameterValue
	// error.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// A new description for this version.
	Description *string `type:"string"`

	// The name of the version to update.
	//
	// If no application version is found with this label, UpdateApplication returns
	// an InvalidParameterValue error.
	//
	// VersionLabel is a required field
	VersionLabel *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationVersionInput) GoString added in v0.6.5

GoString returns the string representation

func (*UpdateApplicationVersionInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*UpdateApplicationVersionInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*UpdateApplicationVersionInput) SetVersionLabel added in v1.5.0

SetVersionLabel sets the VersionLabel field's value.

func (UpdateApplicationVersionInput) String added in v0.6.5

String returns the string representation

func (*UpdateApplicationVersionInput) Validate added in v1.1.21

func (s *UpdateApplicationVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConfigurationTemplateInput

type UpdateConfigurationTemplateInput struct {

	// The name of the application associated with the configuration template to
	// update.
	//
	// If no application is found with this name, UpdateConfigurationTemplate returns
	// an InvalidParameterValue error.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// A new description for the configuration.
	Description *string `type:"string"`

	// A list of configuration option settings to update with the new specified
	// option value.
	OptionSettings []*ConfigurationOptionSetting `type:"list"`

	// A list of configuration options to remove from the configuration set.
	//
	// Constraint: You can remove only UserDefined configuration options.
	OptionsToRemove []*OptionSpecification `type:"list"`

	// The name of the configuration template to update.
	//
	// If no configuration template is found with this name, UpdateConfigurationTemplate
	// returns an InvalidParameterValue error.
	//
	// TemplateName is a required field
	TemplateName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The result message containing the options for the specified solution stack.

func (UpdateConfigurationTemplateInput) GoString added in v0.6.5

GoString returns the string representation

func (*UpdateConfigurationTemplateInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*UpdateConfigurationTemplateInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*UpdateConfigurationTemplateInput) SetOptionSettings added in v1.5.0

SetOptionSettings sets the OptionSettings field's value.

func (*UpdateConfigurationTemplateInput) SetOptionsToRemove added in v1.5.0

SetOptionsToRemove sets the OptionsToRemove field's value.

func (*UpdateConfigurationTemplateInput) SetTemplateName added in v1.5.0

SetTemplateName sets the TemplateName field's value.

func (UpdateConfigurationTemplateInput) String added in v0.6.5

String returns the string representation

func (*UpdateConfigurationTemplateInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type UpdateEnvironmentInput

type UpdateEnvironmentInput struct {

	// The name of the application with which the environment is associated.
	ApplicationName *string `min:"1" type:"string"`

	// If this parameter is specified, AWS Elastic Beanstalk updates the description
	// of this environment.
	Description *string `type:"string"`

	// The ID of the environment to update.
	//
	// If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue
	// error.
	//
	// Condition: You must specify either this or an EnvironmentName, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentId *string `type:"string"`

	// The name of the environment to update. If no environment with this name exists,
	// AWS Elastic Beanstalk returns an InvalidParameterValue error.
	//
	// Condition: You must specify either this or an EnvironmentId, or both. If
	// you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
	// error.
	EnvironmentName *string `min:"4" type:"string"`

	// The name of the group to which the target environment belongs. Specify a
	// group name only if the environment's name is specified in an environment
	// manifest and not with the environment name or environment ID parameters.
	// See Environment Manifest (env.yaml) (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html)
	// for details.
	GroupName *string `min:"1" type:"string"`

	// If specified, AWS Elastic Beanstalk updates the configuration set associated
	// with the running environment and sets the specified configuration options
	// to the requested value.
	OptionSettings []*ConfigurationOptionSetting `type:"list"`

	// A list of custom user-defined configuration options to remove from the configuration
	// set for this environment.
	OptionsToRemove []*OptionSpecification `type:"list"`

	// The ARN of the platform, if used.
	PlatformArn *string `type:"string"`

	// This specifies the platform version that the environment will run after the
	// environment is updated.
	SolutionStackName *string `type:"string"`

	// If this parameter is specified, AWS Elastic Beanstalk deploys this configuration
	// template to the environment. If no such configuration template is found,
	// AWS Elastic Beanstalk returns an InvalidParameterValue error.
	TemplateName *string `min:"1" type:"string"`

	// This specifies the tier to use to update the environment.
	//
	// Condition: At this time, if you change the tier version, name, or type, AWS
	// Elastic Beanstalk returns InvalidParameterValue error.
	Tier *EnvironmentTier `type:"structure"`

	// If this parameter is specified, AWS Elastic Beanstalk deploys the named application
	// version to the environment. If no such application version is found, returns
	// an InvalidParameterValue error.
	VersionLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Request to update an environment.

func (UpdateEnvironmentInput) GoString added in v0.6.5

func (s UpdateEnvironmentInput) GoString() string

GoString returns the string representation

func (*UpdateEnvironmentInput) SetApplicationName added in v1.5.0

func (s *UpdateEnvironmentInput) SetApplicationName(v string) *UpdateEnvironmentInput

SetApplicationName sets the ApplicationName field's value.

func (*UpdateEnvironmentInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*UpdateEnvironmentInput) SetEnvironmentId added in v1.5.0

func (s *UpdateEnvironmentInput) SetEnvironmentId(v string) *UpdateEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateEnvironmentInput) SetEnvironmentName added in v1.5.0

func (s *UpdateEnvironmentInput) SetEnvironmentName(v string) *UpdateEnvironmentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*UpdateEnvironmentInput) SetGroupName added in v1.5.0

SetGroupName sets the GroupName field's value.

func (*UpdateEnvironmentInput) SetOptionSettings added in v1.5.0

SetOptionSettings sets the OptionSettings field's value.

func (*UpdateEnvironmentInput) SetOptionsToRemove added in v1.5.0

SetOptionsToRemove sets the OptionsToRemove field's value.

func (*UpdateEnvironmentInput) SetPlatformArn added in v1.6.27

SetPlatformArn sets the PlatformArn field's value.

func (*UpdateEnvironmentInput) SetSolutionStackName added in v1.5.0

func (s *UpdateEnvironmentInput) SetSolutionStackName(v string) *UpdateEnvironmentInput

SetSolutionStackName sets the SolutionStackName field's value.

func (*UpdateEnvironmentInput) SetTemplateName added in v1.5.0

func (s *UpdateEnvironmentInput) SetTemplateName(v string) *UpdateEnvironmentInput

SetTemplateName sets the TemplateName field's value.

func (*UpdateEnvironmentInput) SetTier added in v1.5.0

SetTier sets the Tier field's value.

func (*UpdateEnvironmentInput) SetVersionLabel added in v1.5.0

func (s *UpdateEnvironmentInput) SetVersionLabel(v string) *UpdateEnvironmentInput

SetVersionLabel sets the VersionLabel field's value.

func (UpdateEnvironmentInput) String added in v0.6.5

func (s UpdateEnvironmentInput) String() string

String returns the string representation

func (*UpdateEnvironmentInput) Validate added in v1.1.21

func (s *UpdateEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTagsForResourceInput added in v1.12.10

type UpdateTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resouce to be updated.
	//
	// Must be the ARN of an Elastic Beanstalk environment.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// A list of tags to add or update.
	//
	// If a key of an existing tag is added, the tag's value is updated.
	TagsToAdd []*Tag `type:"list"`

	// A list of tag keys to remove.
	//
	// If a tag key doesn't exist, it is silently ignored.
	TagsToRemove []*string `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateTagsForResourceInput) GoString added in v1.12.10

func (s UpdateTagsForResourceInput) GoString() string

GoString returns the string representation

func (*UpdateTagsForResourceInput) SetResourceArn added in v1.12.10

SetResourceArn sets the ResourceArn field's value.

func (*UpdateTagsForResourceInput) SetTagsToAdd added in v1.12.10

SetTagsToAdd sets the TagsToAdd field's value.

func (*UpdateTagsForResourceInput) SetTagsToRemove added in v1.12.10

SetTagsToRemove sets the TagsToRemove field's value.

func (UpdateTagsForResourceInput) String added in v1.12.10

String returns the string representation

func (*UpdateTagsForResourceInput) Validate added in v1.12.10

func (s *UpdateTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTagsForResourceOutput added in v1.12.10

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

func (UpdateTagsForResourceOutput) GoString added in v1.12.10

func (s UpdateTagsForResourceOutput) GoString() string

GoString returns the string representation

func (UpdateTagsForResourceOutput) String added in v1.12.10

String returns the string representation

type ValidateConfigurationSettingsInput

type ValidateConfigurationSettingsInput struct {

	// The name of the application that the configuration template or environment
	// belongs to.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// The name of the environment to validate the settings against.
	//
	// Condition: You cannot specify both this and a configuration template name.
	EnvironmentName *string `min:"4" type:"string"`

	// A list of the options and desired values to evaluate.
	//
	// OptionSettings is a required field
	OptionSettings []*ConfigurationOptionSetting `type:"list" required:"true"`

	// The name of the configuration template to validate the settings against.
	//
	// Condition: You cannot specify both this and an environment name.
	TemplateName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A list of validation messages for a specified configuration template.

func (ValidateConfigurationSettingsInput) GoString added in v0.6.5

GoString returns the string representation

func (*ValidateConfigurationSettingsInput) SetApplicationName added in v1.5.0

SetApplicationName sets the ApplicationName field's value.

func (*ValidateConfigurationSettingsInput) SetEnvironmentName added in v1.5.0

SetEnvironmentName sets the EnvironmentName field's value.

func (*ValidateConfigurationSettingsInput) SetOptionSettings added in v1.5.0

SetOptionSettings sets the OptionSettings field's value.

func (*ValidateConfigurationSettingsInput) SetTemplateName added in v1.5.0

SetTemplateName sets the TemplateName field's value.

func (ValidateConfigurationSettingsInput) String added in v0.6.5

String returns the string representation

func (*ValidateConfigurationSettingsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type ValidateConfigurationSettingsOutput

type ValidateConfigurationSettingsOutput struct {

	// A list of ValidationMessage.
	Messages []*ValidationMessage `type:"list"`
	// contains filtered or unexported fields
}

Provides a list of validation messages.

func (ValidateConfigurationSettingsOutput) GoString added in v0.6.5

GoString returns the string representation

func (*ValidateConfigurationSettingsOutput) SetMessages added in v1.5.0

SetMessages sets the Messages field's value.

func (ValidateConfigurationSettingsOutput) String added in v0.6.5

String returns the string representation

type ValidationMessage

type ValidationMessage struct {

	// A message describing the error or warning.
	Message *string `type:"string"`

	// The namespace to which the option belongs.
	Namespace *string `type:"string"`

	// The name of the option.
	OptionName *string `type:"string"`

	// An indication of the severity of this message:
	//
	//    * error: This message indicates that this is not a valid setting for an
	//    option.
	//
	//    * warning: This message is providing information you should take into
	//    account.
	Severity *string `type:"string" enum:"ValidationSeverity"`
	// contains filtered or unexported fields
}

An error or warning for a desired configuration option value.

func (ValidationMessage) GoString added in v0.6.5

func (s ValidationMessage) GoString() string

GoString returns the string representation

func (*ValidationMessage) SetMessage added in v1.5.0

func (s *ValidationMessage) SetMessage(v string) *ValidationMessage

SetMessage sets the Message field's value.

func (*ValidationMessage) SetNamespace added in v1.5.0

func (s *ValidationMessage) SetNamespace(v string) *ValidationMessage

SetNamespace sets the Namespace field's value.

func (*ValidationMessage) SetOptionName added in v1.5.0

func (s *ValidationMessage) SetOptionName(v string) *ValidationMessage

SetOptionName sets the OptionName field's value.

func (*ValidationMessage) SetSeverity added in v1.5.0

func (s *ValidationMessage) SetSeverity(v string) *ValidationMessage

SetSeverity sets the Severity field's value.

func (ValidationMessage) String added in v0.6.5

func (s ValidationMessage) String() string

String returns the string representation

Directories

Path Synopsis
Package elasticbeanstalkiface provides an interface to enable mocking the AWS Elastic Beanstalk service client for testing your code.
Package elasticbeanstalkiface provides an interface to enable mocking the AWS Elastic Beanstalk service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL