resourceexplorer2

package
v1.49.14 Latest Latest
Warning

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

Go to latest
Published: Jan 3, 2024 License: Apache-2.0 Imports: 10 Imported by: 10

Documentation

Overview

Package resourceexplorer2 provides the client and types for making API requests to AWS Resource Explorer.

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.

Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index (https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-index) in each Region, with the details of that Region's resources.

You can search across all of the indexed Regions in your account (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region-turn-on.html), Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.

For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide (https://docs.aws.amazon.com/resource-explorer/latest/userguide/).

See https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28 for more information on this service.

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

Using the Client

To contact AWS Resource Explorer 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 Resource Explorer client ResourceExplorer2 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/resourceexplorer2/#New

Index

Constants

View Source
const (
	// AWSServiceAccessStatusEnabled is a AWSServiceAccessStatus enum value
	AWSServiceAccessStatusEnabled = "ENABLED"

	// AWSServiceAccessStatusDisabled is a AWSServiceAccessStatus enum value
	AWSServiceAccessStatusDisabled = "DISABLED"
)
View Source
const (
	// IndexStateCreating is a IndexState enum value
	IndexStateCreating = "CREATING"

	// IndexStateActive is a IndexState enum value
	IndexStateActive = "ACTIVE"

	// IndexStateDeleting is a IndexState enum value
	IndexStateDeleting = "DELETING"

	// IndexStateDeleted is a IndexState enum value
	IndexStateDeleted = "DELETED"

	// IndexStateUpdating is a IndexState enum value
	IndexStateUpdating = "UPDATING"
)
View Source
const (
	// IndexTypeLocal is a IndexType enum value
	IndexTypeLocal = "LOCAL"

	// IndexTypeAggregator is a IndexType enum value
	IndexTypeAggregator = "AGGREGATOR"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// The credentials that you used to call this operation don't have the minimum
	// required permissions.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// If you attempted to create a view, then the request failed because either
	// you specified parameters that didn’t match the original request, or you
	// attempted to create a view with a name that already exists in this Amazon
	// Web Services Region.
	//
	// If you attempted to create an index, then the request failed because either
	// you specified parameters that didn't match the original request, or an index
	// already exists in the current Amazon Web Services Region.
	//
	// If you attempted to update an index type to AGGREGATOR, then the request
	// failed because you already have an AGGREGATOR index in a different Amazon
	// Web Services Region.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The request failed because of internal service error. Try your request again
	// later.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// You specified a resource that doesn't exist. Check the ID or ARN that you
	// used to identity the resource, and try again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request failed because it exceeds a service quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request failed because you exceeded a rate limit for this operation.
	// For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// The principal making the request isn't permitted to perform the operation.
	ErrCodeUnauthorizedException = "UnauthorizedException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// You provided an invalid value for one of the operation's parameters. Check
	// the syntax for the operation, and try again.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "Resource Explorer 2" // Name of service.
	EndpointsID = "resource-explorer-2" // ID to lookup a service endpoint with.
	ServiceID   = "Resource Explorer 2" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AWSServiceAccessStatus_Values added in v1.47.11

func AWSServiceAccessStatus_Values() []string

AWSServiceAccessStatus_Values returns all elements of the AWSServiceAccessStatus enum

func IndexState_Values

func IndexState_Values() []string

IndexState_Values returns all elements of the IndexState enum

func IndexType_Values

func IndexType_Values() []string

IndexType_Values returns all elements of the IndexType enum

Types

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The credentials that you used to call this operation don't have the minimum required permissions.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateDefaultViewInput

type AssociateDefaultViewInput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view to set as the default for the Amazon Web Services Region and
	// Amazon Web Services account in which you call this operation. The specified
	// view must already exist in the called Region.
	//
	// ViewArn is a required field
	ViewArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateDefaultViewInput) GoString

func (s AssociateDefaultViewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateDefaultViewInput) SetViewArn

SetViewArn sets the ViewArn field's value.

func (AssociateDefaultViewInput) String

func (s AssociateDefaultViewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateDefaultViewInput) Validate

func (s *AssociateDefaultViewInput) Validate() error

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

type AssociateDefaultViewOutput

type AssociateDefaultViewOutput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view that the operation set as the default for queries made in the
	// Amazon Web Services Region and Amazon Web Services account in which you called
	// this operation.
	ViewArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (AssociateDefaultViewOutput) GoString

func (s AssociateDefaultViewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateDefaultViewOutput) SetViewArn

SetViewArn sets the ViewArn field's value.

func (AssociateDefaultViewOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetViewError

type BatchGetViewError struct {

	// The description of the error for the specified view.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `type:"string" required:"true"`

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view for which Resource Explorer failed to retrieve details.
	//
	// ViewArn is a required field
	ViewArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.

func (BatchGetViewError) GoString

func (s BatchGetViewError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetViewError) SetErrorMessage

func (s *BatchGetViewError) SetErrorMessage(v string) *BatchGetViewError

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchGetViewError) SetViewArn

func (s *BatchGetViewError) SetViewArn(v string) *BatchGetViewError

SetViewArn sets the ViewArn field's value.

func (BatchGetViewError) String

func (s BatchGetViewError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetViewInput

type BatchGetViewInput struct {

	// A list of Amazon resource names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// that identify the views you want details for.
	ViewArns []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetViewInput) GoString

func (s BatchGetViewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetViewInput) SetViewArns

func (s *BatchGetViewInput) SetViewArns(v []*string) *BatchGetViewInput

SetViewArns sets the ViewArns field's value.

func (BatchGetViewInput) String

func (s BatchGetViewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetViewInput) Validate

func (s *BatchGetViewInput) Validate() error

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

type BatchGetViewOutput

type BatchGetViewOutput struct {

	// If any of the specified ARNs result in an error, then this structure describes
	// the error.
	Errors []*BatchGetViewError `type:"list"`

	// A structure with a list of objects with details for each of the specified
	// views.
	Views []*View `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetViewOutput) GoString

func (s BatchGetViewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetViewOutput) SetErrors

SetErrors sets the Errors field's value.

func (*BatchGetViewOutput) SetViews

func (s *BatchGetViewOutput) SetViews(v []*View) *BatchGetViewOutput

SetViews sets the Views field's value.

func (BatchGetViewOutput) String

func (s BatchGetViewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region.

If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.

If you attempted to update an index type to AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different Amazon Web Services Region.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateIndexInput

type CreateIndexInput struct {

	// This value helps ensure idempotency. Resource Explorer uses this value to
	// prevent the accidental creation of duplicate versions. We recommend that
	// you generate a UUID-type value (https://wikipedia.org/wiki/Universally_unique_identifier)
	// to ensure the uniqueness of your index.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// The specified tags are attached only to the index created in this Amazon
	// Web Services Region. The tags aren't attached to any of the resources listed
	// in the index.
	//
	// Tags is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateIndexInput's
	// String and GoString methods.
	Tags map[string]*string `type:"map" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreateIndexInput) GoString

func (s CreateIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIndexInput) SetClientToken

func (s *CreateIndexInput) SetClientToken(v string) *CreateIndexInput

SetClientToken sets the ClientToken field's value.

func (*CreateIndexInput) SetTags

func (s *CreateIndexInput) SetTags(v map[string]*string) *CreateIndexInput

SetTags sets the Tags field's value.

func (CreateIndexInput) String

func (s CreateIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateIndexOutput

type CreateIndexOutput struct {

	// The ARN of the new local index for the Region. You can reference this ARN
	// in IAM permission policies to authorize the following operations: DeleteIndex
	// | GetIndex | UpdateIndexType | CreateView
	Arn *string `type:"string"`

	// The date and timestamp when the index was created.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// Indicates the current state of the index. You can check for changes to the
	// state for asynchronous operations by calling the GetIndex operation.
	//
	// The state can remain in the CREATING or UPDATING state for several hours
	// as Resource Explorer discovers the information about your resources and populates
	// the index.
	State *string `type:"string" enum:"IndexState"`
	// contains filtered or unexported fields
}

func (CreateIndexOutput) GoString

func (s CreateIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIndexOutput) SetArn

SetArn sets the Arn field's value.

func (*CreateIndexOutput) SetCreatedAt

func (s *CreateIndexOutput) SetCreatedAt(v time.Time) *CreateIndexOutput

SetCreatedAt sets the CreatedAt field's value.

func (*CreateIndexOutput) SetState

func (s *CreateIndexOutput) SetState(v string) *CreateIndexOutput

SetState sets the State field's value.

func (CreateIndexOutput) String

func (s CreateIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateViewInput

type CreateViewInput struct {

	// This value helps ensure idempotency. Resource Explorer uses this value to
	// prevent the accidental creation of duplicate versions. We recommend that
	// you generate a UUID-type value (https://wikipedia.org/wiki/Universally_unique_identifier)
	// to ensure the uniqueness of your views.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// An array of strings that specify which resources are included in the results
	// of queries made using this view. When you use this view in a Search operation,
	// the filter string is combined with the search's QueryString parameter using
	// a logical AND operator.
	//
	// For information about the supported syntax, see Search query reference for
	// Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html)
	// in the Amazon Web Services Resource Explorer User Guide.
	//
	// This query string in the context of this operation supports only filter prefixes
	// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters)
	// with optional operators (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators).
	// It doesn't support free-form text. For example, the string region:us* service:ec2
	// -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services
	// Region that begins with the letters us and is not tagged with a key Stage
	// that has the value prod.
	//
	// Filters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateViewInput's
	// String and GoString methods.
	Filters *SearchFilter `type:"structure" sensitive:"true"`

	// Specifies optional fields that you want included in search results from this
	// view. It is a list of objects that each describe a field to include.
	//
	// The default is an empty list, with no optional fields included in the results.
	IncludedProperties []*IncludedProperty `type:"list"`

	// The root ARN of the account, an organizational unit (OU), or an organization
	// ARN. If left empty, the default is account.
	Scope *string `min:"1" type:"string"`

	// Tag key and value pairs that are attached to the view.
	//
	// Tags is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateViewInput's
	// String and GoString methods.
	Tags map[string]*string `type:"map" sensitive:"true"`

	// The name of the new view. This name appears in the list of views in Resource
	// Explorer.
	//
	// The name must be no more than 64 characters long, and can include letters,
	// digits, and the dash (-) character. The name must be unique within its Amazon
	// Web Services Region.
	//
	// ViewName is a required field
	ViewName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateViewInput) GoString

func (s CreateViewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateViewInput) SetClientToken

func (s *CreateViewInput) SetClientToken(v string) *CreateViewInput

SetClientToken sets the ClientToken field's value.

func (*CreateViewInput) SetFilters

func (s *CreateViewInput) SetFilters(v *SearchFilter) *CreateViewInput

SetFilters sets the Filters field's value.

func (*CreateViewInput) SetIncludedProperties

func (s *CreateViewInput) SetIncludedProperties(v []*IncludedProperty) *CreateViewInput

SetIncludedProperties sets the IncludedProperties field's value.

func (*CreateViewInput) SetScope added in v1.47.11

func (s *CreateViewInput) SetScope(v string) *CreateViewInput

SetScope sets the Scope field's value.

func (*CreateViewInput) SetTags

func (s *CreateViewInput) SetTags(v map[string]*string) *CreateViewInput

SetTags sets the Tags field's value.

func (*CreateViewInput) SetViewName

func (s *CreateViewInput) SetViewName(v string) *CreateViewInput

SetViewName sets the ViewName field's value.

func (CreateViewInput) String

func (s CreateViewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateViewInput) Validate

func (s *CreateViewInput) Validate() error

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

type CreateViewOutput

type CreateViewOutput struct {

	// A structure that contains the details about the new view.
	View *View `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateViewOutput) GoString

func (s CreateViewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateViewOutput) SetView

func (s *CreateViewOutput) SetView(v *View) *CreateViewOutput

SetView sets the View field's value.

func (CreateViewOutput) String

func (s CreateViewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteIndexInput

type DeleteIndexInput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the index that you want to delete.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteIndexInput) GoString

func (s DeleteIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIndexInput) SetArn

SetArn sets the Arn field's value.

func (DeleteIndexInput) String

func (s DeleteIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIndexInput) Validate

func (s *DeleteIndexInput) Validate() error

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

type DeleteIndexOutput

type DeleteIndexOutput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the index that you successfully started the deletion process.
	//
	// This operation is asynchronous. To check its status, call the GetIndex operation.
	Arn *string `type:"string"`

	// The date and time when you last updated this index.
	LastUpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// Indicates the current state of the index.
	State *string `type:"string" enum:"IndexState"`
	// contains filtered or unexported fields
}

func (DeleteIndexOutput) GoString

func (s DeleteIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIndexOutput) SetArn

SetArn sets the Arn field's value.

func (*DeleteIndexOutput) SetLastUpdatedAt

func (s *DeleteIndexOutput) SetLastUpdatedAt(v time.Time) *DeleteIndexOutput

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*DeleteIndexOutput) SetState

func (s *DeleteIndexOutput) SetState(v string) *DeleteIndexOutput

SetState sets the State field's value.

func (DeleteIndexOutput) String

func (s DeleteIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteViewInput

type DeleteViewInput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view that you want to delete.
	//
	// ViewArn is a required field
	ViewArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteViewInput) GoString

func (s DeleteViewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteViewInput) SetViewArn

func (s *DeleteViewInput) SetViewArn(v string) *DeleteViewInput

SetViewArn sets the ViewArn field's value.

func (DeleteViewInput) String

func (s DeleteViewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteViewInput) Validate

func (s *DeleteViewInput) Validate() error

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

type DeleteViewOutput

type DeleteViewOutput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view that you successfully deleted.
	ViewArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteViewOutput) GoString

func (s DeleteViewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteViewOutput) SetViewArn

func (s *DeleteViewOutput) SetViewArn(v string) *DeleteViewOutput

SetViewArn sets the ViewArn field's value.

func (DeleteViewOutput) String

func (s DeleteViewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateDefaultViewInput

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

func (DisassociateDefaultViewInput) GoString

func (s DisassociateDefaultViewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateDefaultViewInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateDefaultViewOutput

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

func (DisassociateDefaultViewOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateDefaultViewOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAccountLevelServiceConfigurationInput added in v1.47.11

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

func (GetAccountLevelServiceConfigurationInput) GoString added in v1.47.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetAccountLevelServiceConfigurationInput) String added in v1.47.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAccountLevelServiceConfigurationOutput added in v1.47.11

type GetAccountLevelServiceConfigurationOutput struct {

	// Details about the organization, and whether configuration is ENABLED or DISABLED.
	OrgConfiguration *OrgConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetAccountLevelServiceConfigurationOutput) GoString added in v1.47.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAccountLevelServiceConfigurationOutput) SetOrgConfiguration added in v1.47.11

SetOrgConfiguration sets the OrgConfiguration field's value.

func (GetAccountLevelServiceConfigurationOutput) String added in v1.47.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDefaultViewInput

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

func (GetDefaultViewInput) GoString

func (s GetDefaultViewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetDefaultViewInput) String

func (s GetDefaultViewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDefaultViewOutput

type GetDefaultViewOutput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view that is the current default for the Amazon Web Services Region
	// in which you called this operation.
	ViewArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetDefaultViewOutput) GoString

func (s GetDefaultViewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDefaultViewOutput) SetViewArn

SetViewArn sets the ViewArn field's value.

func (GetDefaultViewOutput) String

func (s GetDefaultViewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetIndexInput

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

func (GetIndexInput) GoString

func (s GetIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetIndexInput) String

func (s GetIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetIndexOutput

type GetIndexOutput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the index.
	Arn *string `type:"string"`

	// The date and time when the index was originally created.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The date and time when the index was last updated.
	LastUpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// This response value is present only if this index is Type=AGGREGATOR.
	//
	// A list of the Amazon Web Services Regions that replicate their content to
	// the index in this Region.
	ReplicatingFrom []*string `type:"list"`

	// This response value is present only if this index is Type=LOCAL.
	//
	// The Amazon Web Services Region that contains the aggregator index, if one
	// exists. If an aggregator index does exist then the Region in which you called
	// this operation replicates its index information to the Region specified in
	// this response value.
	ReplicatingTo []*string `type:"list"`

	// The current state of the index in this Amazon Web Services Region.
	State *string `type:"string" enum:"IndexState"`

	// Tag key and value pairs that are attached to the index.
	//
	// Tags is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetIndexOutput's
	// String and GoString methods.
	Tags map[string]*string `type:"map" sensitive:"true"`

	// The type of the index in this Region. For information about the aggregator
	// index and how it differs from a local index, see Turning on cross-Region
	// search by creating an aggregator index (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html).
	Type *string `type:"string" enum:"IndexType"`
	// contains filtered or unexported fields
}

func (GetIndexOutput) GoString

func (s GetIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIndexOutput) SetArn

func (s *GetIndexOutput) SetArn(v string) *GetIndexOutput

SetArn sets the Arn field's value.

func (*GetIndexOutput) SetCreatedAt

func (s *GetIndexOutput) SetCreatedAt(v time.Time) *GetIndexOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetIndexOutput) SetLastUpdatedAt

func (s *GetIndexOutput) SetLastUpdatedAt(v time.Time) *GetIndexOutput

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*GetIndexOutput) SetReplicatingFrom

func (s *GetIndexOutput) SetReplicatingFrom(v []*string) *GetIndexOutput

SetReplicatingFrom sets the ReplicatingFrom field's value.

func (*GetIndexOutput) SetReplicatingTo

func (s *GetIndexOutput) SetReplicatingTo(v []*string) *GetIndexOutput

SetReplicatingTo sets the ReplicatingTo field's value.

func (*GetIndexOutput) SetState

func (s *GetIndexOutput) SetState(v string) *GetIndexOutput

SetState sets the State field's value.

func (*GetIndexOutput) SetTags

func (s *GetIndexOutput) SetTags(v map[string]*string) *GetIndexOutput

SetTags sets the Tags field's value.

func (*GetIndexOutput) SetType

func (s *GetIndexOutput) SetType(v string) *GetIndexOutput

SetType sets the Type field's value.

func (GetIndexOutput) String

func (s GetIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetViewInput

type GetViewInput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view that you want information about.
	//
	// ViewArn is a required field
	ViewArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetViewInput) GoString

func (s GetViewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetViewInput) SetViewArn

func (s *GetViewInput) SetViewArn(v string) *GetViewInput

SetViewArn sets the ViewArn field's value.

func (GetViewInput) String

func (s GetViewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetViewInput) Validate

func (s *GetViewInput) Validate() error

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

type GetViewOutput

type GetViewOutput struct {

	// Tag key and value pairs that are attached to the view.
	//
	// Tags is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetViewOutput's
	// String and GoString methods.
	Tags map[string]*string `type:"map" sensitive:"true"`

	// A structure that contains the details for the requested view.
	View *View `type:"structure"`
	// contains filtered or unexported fields
}

func (GetViewOutput) GoString

func (s GetViewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetViewOutput) SetTags

func (s *GetViewOutput) SetTags(v map[string]*string) *GetViewOutput

SetTags sets the Tags field's value.

func (*GetViewOutput) SetView

func (s *GetViewOutput) SetView(v *View) *GetViewOutput

SetView sets the View field's value.

func (GetViewOutput) String

func (s GetViewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IncludedProperty

type IncludedProperty struct {

	// The name of the property that is included in this view.
	//
	// You can specify the following property names for this field:
	//
	//    * Tags
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property.

func (IncludedProperty) GoString

func (s IncludedProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncludedProperty) SetName

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

SetName sets the Name field's value.

func (IncludedProperty) String

func (s IncludedProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncludedProperty) Validate

func (s *IncludedProperty) Validate() error

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

type Index

type Index struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the index.
	Arn *string `type:"string"`

	// The Amazon Web Services Region in which the index exists.
	Region *string `type:"string"`

	// The type of index. It can be one of the following values:
	//
	//    * LOCAL – The index contains information about resources from only the
	//    same Amazon Web Services Region.
	//
	//    * AGGREGATOR – Resource Explorer replicates copies of the indexed information
	//    about resources in all other Amazon Web Services Regions to the aggregator
	//    index. This lets search results in the Region with the aggregator index
	//    to include resources from all Regions in the account where Resource Explorer
	//    is turned on.
	Type *string `type:"string" enum:"IndexType"`
	// contains filtered or unexported fields
}

An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.

By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.

func (Index) GoString

func (s Index) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Index) SetArn

func (s *Index) SetArn(v string) *Index

SetArn sets the Arn field's value.

func (*Index) SetRegion

func (s *Index) SetRegion(v string) *Index

SetRegion sets the Region field's value.

func (*Index) SetType

func (s *Index) SetType(v string) *Index

SetType sets the Type field's value.

func (Index) String

func (s Index) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request failed because of internal service error. Try your request again later.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListIndexesForMembersInput added in v1.47.11

type ListIndexesForMembersInput struct {

	// The account IDs will limit the output to only indexes from these accounts.
	//
	// AccountIdList is a required field
	AccountIdList []*string `min:"1" type:"list" required:"true"`

	// The maximum number of results that you want included on each page of the
	// response. If you do not include this parameter, it defaults to a value appropriate
	// to the operation. If additional items exist beyond those included in the
	// current response, the NextToken response element is present and has a value
	// (is not null). Include that value as the NextToken request parameter in the
	// next call to the operation to get the next part of the results.
	//
	// An API operation can return fewer results than the maximum even when there
	// are more results available. You should check NextToken after every operation
	// to ensure that you receive all of the results.
	MaxResults *int64 `min:"1" type:"integer"`

	// The parameter for receiving additional results if you receive a NextToken
	// response in a previous request. A NextToken response indicates that more
	// output is available. Set this parameter to the value of the previous call's
	// NextToken response to indicate where the output should continue from. The
	// pagination tokens expire after 24 hours.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListIndexesForMembersInput) GoString added in v1.47.11

func (s ListIndexesForMembersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndexesForMembersInput) SetAccountIdList added in v1.47.11

SetAccountIdList sets the AccountIdList field's value.

func (*ListIndexesForMembersInput) SetMaxResults added in v1.47.11

SetMaxResults sets the MaxResults field's value.

func (*ListIndexesForMembersInput) SetNextToken added in v1.47.11

SetNextToken sets the NextToken field's value.

func (ListIndexesForMembersInput) String added in v1.47.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndexesForMembersInput) Validate added in v1.47.11

func (s *ListIndexesForMembersInput) Validate() error

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

type ListIndexesForMembersOutput added in v1.47.11

type ListIndexesForMembersOutput struct {

	// A structure that contains the details and status of each index.
	Indexes []*MemberIndex `type:"list"`

	// If present, indicates that more output is available than is included in the
	// current response. Use this value in the NextToken request parameter in a
	// subsequent call to the operation to get the next part of the output. You
	// should repeat this until the NextToken response element comes back as null.
	// The pagination tokens expire after 24 hours.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListIndexesForMembersOutput) GoString added in v1.47.11

func (s ListIndexesForMembersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndexesForMembersOutput) SetIndexes added in v1.47.11

SetIndexes sets the Indexes field's value.

func (*ListIndexesForMembersOutput) SetNextToken added in v1.47.11

SetNextToken sets the NextToken field's value.

func (ListIndexesForMembersOutput) String added in v1.47.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListIndexesInput

type ListIndexesInput struct {

	// The maximum number of results that you want included on each page of the
	// response. If you do not include this parameter, it defaults to a value appropriate
	// to the operation. If additional items exist beyond those included in the
	// current response, the NextToken response element is present and has a value
	// (is not null). Include that value as the NextToken request parameter in the
	// next call to the operation to get the next part of the results.
	//
	// An API operation can return fewer results than the maximum even when there
	// are more results available. You should check NextToken after every operation
	// to ensure that you receive all of the results.
	MaxResults *int64 `min:"1" type:"integer"`

	// The parameter for receiving additional results if you receive a NextToken
	// response in a previous request. A NextToken response indicates that more
	// output is available. Set this parameter to the value of the previous call's
	// NextToken response to indicate where the output should continue from. The
	// pagination tokens expire after 24 hours.
	NextToken *string `min:"1" type:"string"`

	// If specified, limits the response to only information about the index in
	// the specified list of Amazon Web Services Regions.
	Regions []*string `type:"list"`

	// If specified, limits the output to only indexes of the specified Type, either
	// LOCAL or AGGREGATOR.
	//
	// Use this option to discover the aggregator index for your account.
	Type *string `type:"string" enum:"IndexType"`
	// contains filtered or unexported fields
}

func (ListIndexesInput) GoString

func (s ListIndexesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndexesInput) SetMaxResults

func (s *ListIndexesInput) SetMaxResults(v int64) *ListIndexesInput

SetMaxResults sets the MaxResults field's value.

func (*ListIndexesInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListIndexesInput) SetRegions

func (s *ListIndexesInput) SetRegions(v []*string) *ListIndexesInput

SetRegions sets the Regions field's value.

func (*ListIndexesInput) SetType

func (s *ListIndexesInput) SetType(v string) *ListIndexesInput

SetType sets the Type field's value.

func (ListIndexesInput) String

func (s ListIndexesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndexesInput) Validate

func (s *ListIndexesInput) Validate() error

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

type ListIndexesOutput

type ListIndexesOutput struct {

	// A structure that contains the details and status of each index.
	Indexes []*Index `type:"list"`

	// If present, indicates that more output is available than is included in the
	// current response. Use this value in the NextToken request parameter in a
	// subsequent call to the operation to get the next part of the output. You
	// should repeat this until the NextToken response element comes back as null.
	// The pagination tokens expire after 24 hours.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListIndexesOutput) GoString

func (s ListIndexesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndexesOutput) SetIndexes

func (s *ListIndexesOutput) SetIndexes(v []*Index) *ListIndexesOutput

SetIndexes sets the Indexes field's value.

func (*ListIndexesOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListIndexesOutput) String

func (s ListIndexesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSupportedResourceTypesInput

type ListSupportedResourceTypesInput struct {

	// The maximum number of results that you want included on each page of the
	// response. If you do not include this parameter, it defaults to a value appropriate
	// to the operation. If additional items exist beyond those included in the
	// current response, the NextToken response element is present and has a value
	// (is not null). Include that value as the NextToken request parameter in the
	// next call to the operation to get the next part of the results.
	//
	// An API operation can return fewer results than the maximum even when there
	// are more results available. You should check NextToken after every operation
	// to ensure that you receive all of the results.
	MaxResults *int64 `min:"1" type:"integer"`

	// The parameter for receiving additional results if you receive a NextToken
	// response in a previous request. A NextToken response indicates that more
	// output is available. Set this parameter to the value of the previous call's
	// NextToken response to indicate where the output should continue from. The
	// pagination tokens expire after 24 hours.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSupportedResourceTypesInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSupportedResourceTypesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListSupportedResourceTypesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListSupportedResourceTypesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSupportedResourceTypesInput) Validate

func (s *ListSupportedResourceTypesInput) Validate() error

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

type ListSupportedResourceTypesOutput

type ListSupportedResourceTypesOutput struct {

	// If present, indicates that more output is available than is included in the
	// current response. Use this value in the NextToken request parameter in a
	// subsequent call to the operation to get the next part of the output. You
	// should repeat this until the NextToken response element comes back as null.
	// The pagination tokens expire after 24 hours.
	NextToken *string `type:"string"`

	// The list of resource types supported by Resource Explorer.
	ResourceTypes []*SupportedResourceType `type:"list"`
	// contains filtered or unexported fields
}

func (ListSupportedResourceTypesOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSupportedResourceTypesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListSupportedResourceTypesOutput) SetResourceTypes

SetResourceTypes sets the ResourceTypes field's value.

func (ListSupportedResourceTypesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view or index that you want to attach tags to.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tag key and value pairs that you want to attach to the specified view
	// or index.
	//
	// Tags is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListTagsForResourceOutput's
	// String and GoString methods.
	Tags map[string]*string `type:"map" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListViewsInput

type ListViewsInput struct {

	// The maximum number of results that you want included on each page of the
	// response. If you do not include this parameter, it defaults to a value appropriate
	// to the operation. If additional items exist beyond those included in the
	// current response, the NextToken response element is present and has a value
	// (is not null). Include that value as the NextToken request parameter in the
	// next call to the operation to get the next part of the results.
	//
	// An API operation can return fewer results than the maximum even when there
	// are more results available. You should check NextToken after every operation
	// to ensure that you receive all of the results.
	MaxResults *int64 `min:"1" type:"integer"`

	// The parameter for receiving additional results if you receive a NextToken
	// response in a previous request. A NextToken response indicates that more
	// output is available. Set this parameter to the value of the previous call's
	// NextToken response to indicate where the output should continue from. The
	// pagination tokens expire after 24 hours.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListViewsInput) GoString

func (s ListViewsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListViewsInput) SetMaxResults

func (s *ListViewsInput) SetMaxResults(v int64) *ListViewsInput

SetMaxResults sets the MaxResults field's value.

func (*ListViewsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListViewsInput) String

func (s ListViewsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListViewsInput) Validate

func (s *ListViewsInput) Validate() error

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

type ListViewsOutput

type ListViewsOutput struct {

	// If present, indicates that more output is available than is included in the
	// current response. Use this value in the NextToken request parameter in a
	// subsequent call to the operation to get the next part of the output. You
	// should repeat this until the NextToken response element comes back as null.
	// The pagination tokens expire after 24 hours.
	NextToken *string `type:"string"`

	// The list of views available in the Amazon Web Services Region in which you
	// called this operation.
	Views []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListViewsOutput) GoString

func (s ListViewsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListViewsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListViewsOutput) SetViews

func (s *ListViewsOutput) SetViews(v []*string) *ListViewsOutput

SetViews sets the Views field's value.

func (ListViewsOutput) String

func (s ListViewsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MemberIndex added in v1.47.11

type MemberIndex struct {

	// The account ID for the index.
	AccountId *string `type:"string"`

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the index.
	Arn *string `type:"string"`

	// The Amazon Web Services Region in which the index exists.
	Region *string `type:"string"`

	// The type of index. It can be one of the following values:
	//
	//    * LOCAL – The index contains information about resources from only the
	//    same Amazon Web Services Region.
	//
	//    * AGGREGATOR – Resource Explorer replicates copies of the indexed information
	//    about resources in all other Amazon Web Services Regions to the aggregator
	//    index. This lets search results in the Region with the aggregator index
	//    to include resources from all Regions in the account where Resource Explorer
	//    is turned on.
	Type *string `type:"string" enum:"IndexType"`
	// contains filtered or unexported fields
}

An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers.

func (MemberIndex) GoString added in v1.47.11

func (s MemberIndex) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemberIndex) SetAccountId added in v1.47.11

func (s *MemberIndex) SetAccountId(v string) *MemberIndex

SetAccountId sets the AccountId field's value.

func (*MemberIndex) SetArn added in v1.47.11

func (s *MemberIndex) SetArn(v string) *MemberIndex

SetArn sets the Arn field's value.

func (*MemberIndex) SetRegion added in v1.47.11

func (s *MemberIndex) SetRegion(v string) *MemberIndex

SetRegion sets the Region field's value.

func (*MemberIndex) SetType added in v1.47.11

func (s *MemberIndex) SetType(v string) *MemberIndex

SetType sets the Type field's value.

func (MemberIndex) String added in v1.47.11

func (s MemberIndex) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OrgConfiguration added in v1.47.11

type OrgConfiguration struct {

	// This value displays whether your Amazon Web Services service access is ENABLED
	// or DISABLED.
	//
	// AWSServiceAccessStatus is a required field
	AWSServiceAccessStatus *string `type:"string" required:"true" enum:"AWSServiceAccessStatus"`

	// This value shows whether or not you have a valid a service-linked role required
	// to start the multi-account search feature.
	ServiceLinkedRole *string `type:"string"`
	// contains filtered or unexported fields
}

This is a structure that contains the status of Amazon Web Services service access, and whether you have a valid service-linked role to enable multi-account search for your organization.

func (OrgConfiguration) GoString added in v1.47.11

func (s OrgConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrgConfiguration) SetAWSServiceAccessStatus added in v1.47.11

func (s *OrgConfiguration) SetAWSServiceAccessStatus(v string) *OrgConfiguration

SetAWSServiceAccessStatus sets the AWSServiceAccessStatus field's value.

func (*OrgConfiguration) SetServiceLinkedRole added in v1.47.11

func (s *OrgConfiguration) SetServiceLinkedRole(v string) *OrgConfiguration

SetServiceLinkedRole sets the ServiceLinkedRole field's value.

func (OrgConfiguration) String added in v1.47.11

func (s OrgConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Resource

type Resource struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource.
	Arn *string `type:"string"`

	// The date and time that Resource Explorer last queried this resource and updated
	// the index with the latest information about the resource.
	LastReportedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The Amazon Web Services account that owns the resource.
	OwningAccountId *string `type:"string"`

	// A structure with additional type-specific details about the resource. These
	// properties can be added by turning on integration between Resource Explorer
	// and other Amazon Web Services services.
	Properties []*ResourceProperty `type:"list"`

	// The Amazon Web Services Region in which the resource was created and exists.
	Region *string `type:"string"`

	// The type of the resource.
	ResourceType *string `type:"string"`

	// The Amazon Web Service that owns the resource and is responsible for creating
	// and updating it.
	Service *string `type:"string"`
	// contains filtered or unexported fields
}

A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored information in the index of the Amazon Web Services Region that contains the resource.

func (Resource) GoString

func (s Resource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Resource) SetArn

func (s *Resource) SetArn(v string) *Resource

SetArn sets the Arn field's value.

func (*Resource) SetLastReportedAt

func (s *Resource) SetLastReportedAt(v time.Time) *Resource

SetLastReportedAt sets the LastReportedAt field's value.

func (*Resource) SetOwningAccountId

func (s *Resource) SetOwningAccountId(v string) *Resource

SetOwningAccountId sets the OwningAccountId field's value.

func (*Resource) SetProperties

func (s *Resource) SetProperties(v []*ResourceProperty) *Resource

SetProperties sets the Properties field's value.

func (*Resource) SetRegion

func (s *Resource) SetRegion(v string) *Resource

SetRegion sets the Region field's value.

func (*Resource) SetResourceType

func (s *Resource) SetResourceType(v string) *Resource

SetResourceType sets the ResourceType field's value.

func (*Resource) SetService

func (s *Resource) SetService(v string) *Resource

SetService sets the Service field's value.

func (Resource) String

func (s Resource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceCount

type ResourceCount struct {

	// Indicates whether the TotalResources value represents an exhaustive count
	// of search results.
	//
	//    * If True, it indicates that the search was exhaustive. Every resource
	//    that matches the query was counted.
	//
	//    * If False, then the search reached the limit of 1,000 matching results,
	//    and stopped counting.
	Complete *bool `type:"boolean"`

	// The number of resources that match the search query. This value can't exceed
	// 1,000. If there are more than 1,000 resources that match the query, then
	// only 1,000 are counted and the Complete field is set to false. We recommend
	// that you refine your query to return a smaller number of results.
	TotalResources *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer doesn't count more than 1,000 matches for any query. This structure provides information about whether the query exceeded this limit.

This field is included in every page when you paginate the results.

func (ResourceCount) GoString

func (s ResourceCount) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceCount) SetComplete

func (s *ResourceCount) SetComplete(v bool) *ResourceCount

SetComplete sets the Complete field's value.

func (*ResourceCount) SetTotalResources

func (s *ResourceCount) SetTotalResources(v int64) *ResourceCount

SetTotalResources sets the TotalResources field's value.

func (ResourceCount) String

func (s ResourceCount) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceExplorer2

type ResourceExplorer2 struct {
	*client.Client
}

ResourceExplorer2 provides the API operation methods for making requests to AWS Resource Explorer. See this package's package overview docs for details on the service.

ResourceExplorer2 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 ResourceExplorer2 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:

mySession := session.Must(session.NewSession())

// Create a ResourceExplorer2 client from just a session.
svc := resourceexplorer2.New(mySession)

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

func (*ResourceExplorer2) AssociateDefaultView

AssociateDefaultView API operation for AWS Resource Explorer.

Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn't explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region.

If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.

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 Resource Explorer's API operation AssociateDefaultView for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/AssociateDefaultView

func (*ResourceExplorer2) AssociateDefaultViewRequest

func (c *ResourceExplorer2) AssociateDefaultViewRequest(input *AssociateDefaultViewInput) (req *request.Request, output *AssociateDefaultViewOutput)

AssociateDefaultViewRequest generates a "aws/request.Request" representing the client's request for the AssociateDefaultView 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 AssociateDefaultView for more information on using the AssociateDefaultView 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 AssociateDefaultViewRequest method.
req, resp := client.AssociateDefaultViewRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/AssociateDefaultView

func (*ResourceExplorer2) AssociateDefaultViewWithContext

func (c *ResourceExplorer2) AssociateDefaultViewWithContext(ctx aws.Context, input *AssociateDefaultViewInput, opts ...request.Option) (*AssociateDefaultViewOutput, error)

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

See AssociateDefaultView 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 (*ResourceExplorer2) BatchGetView

func (c *ResourceExplorer2) BatchGetView(input *BatchGetViewInput) (*BatchGetViewOutput, error)

BatchGetView API operation for AWS Resource Explorer.

Retrieves details about a list of views.

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 Resource Explorer's API operation BatchGetView for usage and error information.

Returned Error Types:

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • UnauthorizedException The principal making the request isn't permitted to perform the operation.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/BatchGetView

func (*ResourceExplorer2) BatchGetViewRequest

func (c *ResourceExplorer2) BatchGetViewRequest(input *BatchGetViewInput) (req *request.Request, output *BatchGetViewOutput)

BatchGetViewRequest generates a "aws/request.Request" representing the client's request for the BatchGetView 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 BatchGetView for more information on using the BatchGetView 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 BatchGetViewRequest method.
req, resp := client.BatchGetViewRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/BatchGetView

func (*ResourceExplorer2) BatchGetViewWithContext

func (c *ResourceExplorer2) BatchGetViewWithContext(ctx aws.Context, input *BatchGetViewInput, opts ...request.Option) (*BatchGetViewOutput, error)

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

See BatchGetView 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 (*ResourceExplorer2) CreateIndex

func (c *ResourceExplorer2) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error)

CreateIndex API operation for AWS Resource Explorer.

Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.

This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) in the Amazon Web Services Resource Explorer User Guide.

For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html) in the Amazon Web Services Resource Explorer User Guide.

If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role (https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html) in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.

  • Action: resource-explorer-2:CreateIndex Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (*) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account. "Resource": "arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*" Alternatively, you can use "Resource": "*" to allow the role or user to create an index in any Region.

  • Action: iam:CreateServiceLinkedRole Resource: No specific resource (*). This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account (https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html). Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.

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 Resource Explorer's API operation CreateIndex for usage and error information.

Returned Error Types:

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ConflictException If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region.

    If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.

    If you attempted to update an index type to AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different Amazon Web Services Region.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateIndex

func (*ResourceExplorer2) CreateIndexRequest

func (c *ResourceExplorer2) CreateIndexRequest(input *CreateIndexInput) (req *request.Request, output *CreateIndexOutput)

CreateIndexRequest generates a "aws/request.Request" representing the client's request for the CreateIndex 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 CreateIndex for more information on using the CreateIndex 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 CreateIndexRequest method.
req, resp := client.CreateIndexRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateIndex

func (*ResourceExplorer2) CreateIndexWithContext

func (c *ResourceExplorer2) CreateIndexWithContext(ctx aws.Context, input *CreateIndexInput, opts ...request.Option) (*CreateIndexOutput, error)

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

See CreateIndex 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 (*ResourceExplorer2) CreateView

func (c *ResourceExplorer2) CreateView(input *CreateViewInput) (*CreateViewOutput, error)

CreateView API operation for AWS Resource Explorer.

Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views.html) in the Amazon Web Services Resource Explorer User Guide.

Only the principals with an IAM identity-based policy that grants Allow to the Search action on a Resource with the Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of this view can Search using views you create with this operation.

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 Resource Explorer's API operation CreateView for usage and error information.

Returned Error Types:

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ConflictException If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region.

    If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.

    If you attempted to update an index type to AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different Amazon Web Services Region.

  • ServiceQuotaExceededException The request failed because it exceeds a service quota.

  • UnauthorizedException The principal making the request isn't permitted to perform the operation.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateView

func (*ResourceExplorer2) CreateViewRequest

func (c *ResourceExplorer2) CreateViewRequest(input *CreateViewInput) (req *request.Request, output *CreateViewOutput)

CreateViewRequest generates a "aws/request.Request" representing the client's request for the CreateView 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 CreateView for more information on using the CreateView 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 CreateViewRequest method.
req, resp := client.CreateViewRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateView

func (*ResourceExplorer2) CreateViewWithContext

func (c *ResourceExplorer2) CreateViewWithContext(ctx aws.Context, input *CreateViewInput, opts ...request.Option) (*CreateViewOutput, error)

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

See CreateView 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 (*ResourceExplorer2) DeleteIndex

func (c *ResourceExplorer2) DeleteIndex(input *DeleteIndexInput) (*DeleteIndexOutput, error)

DeleteIndex API operation for AWS Resource Explorer.

Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status response value.

If the index you delete is the aggregator index for the Amazon Web Services account, you must wait 24 hours before you can promote another local index to be the aggregator index for the account. Users can't perform account-wide searches using Resource Explorer until another aggregator index is configured.

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 Resource Explorer's API operation DeleteIndex for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteIndex

func (*ResourceExplorer2) DeleteIndexRequest

func (c *ResourceExplorer2) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput)

DeleteIndexRequest generates a "aws/request.Request" representing the client's request for the DeleteIndex 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 DeleteIndex for more information on using the DeleteIndex 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 DeleteIndexRequest method.
req, resp := client.DeleteIndexRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteIndex

func (*ResourceExplorer2) DeleteIndexWithContext

func (c *ResourceExplorer2) DeleteIndexWithContext(ctx aws.Context, input *DeleteIndexInput, opts ...request.Option) (*DeleteIndexOutput, error)

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

See DeleteIndex 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 (*ResourceExplorer2) DeleteView

func (c *ResourceExplorer2) DeleteView(input *DeleteViewInput) (*DeleteViewOutput, error)

DeleteView API operation for AWS Resource Explorer.

Deletes the specified view.

If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation.

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 Resource Explorer's API operation DeleteView for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • UnauthorizedException The principal making the request isn't permitted to perform the operation.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteView

func (*ResourceExplorer2) DeleteViewRequest

func (c *ResourceExplorer2) DeleteViewRequest(input *DeleteViewInput) (req *request.Request, output *DeleteViewOutput)

DeleteViewRequest generates a "aws/request.Request" representing the client's request for the DeleteView 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 DeleteView for more information on using the DeleteView 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 DeleteViewRequest method.
req, resp := client.DeleteViewRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteView

func (*ResourceExplorer2) DeleteViewWithContext

func (c *ResourceExplorer2) DeleteViewWithContext(ctx aws.Context, input *DeleteViewInput, opts ...request.Option) (*DeleteViewOutput, error)

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

See DeleteView 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 (*ResourceExplorer2) DisassociateDefaultView

DisassociateDefaultView API operation for AWS Resource Explorer.

After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.

If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.

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 Resource Explorer's API operation DisassociateDefaultView for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DisassociateDefaultView

func (*ResourceExplorer2) DisassociateDefaultViewRequest

func (c *ResourceExplorer2) DisassociateDefaultViewRequest(input *DisassociateDefaultViewInput) (req *request.Request, output *DisassociateDefaultViewOutput)

DisassociateDefaultViewRequest generates a "aws/request.Request" representing the client's request for the DisassociateDefaultView 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 DisassociateDefaultView for more information on using the DisassociateDefaultView 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 DisassociateDefaultViewRequest method.
req, resp := client.DisassociateDefaultViewRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DisassociateDefaultView

func (*ResourceExplorer2) DisassociateDefaultViewWithContext

func (c *ResourceExplorer2) DisassociateDefaultViewWithContext(ctx aws.Context, input *DisassociateDefaultViewInput, opts ...request.Option) (*DisassociateDefaultViewOutput, error)

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

See DisassociateDefaultView 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 (*ResourceExplorer2) GetAccountLevelServiceConfiguration added in v1.47.11

GetAccountLevelServiceConfiguration API operation for AWS Resource Explorer.

Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account or a delegated administrator with service access enabled can invoke this API call.

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 Resource Explorer's API operation GetAccountLevelServiceConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetAccountLevelServiceConfiguration

func (*ResourceExplorer2) GetAccountLevelServiceConfigurationRequest added in v1.47.11

func (c *ResourceExplorer2) GetAccountLevelServiceConfigurationRequest(input *GetAccountLevelServiceConfigurationInput) (req *request.Request, output *GetAccountLevelServiceConfigurationOutput)

GetAccountLevelServiceConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetAccountLevelServiceConfiguration 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 GetAccountLevelServiceConfiguration for more information on using the GetAccountLevelServiceConfiguration 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 GetAccountLevelServiceConfigurationRequest method.
req, resp := client.GetAccountLevelServiceConfigurationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetAccountLevelServiceConfiguration

func (*ResourceExplorer2) GetAccountLevelServiceConfigurationWithContext added in v1.47.11

func (c *ResourceExplorer2) GetAccountLevelServiceConfigurationWithContext(ctx aws.Context, input *GetAccountLevelServiceConfigurationInput, opts ...request.Option) (*GetAccountLevelServiceConfigurationOutput, error)

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

See GetAccountLevelServiceConfiguration 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 (*ResourceExplorer2) GetDefaultView

func (c *ResourceExplorer2) GetDefaultView(input *GetDefaultViewInput) (*GetDefaultViewOutput, error)

GetDefaultView API operation for AWS Resource Explorer.

Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.

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 Resource Explorer's API operation GetDefaultView for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetDefaultView

func (*ResourceExplorer2) GetDefaultViewRequest

func (c *ResourceExplorer2) GetDefaultViewRequest(input *GetDefaultViewInput) (req *request.Request, output *GetDefaultViewOutput)

GetDefaultViewRequest generates a "aws/request.Request" representing the client's request for the GetDefaultView 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 GetDefaultView for more information on using the GetDefaultView 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 GetDefaultViewRequest method.
req, resp := client.GetDefaultViewRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetDefaultView

func (*ResourceExplorer2) GetDefaultViewWithContext

func (c *ResourceExplorer2) GetDefaultViewWithContext(ctx aws.Context, input *GetDefaultViewInput, opts ...request.Option) (*GetDefaultViewOutput, error)

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

See GetDefaultView 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 (*ResourceExplorer2) GetIndex

func (c *ResourceExplorer2) GetIndex(input *GetIndexInput) (*GetIndexOutput, error)

GetIndex API operation for AWS Resource Explorer.

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.

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 Resource Explorer's API operation GetIndex for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetIndex

func (*ResourceExplorer2) GetIndexRequest

func (c *ResourceExplorer2) GetIndexRequest(input *GetIndexInput) (req *request.Request, output *GetIndexOutput)

GetIndexRequest generates a "aws/request.Request" representing the client's request for the GetIndex 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 GetIndex for more information on using the GetIndex 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 GetIndexRequest method.
req, resp := client.GetIndexRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetIndex

func (*ResourceExplorer2) GetIndexWithContext

func (c *ResourceExplorer2) GetIndexWithContext(ctx aws.Context, input *GetIndexInput, opts ...request.Option) (*GetIndexOutput, error)

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

See GetIndex 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 (*ResourceExplorer2) GetView

func (c *ResourceExplorer2) GetView(input *GetViewInput) (*GetViewOutput, error)

GetView API operation for AWS Resource Explorer.

Retrieves details of the specified view.

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 Resource Explorer's API operation GetView for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • UnauthorizedException The principal making the request isn't permitted to perform the operation.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetView

func (*ResourceExplorer2) GetViewRequest

func (c *ResourceExplorer2) GetViewRequest(input *GetViewInput) (req *request.Request, output *GetViewOutput)

GetViewRequest generates a "aws/request.Request" representing the client's request for the GetView 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 GetView for more information on using the GetView 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 GetViewRequest method.
req, resp := client.GetViewRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetView

func (*ResourceExplorer2) GetViewWithContext

func (c *ResourceExplorer2) GetViewWithContext(ctx aws.Context, input *GetViewInput, opts ...request.Option) (*GetViewOutput, error)

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

See GetView 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 (*ResourceExplorer2) ListIndexes

func (c *ResourceExplorer2) ListIndexes(input *ListIndexesInput) (*ListIndexesOutput, error)

ListIndexes API operation for AWS Resource Explorer.

Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.

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 Resource Explorer's API operation ListIndexes for usage and error information.

Returned Error Types:

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListIndexes

func (*ResourceExplorer2) ListIndexesForMembers added in v1.47.11

ListIndexesForMembers API operation for AWS Resource Explorer.

Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.

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 Resource Explorer's API operation ListIndexesForMembers for usage and error information.

Returned Error Types:

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListIndexesForMembers

func (*ResourceExplorer2) ListIndexesForMembersPages added in v1.47.11

func (c *ResourceExplorer2) ListIndexesForMembersPages(input *ListIndexesForMembersInput, fn func(*ListIndexesForMembersOutput, bool) bool) error

ListIndexesForMembersPages iterates over the pages of a ListIndexesForMembers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIndexesForMembers 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 ListIndexesForMembers operation.
pageNum := 0
err := client.ListIndexesForMembersPages(params,
    func(page *resourceexplorer2.ListIndexesForMembersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceExplorer2) ListIndexesForMembersPagesWithContext added in v1.47.11

func (c *ResourceExplorer2) ListIndexesForMembersPagesWithContext(ctx aws.Context, input *ListIndexesForMembersInput, fn func(*ListIndexesForMembersOutput, bool) bool, opts ...request.Option) error

ListIndexesForMembersPagesWithContext same as ListIndexesForMembersPages 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 (*ResourceExplorer2) ListIndexesForMembersRequest added in v1.47.11

func (c *ResourceExplorer2) ListIndexesForMembersRequest(input *ListIndexesForMembersInput) (req *request.Request, output *ListIndexesForMembersOutput)

ListIndexesForMembersRequest generates a "aws/request.Request" representing the client's request for the ListIndexesForMembers 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 ListIndexesForMembers for more information on using the ListIndexesForMembers 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 ListIndexesForMembersRequest method.
req, resp := client.ListIndexesForMembersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListIndexesForMembers

func (*ResourceExplorer2) ListIndexesForMembersWithContext added in v1.47.11

func (c *ResourceExplorer2) ListIndexesForMembersWithContext(ctx aws.Context, input *ListIndexesForMembersInput, opts ...request.Option) (*ListIndexesForMembersOutput, error)

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

See ListIndexesForMembers 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 (*ResourceExplorer2) ListIndexesPages

func (c *ResourceExplorer2) ListIndexesPages(input *ListIndexesInput, fn func(*ListIndexesOutput, bool) bool) error

ListIndexesPages iterates over the pages of a ListIndexes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIndexes 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 ListIndexes operation.
pageNum := 0
err := client.ListIndexesPages(params,
    func(page *resourceexplorer2.ListIndexesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceExplorer2) ListIndexesPagesWithContext

func (c *ResourceExplorer2) ListIndexesPagesWithContext(ctx aws.Context, input *ListIndexesInput, fn func(*ListIndexesOutput, bool) bool, opts ...request.Option) error

ListIndexesPagesWithContext same as ListIndexesPages 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 (*ResourceExplorer2) ListIndexesRequest

func (c *ResourceExplorer2) ListIndexesRequest(input *ListIndexesInput) (req *request.Request, output *ListIndexesOutput)

ListIndexesRequest generates a "aws/request.Request" representing the client's request for the ListIndexes 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 ListIndexes for more information on using the ListIndexes 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 ListIndexesRequest method.
req, resp := client.ListIndexesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListIndexes

func (*ResourceExplorer2) ListIndexesWithContext

func (c *ResourceExplorer2) ListIndexesWithContext(ctx aws.Context, input *ListIndexesInput, opts ...request.Option) (*ListIndexesOutput, error)

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

See ListIndexes 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 (*ResourceExplorer2) ListSupportedResourceTypes

ListSupportedResourceTypes API operation for AWS Resource Explorer.

Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.

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 Resource Explorer's API operation ListSupportedResourceTypes for usage and error information.

Returned Error Types:

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListSupportedResourceTypes

func (*ResourceExplorer2) ListSupportedResourceTypesPages

func (c *ResourceExplorer2) ListSupportedResourceTypesPages(input *ListSupportedResourceTypesInput, fn func(*ListSupportedResourceTypesOutput, bool) bool) error

ListSupportedResourceTypesPages iterates over the pages of a ListSupportedResourceTypes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSupportedResourceTypes 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 ListSupportedResourceTypes operation.
pageNum := 0
err := client.ListSupportedResourceTypesPages(params,
    func(page *resourceexplorer2.ListSupportedResourceTypesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceExplorer2) ListSupportedResourceTypesPagesWithContext

func (c *ResourceExplorer2) ListSupportedResourceTypesPagesWithContext(ctx aws.Context, input *ListSupportedResourceTypesInput, fn func(*ListSupportedResourceTypesOutput, bool) bool, opts ...request.Option) error

ListSupportedResourceTypesPagesWithContext same as ListSupportedResourceTypesPages 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 (*ResourceExplorer2) ListSupportedResourceTypesRequest

func (c *ResourceExplorer2) ListSupportedResourceTypesRequest(input *ListSupportedResourceTypesInput) (req *request.Request, output *ListSupportedResourceTypesOutput)

ListSupportedResourceTypesRequest generates a "aws/request.Request" representing the client's request for the ListSupportedResourceTypes 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 ListSupportedResourceTypes for more information on using the ListSupportedResourceTypes 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 ListSupportedResourceTypesRequest method.
req, resp := client.ListSupportedResourceTypesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListSupportedResourceTypes

func (*ResourceExplorer2) ListSupportedResourceTypesWithContext

func (c *ResourceExplorer2) ListSupportedResourceTypesWithContext(ctx aws.Context, input *ListSupportedResourceTypesInput, opts ...request.Option) (*ListSupportedResourceTypesOutput, error)

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

See ListSupportedResourceTypes 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 (*ResourceExplorer2) ListTagsForResource

ListTagsForResource API operation for AWS Resource Explorer.

Lists the tags that are attached to the specified resource.

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 Resource Explorer's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • UnauthorizedException The principal making the request isn't permitted to perform the operation.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListTagsForResource

func (*ResourceExplorer2) ListTagsForResourceRequest

func (c *ResourceExplorer2) 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/resource-explorer-2-2022-07-28/ListTagsForResource

func (*ResourceExplorer2) ListTagsForResourceWithContext

func (c *ResourceExplorer2) 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 (*ResourceExplorer2) ListViews

func (c *ResourceExplorer2) ListViews(input *ListViewsInput) (*ListViewsOutput, error)

ListViews API operation for AWS Resource Explorer.

Lists the Amazon resource names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the views available in the Amazon Web Services Region in which you call this operation.

Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

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 Resource Explorer's API operation ListViews for usage and error information.

Returned Error Types:

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListViews

func (*ResourceExplorer2) ListViewsPages

func (c *ResourceExplorer2) ListViewsPages(input *ListViewsInput, fn func(*ListViewsOutput, bool) bool) error

ListViewsPages iterates over the pages of a ListViews operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListViews 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 ListViews operation.
pageNum := 0
err := client.ListViewsPages(params,
    func(page *resourceexplorer2.ListViewsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceExplorer2) ListViewsPagesWithContext

func (c *ResourceExplorer2) ListViewsPagesWithContext(ctx aws.Context, input *ListViewsInput, fn func(*ListViewsOutput, bool) bool, opts ...request.Option) error

ListViewsPagesWithContext same as ListViewsPages 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 (*ResourceExplorer2) ListViewsRequest

func (c *ResourceExplorer2) ListViewsRequest(input *ListViewsInput) (req *request.Request, output *ListViewsOutput)

ListViewsRequest generates a "aws/request.Request" representing the client's request for the ListViews 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 ListViews for more information on using the ListViews 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 ListViewsRequest method.
req, resp := client.ListViewsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListViews

func (*ResourceExplorer2) ListViewsWithContext

func (c *ResourceExplorer2) ListViewsWithContext(ctx aws.Context, input *ListViewsInput, opts ...request.Option) (*ListViewsOutput, error)

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

See ListViews 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 (*ResourceExplorer2) Search

func (c *ResourceExplorer2) Search(input *SearchInput) (*SearchOutput, error)

Search API operation for AWS Resource Explorer.

Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.

All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString parameter supplied to this operation and the SearchFilter parameter attached to the view.

For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html).

If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search (https://docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.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 Resource Explorer's API operation Search for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • UnauthorizedException The principal making the request isn't permitted to perform the operation.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/Search

func (*ResourceExplorer2) SearchPages

func (c *ResourceExplorer2) SearchPages(input *SearchInput, fn func(*SearchOutput, bool) bool) error

SearchPages iterates over the pages of a Search operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See Search 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 Search operation.
pageNum := 0
err := client.SearchPages(params,
    func(page *resourceexplorer2.SearchOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceExplorer2) SearchPagesWithContext

func (c *ResourceExplorer2) SearchPagesWithContext(ctx aws.Context, input *SearchInput, fn func(*SearchOutput, bool) bool, opts ...request.Option) error

SearchPagesWithContext same as SearchPages 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 (*ResourceExplorer2) SearchRequest

func (c *ResourceExplorer2) SearchRequest(input *SearchInput) (req *request.Request, output *SearchOutput)

SearchRequest generates a "aws/request.Request" representing the client's request for the Search 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 Search for more information on using the Search 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 SearchRequest method.
req, resp := client.SearchRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/Search

func (*ResourceExplorer2) SearchWithContext

func (c *ResourceExplorer2) SearchWithContext(ctx aws.Context, input *SearchInput, opts ...request.Option) (*SearchOutput, error)

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

See Search 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 (*ResourceExplorer2) TagResource

func (c *ResourceExplorer2) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Resource Explorer.

Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.

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 Resource Explorer's API operation TagResource for usage and error information.

Returned Error Types:

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ConflictException If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region.

    If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.

    If you attempted to update an index type to AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different Amazon Web Services Region.

  • UnauthorizedException The principal making the request isn't permitted to perform the operation.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/TagResource

func (*ResourceExplorer2) TagResourceRequest

func (c *ResourceExplorer2) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/TagResource

func (*ResourceExplorer2) TagResourceWithContext

func (c *ResourceExplorer2) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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 (*ResourceExplorer2) UntagResource

func (c *ResourceExplorer2) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Resource Explorer.

Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.

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 Resource Explorer's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • UnauthorizedException The principal making the request isn't permitted to perform the operation.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UntagResource

func (*ResourceExplorer2) UntagResourceRequest

func (c *ResourceExplorer2) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UntagResource

func (*ResourceExplorer2) UntagResourceWithContext

func (c *ResourceExplorer2) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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 (*ResourceExplorer2) UpdateIndexType

func (c *ResourceExplorer2) UpdateIndexType(input *UpdateIndexTypeInput) (*UpdateIndexTypeOutput, error)

UpdateIndexType API operation for AWS Resource Explorer.

Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) in the Amazon Web Services Resource Explorer User Guide.

  • AGGREGATOR index type The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index. When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete. You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.

  • LOCAL index type The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index. When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results. After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.

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 Resource Explorer's API operation UpdateIndexType for usage and error information.

Returned Error Types:

  • ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ConflictException If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region.

    If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.

    If you attempted to update an index type to AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different Amazon Web Services Region.

  • ServiceQuotaExceededException The request failed because it exceeds a service quota.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateIndexType

func (*ResourceExplorer2) UpdateIndexTypeRequest

func (c *ResourceExplorer2) UpdateIndexTypeRequest(input *UpdateIndexTypeInput) (req *request.Request, output *UpdateIndexTypeOutput)

UpdateIndexTypeRequest generates a "aws/request.Request" representing the client's request for the UpdateIndexType 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 UpdateIndexType for more information on using the UpdateIndexType 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 UpdateIndexTypeRequest method.
req, resp := client.UpdateIndexTypeRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateIndexType

func (*ResourceExplorer2) UpdateIndexTypeWithContext

func (c *ResourceExplorer2) UpdateIndexTypeWithContext(ctx aws.Context, input *UpdateIndexTypeInput, opts ...request.Option) (*UpdateIndexTypeOutput, error)

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

See UpdateIndexType 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 (*ResourceExplorer2) UpdateView

func (c *ResourceExplorer2) UpdateView(input *UpdateViewInput) (*UpdateViewOutput, error)

UpdateView API operation for AWS Resource Explorer.

Modifies some of the details of a view. You can change the filter string and the list of included properties. You can't change the name of the view.

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 Resource Explorer's API operation UpdateView for usage and error information.

Returned Error Types:

  • InternalServerException The request failed because of internal service error. Try your request again later.

  • ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

  • ServiceQuotaExceededException The request failed because it exceeds a service quota.

  • UnauthorizedException The principal making the request isn't permitted to perform the operation.

  • ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

  • AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateView

func (*ResourceExplorer2) UpdateViewRequest

func (c *ResourceExplorer2) UpdateViewRequest(input *UpdateViewInput) (req *request.Request, output *UpdateViewOutput)

UpdateViewRequest generates a "aws/request.Request" representing the client's request for the UpdateView 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 UpdateView for more information on using the UpdateView 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 UpdateViewRequest method.
req, resp := client.UpdateViewRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateView

func (*ResourceExplorer2) UpdateViewWithContext

func (c *ResourceExplorer2) UpdateViewWithContext(ctx aws.Context, input *UpdateViewInput, opts ...request.Option) (*UpdateViewOutput, error)

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

See UpdateView 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 ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceProperty

type ResourceProperty struct {

	// The date and time that the information about this resource property was last
	// updated.
	LastReportedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

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

A structure that describes a property of a resource.

func (ResourceProperty) GoString

func (s ResourceProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceProperty) SetLastReportedAt

func (s *ResourceProperty) SetLastReportedAt(v time.Time) *ResourceProperty

SetLastReportedAt sets the LastReportedAt field's value.

func (*ResourceProperty) SetName

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

SetName sets the Name field's value.

func (ResourceProperty) String

func (s ResourceProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchFilter

type SearchFilter struct {

	// The string that contains the search keywords, prefixes, and operators to
	// control the results that can be returned by a Search operation. For more
	// details, see Search query syntax (https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html).
	//
	// FilterString is a required field
	FilterString *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A search filter defines which resources can be part of a search query result set.

func (SearchFilter) GoString

func (s SearchFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchFilter) SetFilterString

func (s *SearchFilter) SetFilterString(v string) *SearchFilter

SetFilterString sets the FilterString field's value.

func (SearchFilter) String

func (s SearchFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchFilter) Validate

func (s *SearchFilter) Validate() error

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

type SearchInput

type SearchInput struct {

	// The maximum number of results that you want included on each page of the
	// response. If you do not include this parameter, it defaults to a value appropriate
	// to the operation. If additional items exist beyond those included in the
	// current response, the NextToken response element is present and has a value
	// (is not null). Include that value as the NextToken request parameter in the
	// next call to the operation to get the next part of the results.
	//
	// An API operation can return fewer results than the maximum even when there
	// are more results available. You should check NextToken after every operation
	// to ensure that you receive all of the results.
	MaxResults *int64 `min:"1" type:"integer"`

	// The parameter for receiving additional results if you receive a NextToken
	// response in a previous request. A NextToken response indicates that more
	// output is available. Set this parameter to the value of the previous call's
	// NextToken response to indicate where the output should continue from. The
	// pagination tokens expire after 24 hours.
	NextToken *string `min:"1" type:"string"`

	// A string that includes keywords and filters that specify the resources that
	// you want to include in the results.
	//
	// For the complete syntax supported by the QueryString parameter, see Search
	// query syntax reference for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html).
	//
	// The search is completely case insensitive. You can specify an empty string
	// to return all results up to the limit of 1,000 total results.
	//
	// The operation can return only the first 1,000 results. If the resource you
	// want is not included, then use a different value for QueryString to refine
	// the results.
	//
	// QueryString is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchInput's
	// String and GoString methods.
	//
	// QueryString is a required field
	QueryString *string `type:"string" required:"true" sensitive:"true"`

	// Specifies the Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view to use for the query. If you don't specify a value for this parameter,
	// then the operation automatically uses the default view for the Amazon Web
	// Services Region in which you called this operation. If the Region either
	// doesn't have a default view or if you don't have permission to use the default
	// view, then the operation fails with a 401 Unauthorized exception.
	ViewArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (SearchInput) GoString

func (s SearchInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchInput) SetMaxResults

func (s *SearchInput) SetMaxResults(v int64) *SearchInput

SetMaxResults sets the MaxResults field's value.

func (*SearchInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*SearchInput) SetQueryString

func (s *SearchInput) SetQueryString(v string) *SearchInput

SetQueryString sets the QueryString field's value.

func (*SearchInput) SetViewArn

func (s *SearchInput) SetViewArn(v string) *SearchInput

SetViewArn sets the ViewArn field's value.

func (SearchInput) String

func (s SearchInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchInput) Validate

func (s *SearchInput) Validate() error

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

type SearchOutput

type SearchOutput struct {

	// The number of resources that match the query.
	Count *ResourceCount `type:"structure"`

	// If present, indicates that more output is available than is included in the
	// current response. Use this value in the NextToken request parameter in a
	// subsequent call to the operation to get the next part of the output. You
	// should repeat this until the NextToken response element comes back as null.
	// The pagination tokens expire after 24 hours.
	NextToken *string `min:"1" type:"string"`

	// The list of structures that describe the resources that match the query.
	Resources []*Resource `type:"list"`

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view that this operation used to perform the search.
	ViewArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SearchOutput) GoString

func (s SearchOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchOutput) SetCount

func (s *SearchOutput) SetCount(v *ResourceCount) *SearchOutput

SetCount sets the Count field's value.

func (*SearchOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*SearchOutput) SetResources

func (s *SearchOutput) SetResources(v []*Resource) *SearchOutput

SetResources sets the Resources field's value.

func (*SearchOutput) SetViewArn

func (s *SearchOutput) SetViewArn(v string) *SearchOutput

SetViewArn sets the ViewArn field's value.

func (SearchOutput) String

func (s SearchOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The name of the service quota that was exceeded by the request.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The current value for the quota that the request tried to exceed.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request failed because it exceeds a service quota.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SupportedResourceType

type SupportedResourceType struct {

	// The unique identifier of the resource type.
	ResourceType *string `type:"string"`

	// The Amazon Web Service that is associated with the resource type. This is
	// the primary service that lets you create and interact with resources of this
	// type.
	Service *string `type:"string"`
	// contains filtered or unexported fields
}

A structure that describes a resource type supported by Amazon Web Services Resource Explorer.

func (SupportedResourceType) GoString

func (s SupportedResourceType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SupportedResourceType) SetResourceType

func (s *SupportedResourceType) SetResourceType(v string) *SupportedResourceType

SetResourceType sets the ResourceType field's value.

func (*SupportedResourceType) SetService

SetService sets the Service field's value.

func (SupportedResourceType) String

func (s SupportedResourceType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the view or index that you want to attach
	// tags to.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// A list of tag key and value pairs that you want to attach to the specified
	// view or index.
	//
	// Tags is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TagResourceInput's
	// String and GoString methods.
	Tags map[string]*string `type:"map" sensitive:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html).

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthorizedException

type UnauthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The principal making the request isn't permitted to perform the operation.

func (*UnauthorizedException) Code

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString

func (s UnauthorizedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedException) Message

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode

func (s *UnauthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedException) String

func (s UnauthorizedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the view or index that you want to remove
	// tags from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// A list of the keys for the tags that you want to remove from the specified
	// view or index.
	//
	// TagKeys is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UntagResourceInput's
	// String and GoString methods.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateIndexTypeInput

type UpdateIndexTypeInput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the index that you want to update.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The type of the index. To understand the difference between LOCAL and AGGREGATOR,
	// see Turning on cross-Region search (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html)
	// in the Amazon Web Services Resource Explorer User Guide.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"IndexType"`
	// contains filtered or unexported fields
}

func (UpdateIndexTypeInput) GoString

func (s UpdateIndexTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateIndexTypeInput) SetArn

SetArn sets the Arn field's value.

func (*UpdateIndexTypeInput) SetType

SetType sets the Type field's value.

func (UpdateIndexTypeInput) String

func (s UpdateIndexTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateIndexTypeInput) Validate

func (s *UpdateIndexTypeInput) Validate() error

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

type UpdateIndexTypeOutput

type UpdateIndexTypeOutput struct {

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the index that you updated.
	Arn *string `type:"string"`

	// The date and timestamp when the index was last updated.
	LastUpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// Indicates the state of the request to update the index. This operation is
	// asynchronous. Call the GetIndex operation to check for changes.
	State *string `type:"string" enum:"IndexState"`

	// Specifies the type of the specified index after the operation completes.
	Type *string `type:"string" enum:"IndexType"`
	// contains filtered or unexported fields
}

func (UpdateIndexTypeOutput) GoString

func (s UpdateIndexTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateIndexTypeOutput) SetArn

SetArn sets the Arn field's value.

func (*UpdateIndexTypeOutput) SetLastUpdatedAt

func (s *UpdateIndexTypeOutput) SetLastUpdatedAt(v time.Time) *UpdateIndexTypeOutput

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*UpdateIndexTypeOutput) SetState

SetState sets the State field's value.

func (*UpdateIndexTypeOutput) SetType

SetType sets the Type field's value.

func (UpdateIndexTypeOutput) String

func (s UpdateIndexTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateViewInput

type UpdateViewInput struct {

	// An array of strings that specify which resources are included in the results
	// of queries made using this view. When you use this view in a Search operation,
	// the filter string is combined with the search's QueryString parameter using
	// a logical AND operator.
	//
	// For information about the supported syntax, see Search query reference for
	// Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html)
	// in the Amazon Web Services Resource Explorer User Guide.
	//
	// This query string in the context of this operation supports only filter prefixes
	// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters)
	// with optional operators (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators).
	// It doesn't support free-form text. For example, the string region:us* service:ec2
	// -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services
	// Region that begins with the letters us and is not tagged with a key Stage
	// that has the value prod.
	//
	// Filters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateViewInput's
	// String and GoString methods.
	Filters *SearchFilter `type:"structure" sensitive:"true"`

	// Specifies optional fields that you want included in search results from this
	// view. It is a list of objects that each describe a field to include.
	//
	// The default is an empty list, with no optional fields included in the results.
	IncludedProperties []*IncludedProperty `type:"list"`

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view that you want to modify.
	//
	// ViewArn is a required field
	ViewArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateViewInput) GoString

func (s UpdateViewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateViewInput) SetFilters

func (s *UpdateViewInput) SetFilters(v *SearchFilter) *UpdateViewInput

SetFilters sets the Filters field's value.

func (*UpdateViewInput) SetIncludedProperties

func (s *UpdateViewInput) SetIncludedProperties(v []*IncludedProperty) *UpdateViewInput

SetIncludedProperties sets the IncludedProperties field's value.

func (*UpdateViewInput) SetViewArn

func (s *UpdateViewInput) SetViewArn(v string) *UpdateViewInput

SetViewArn sets the ViewArn field's value.

func (UpdateViewInput) String

func (s UpdateViewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateViewInput) Validate

func (s *UpdateViewInput) Validate() error

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

type UpdateViewOutput

type UpdateViewOutput struct {

	// Details about the view that you changed with this operation.
	View *View `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateViewOutput) GoString

func (s UpdateViewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateViewOutput) SetView

func (s *UpdateViewOutput) SetView(v *View) *UpdateViewOutput

SetView sets the View field's value.

func (UpdateViewOutput) String

func (s UpdateViewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// An array of the request fields that had validation errors.
	FieldList []*ValidationExceptionField `type:"list"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField

type ValidationExceptionField struct {

	// The name of the request field that had a validation error.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The validation error caused by the request field.
	//
	// ValidationIssue is a required field
	ValidationIssue *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A structure that describes a request field with a validation error.

func (ValidationExceptionField) GoString

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetName

SetName sets the Name field's value.

func (*ValidationExceptionField) SetValidationIssue

func (s *ValidationExceptionField) SetValidationIssue(v string) *ValidationExceptionField

SetValidationIssue sets the ValidationIssue field's value.

func (ValidationExceptionField) String

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type View

type View struct {

	// An array of SearchFilter objects that specify which resources can be included
	// in the results of queries made using this view.
	//
	// Filters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by View's
	// String and GoString methods.
	Filters *SearchFilter `type:"structure" sensitive:"true"`

	// A structure that contains additional information about the view.
	IncludedProperties []*IncludedProperty `type:"list"`

	// The date and time when this view was last modified.
	LastUpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The Amazon Web Services account that owns this view.
	Owner *string `type:"string"`

	// An Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of an Amazon Web Services account, an organization, or an organizational
	// unit (OU) that specifies whether this view includes resources from only the
	// specified Amazon Web Services account, all accounts in the specified organization,
	// or all accounts in the specified OU.
	//
	// If not specified, the value defaults to the Amazon Web Services account used
	// to call this operation.
	Scope *string `type:"string"`

	// The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the view.
	ViewArn *string `type:"string"`
	// contains filtered or unexported fields
}

A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in the results returned by this view. You could also create a second view that includes only resources that are tagged with "ENV" and "PRODUCTION".

func (View) GoString

func (s View) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*View) SetFilters

func (s *View) SetFilters(v *SearchFilter) *View

SetFilters sets the Filters field's value.

func (*View) SetIncludedProperties

func (s *View) SetIncludedProperties(v []*IncludedProperty) *View

SetIncludedProperties sets the IncludedProperties field's value.

func (*View) SetLastUpdatedAt

func (s *View) SetLastUpdatedAt(v time.Time) *View

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*View) SetOwner

func (s *View) SetOwner(v string) *View

SetOwner sets the Owner field's value.

func (*View) SetScope

func (s *View) SetScope(v string) *View

SetScope sets the Scope field's value.

func (*View) SetViewArn

func (s *View) SetViewArn(v string) *View

SetViewArn sets the ViewArn field's value.

func (View) String

func (s View) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package resourceexplorer2iface provides an interface to enable mocking the AWS Resource Explorer service client for testing your code.
Package resourceexplorer2iface provides an interface to enable mocking the AWS Resource Explorer service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL