AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeEnvironmentsInput

import "github.com/aws/aws-sdk-go/service/elasticbeanstalk"

type DescribeEnvironmentsInput struct { ApplicationName *string `min:"1" type:"string"` EnvironmentIds []*string `type:"list"` EnvironmentNames []*string `type:"list"` IncludeDeleted *bool `type:"boolean"` IncludedDeletedBackTo *time.Time `type:"timestamp"` MaxRecords *int64 `min:"1" type:"integer"` NextToken *string `type:"string"` VersionLabel *string `min:"1" type:"string"` }

Request to describe one or more environments.

ApplicationName

Type: *string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

EnvironmentIds

Type: []*string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

EnvironmentNames

Type: []*string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

IncludeDeleted

Type: *bool

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

IncludedDeletedBackTo

Type: *time.Time

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

MaxRecords

Type: *int64

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.

NextToken

Type: *string

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.

VersionLabel

Type: *string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Method

GoString

func (s DescribeEnvironmentsInput) GoString() string

GoString returns the string representation

SetApplicationName

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

SetApplicationName sets the ApplicationName field's value.

SetEnvironmentIds

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

SetEnvironmentIds sets the EnvironmentIds field's value.

SetEnvironmentNames

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

SetEnvironmentNames sets the EnvironmentNames field's value.

SetIncludeDeleted

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

SetIncludeDeleted sets the IncludeDeleted field's value.

SetIncludedDeletedBackTo

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

SetIncludedDeletedBackTo sets the IncludedDeletedBackTo field's value.

SetMaxRecords

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

SetMaxRecords sets the MaxRecords field's value.

SetNextToken

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

SetNextToken sets the NextToken field's value.

SetVersionLabel

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

SetVersionLabel sets the VersionLabel field's value.

String

func (s DescribeEnvironmentsInput) String() string

String returns the string representation

Validate

func (s *DescribeEnvironmentsInput) Validate() error

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

On this page: