types

package
v1.16.9 Latest Latest
Warning

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

 Go to latest Published: Jan 31, 2025 License: Apache-2.0 Imports: 5 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AWSServiceAccessStatus added in v1.7.0 

type AWSServiceAccessStatus string
const (
	AWSServiceAccessStatusEnabled  AWSServiceAccessStatus = "ENABLED"
	AWSServiceAccessStatusDisabled AWSServiceAccessStatus = "DISABLED"
)

Enum values for AWSServiceAccessStatus

func (AWSServiceAccessStatus) Values added in v1.7.0 

func (AWSServiceAccessStatus) Values() []AWSServiceAccessStatus

Values returns all known values for AWSServiceAccessStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

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

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type BatchGetViewError 

type BatchGetViewError struct {

	// The description of the error for the specified view.
	//
	// This member is required.
	ErrorMessage *string

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

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

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *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) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

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

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type 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
	//
	// This member is required.
	Name *string
	// 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.

type Index 

type Index struct {

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

	// The Amazon Web Services Region in which the index exists.
	Region *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 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 UpdateIndexTypeto 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.

type IndexState 

type IndexState string
const (
	// Resource Explorer is creating the index.
	IndexStateCreating IndexState = "CREATING"
	// Index is active.
	IndexStateActive IndexState = "ACTIVE"
	// Resource Explorer is deleting the index.
	IndexStateDeleting IndexState = "DELETING"
	// Resource Explorer successfully deleted the index.
	IndexStateDeleted IndexState = "DELETED"
	// Resource Explorer is switching the index type between local and aggregator.
	IndexStateUpdating IndexState = "UPDATING"
)

Enum values for IndexState

func (IndexState) Values 

func (IndexState) Values() []IndexState

Values returns all known values for IndexState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IndexType 

type IndexType string
const (
	// local index
	IndexTypeLocal IndexType = "LOCAL"
	// aggregator index
	IndexTypeAggregator IndexType = "AGGREGATOR"
)

Enum values for IndexType

func (IndexType) Values 

func (IndexType) Values() []IndexType

Values returns all known values for IndexType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

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

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type ManagedView added in v1.16.0 

type ManagedView struct {

	// A search filter defines which resources can be part of a search query result
	// set.
	Filters *SearchFilter

	// A structure that contains additional information about the managed view.
	IncludedProperties []IncludedProperty

	// The date and time when this managed view was last modified.
	LastUpdatedAt *time.Time

	// The [Amazon resource name (ARN)] of the managed view.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	ManagedViewArn *string

	// The name of the managed view.
	ManagedViewName *string

	// The Amazon Web Services account that owns this managed view.
	Owner *string

	// The resource policy that defines access to the managed view. To learn more
	// about this policy, review [Managed views].
	//
	// [Managed views]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html
	ResourcePolicy *string

	// An [Amazon resource name (ARN)] of an Amazon Web Services account or organization that specifies whether
	// this managed view includes resources from only the specified Amazon Web Services
	// account or all accounts in the specified organization.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	Scope *string

	// The service principal of the Amazon Web Services service that created and
	// manages the managed view.
	TrustedService *string

	// The version of the managed view.
	Version *string
	// contains filtered or unexported fields
}

An Amazon Web Services-managed view is how other Amazon Web Services services can access resource information indexed by Resource Explorer for your Amazon Web Services account or organization with your consent. For more information, see Managed views.

type MemberIndex added in v1.7.0 

type MemberIndex struct {

	// The account ID for the index.
	AccountId *string

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

	// The Amazon Web Services Region in which the index exists.
	Region *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 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.

type OrgConfiguration added in v1.7.0 

type OrgConfiguration struct {

	// This value displays whether your Amazon Web Services service access is ENABLED
	// or DISABLED .
	//
	// This member is required.
	AWSServiceAccessStatus 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
	// 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.

type Resource 

type Resource struct {

	// The [Amazon resource name (ARN)] of the resource.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	Arn *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

	// The Amazon Web Services account that owns the resource.
	OwningAccountId *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

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

	// The type of the resource.
	ResourceType *string

	// The Amazon Web Services service that owns the resource and is responsible for
	// creating and updating it.
	Service *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.

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

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

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *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) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

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

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceProperty 

type ResourceProperty struct {

	// Details about this property. The content of this field is a JSON object that
	// varies based on the resource type.
	Data document.Interface

	// The date and time that the information about this resource property was last
	// updated.
	LastReportedAt *time.Time

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

A structure that describes a property of a resource.

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 Searchoperation. For more details, see [Search query syntax].
	//
	// [Search query syntax]: https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html
	//
	// This member is required.
	FilterString *string
	// contains filtered or unexported fields
}

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

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	Name  *string
	Value *string
	// contains filtered or unexported fields
}

The request failed because it exceeds a service quota.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

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

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SupportedResourceType 

type SupportedResourceType struct {

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

	// The Amazon Web Services 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
	// contains filtered or unexported fields
}

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

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *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.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

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

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

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

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	FieldList []ValidationExceptionField
	// 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) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

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

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// The name of the request field that had a validation error.
	//
	// This member is required.
	Name *string

	// The validation error caused by the request field.
	//
	// This member is required.
	ValidationIssue *string
	// contains filtered or unexported fields
}

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

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 *SearchFilter

	// A structure that contains additional information about the view.
	IncludedProperties []IncludedProperty

	// The date and time when this view was last modified.
	LastUpdatedAt *time.Time

	// The Amazon Web Services account that owns this view.
	Owner *string

	// An [Amazon resource name (ARN)] 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.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	Scope *string

	// The [Amazon resource name (ARN)] of the view.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	ViewArn *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".

Source Files

View all Source files

Jump to

Keyboard shortcuts

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