resourceexplorer2

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

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

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

Documentation

Overview

Package resourceexplorer2 provides the API client, operations, and parameter types for 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 indexin each Region, with the details of that Region's resources.

You can search across all of the indexed Regions in your account 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, 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.

Index

Constants

View Source 
const ServiceAPIVersion = "2022-07-28"
View Source 
const ServiceID = "Resource Explorer 2"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

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

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

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

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

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

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

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

Types

type AssociateDefaultViewInput 

type AssociateDefaultViewInput struct {

	// The [Amazon resource name (ARN)] 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.
	//
	// [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
}

type AssociateDefaultViewOutput 

type AssociateDefaultViewOutput struct {

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

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

type AuthResolverParameters 

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

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

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

type AuthSchemeResolver 

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

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

type BatchGetViewInput 

type BatchGetViewInput struct {

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

type BatchGetViewOutput 

type BatchGetViewOutput struct {

	// If any of the specified ARNs result in an error, then this structure describes
	// the error.
	Errors []types.BatchGetViewError

	// A structure with a list of objects with details for each of the specified views.
	Views []types.View

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

type Client 

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

Client provides the API client to make operations call for AWS Resource Explorer.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateDefaultView 

func (c *Client) AssociateDefaultView(ctx context.Context, params *AssociateDefaultViewInput, optFns ...func(*Options)) (*AssociateDefaultViewOutput, error)

Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Searchthat 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.

func (*Client) BatchGetView 

func (c *Client) BatchGetView(ctx context.Context, params *BatchGetViewInput, optFns ...func(*Options)) (*BatchGetViewOutput, error)

Retrieves details about a list of views.

func (*Client) CreateIndex 

func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error)

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 UpdateIndexTypeoperation. For more information, see Turning on cross-Region search by creating an aggregator index 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 Regionin 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 rolein 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].
Resource Explorer uses the same service-linked role for all additional indexes
you create afterwards.

func (*Client) CreateView 

func (c *Client) CreateView(ctx context.Context, params *CreateViewInput, optFns ...func(*Options)) (*CreateViewOutput, error)

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 viewsin 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) of this view can Search using views you create with this operation.

func (*Client) DeleteIndex 

func (c *Client) DeleteIndex(ctx context.Context, params *DeleteIndexInput, optFns ...func(*Options)) (*DeleteIndexOutput, error)

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

func (*Client) DeleteView 

func (c *Client) DeleteView(ctx context.Context, params *DeleteViewInput, optFns ...func(*Options)) (*DeleteViewOutput, error)

Deletes the specified view.

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

func (*Client) DisassociateDefaultView 

func (c *Client) DisassociateDefaultView(ctx context.Context, params *DisassociateDefaultViewInput, optFns ...func(*Options)) (*DisassociateDefaultViewOutput, error)

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

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.

func (*Client) GetAccountLevelServiceConfiguration 

func (c *Client) GetAccountLevelServiceConfiguration(ctx context.Context, params *GetAccountLevelServiceConfigurationInput, optFns ...func(*Options)) (*GetAccountLevelServiceConfigurationOutput, error)

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.

func (*Client) GetDefaultView 

func (c *Client) GetDefaultView(ctx context.Context, params *GetDefaultViewInput, optFns ...func(*Options)) (*GetDefaultViewOutput, error)

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 GetViewto retrieve the details of that view.

func (*Client) GetIndex 

func (c *Client) GetIndex(ctx context.Context, params *GetIndexInput, optFns ...func(*Options)) (*GetIndexOutput, error)

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

func (*Client) GetView 

func (c *Client) GetView(ctx context.Context, params *GetViewInput, optFns ...func(*Options)) (*GetViewOutput, error)

Retrieves details of the specified view.

func (*Client) ListIndexes 

func (c *Client) ListIndexes(ctx context.Context, params *ListIndexesInput, optFns ...func(*Options)) (*ListIndexesOutput, error)

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.

func (*Client) ListIndexesForMembers 

func (c *Client) ListIndexesForMembers(ctx context.Context, params *ListIndexesForMembersInput, optFns ...func(*Options)) (*ListIndexesForMembersOutput, error)

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.

func (*Client) ListSupportedResourceTypes 

func (c *Client) ListSupportedResourceTypes(ctx context.Context, params *ListSupportedResourceTypesInput, optFns ...func(*Options)) (*ListSupportedResourceTypesOutput, error)

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

func (*Client) ListTagsForResource 

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

Lists the tags that are attached to the specified resource.

func (*Client) ListViews 

func (c *Client) ListViews(ctx context.Context, params *ListViewsInput, optFns ...func(*Options)) (*ListViewsOutput, error)

Lists the Amazon resource names (ARNs) 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.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

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

func (*Client) Search 

func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func(*Options)) (*SearchOutput, error)

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.

If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.

func (*Client) TagResource 

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

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

func (*Client) UntagResource 

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

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

func (*Client) UpdateIndexType 

func (c *Client) UpdateIndexType(ctx context.Context, params *UpdateIndexTypeInput, optFns ...func(*Options)) (*UpdateIndexTypeOutput, error)

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 indexin 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 GetIndexoperation. 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.

func (*Client) UpdateView 

func (c *Client) UpdateView(ctx context.Context, params *UpdateViewInput, optFns ...func(*Options)) (*UpdateViewOutput, error)

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.

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]to ensure the uniqueness of your index.
	//
	// [UUID-type value]: https://wikipedia.org/wiki/Universally_unique_identifier
	ClientToken *string

	// 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 map[string]string
	// contains filtered or unexported fields
}

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

	// The date and timestamp when the index was created.
	CreatedAt *time.Time

	// Indicates the current state of the index. You can check for changes to the
	// state for asynchronous operations by calling the GetIndexoperation.
	//
	// 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 types.IndexState

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

type CreateViewInput 

type CreateViewInput struct {

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

	// 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]to ensure the uniqueness of your views.
	//
	// [UUID-type value]: https://wikipedia.org/wiki/Universally_unique_identifier
	ClientToken *string

	// 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 Searchoperation, 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] in the Amazon Web Services
	// Resource Explorer User Guide.
	//
	// This query string in the context of this operation supports only [filter prefixes] with optional [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 .
	//
	// [filter prefixes]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters
	// [Search query reference for Resource Explorer]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html
	// [operators]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators
	Filters *types.SearchFilter

	// 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 []types.IncludedProperty

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

	// Tag key and value pairs that are attached to the view.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateViewOutput 

type CreateViewOutput struct {

	// A structure that contains the details about the new view.
	View *types.View

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

type DeleteIndexInput 

type DeleteIndexInput struct {

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

type DeleteIndexOutput 

type DeleteIndexOutput struct {

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

	// The date and time when you last updated this index.
	LastUpdatedAt *time.Time

	// Indicates the current state of the index.
	State types.IndexState

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

type DeleteViewInput 

type DeleteViewInput struct {

	// The [Amazon resource name (ARN)] of the view that you want to delete.
	//
	// [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
}

type DeleteViewOutput 

type DeleteViewOutput struct {

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

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

type DisassociateDefaultViewInput 

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

type DisassociateDefaultViewOutput 

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

type EndpointParameters 

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

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

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

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

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

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

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccountLevelServiceConfigurationInput 

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

type GetAccountLevelServiceConfigurationOutput 

type GetAccountLevelServiceConfigurationOutput struct {

	// Details about the organization, and whether configuration is ENABLED or DISABLED
	// .
	OrgConfiguration *types.OrgConfiguration

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

type GetDefaultViewInput 

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

type GetDefaultViewOutput 

type GetDefaultViewOutput struct {

	// The [Amazon resource name (ARN)] of the view that is the current default for the Amazon Web Services Region
	// in which you called this operation.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	ViewArn *string

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

type GetIndexInput 

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

type GetIndexOutput 

type GetIndexOutput 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 date and time when the index was originally created.
	CreatedAt *time.Time

	// The date and time when the index was last updated.
	LastUpdatedAt *time.Time

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

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

	// The current state of the index in this Amazon Web Services Region.
	State types.IndexState

	// Tag key and value pairs that are attached to the index.
	Tags map[string]string

	// 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].
	//
	// [Turning on cross-Region search by creating an aggregator index]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html
	Type types.IndexType

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

type GetViewInput 

type GetViewInput struct {

	// The [Amazon resource name (ARN)] of the view that you want information about.
	//
	// [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
}

type GetViewOutput 

type GetViewOutput struct {

	// Tag key and value pairs that are attached to the view.
	Tags map[string]string

	// A structure that contains the details for the requested view.
	View *types.View

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

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

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

IdempotencyTokenProvider interface for providing idempotency token

type ListIndexesAPIClient 

type ListIndexesAPIClient interface {
	ListIndexes(context.Context, *ListIndexesInput, ...func(*Options)) (*ListIndexesOutput, error)
}

ListIndexesAPIClient is a client that implements the ListIndexes operation.

type ListIndexesForMembersAPIClient 

type ListIndexesForMembersAPIClient interface {
	ListIndexesForMembers(context.Context, *ListIndexesForMembersInput, ...func(*Options)) (*ListIndexesForMembersOutput, error)
}

ListIndexesForMembersAPIClient is a client that implements the ListIndexesForMembers operation.

type ListIndexesForMembersInput 

type ListIndexesForMembersInput struct {

	// The account IDs will limit the output to only indexes from these accounts.
	//
	// This member is required.
	AccountIdList []string

	// 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 *int32

	// 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
	// contains filtered or unexported fields
}

type ListIndexesForMembersOutput 

type ListIndexesForMembersOutput struct {

	// A structure that contains the details and status of each index.
	Indexes []types.MemberIndex

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

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

type ListIndexesForMembersPaginator 

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

ListIndexesForMembersPaginator is a paginator for ListIndexesForMembers

func NewListIndexesForMembersPaginator 

func NewListIndexesForMembersPaginator(client ListIndexesForMembersAPIClient, params *ListIndexesForMembersInput, optFns ...func(*ListIndexesForMembersPaginatorOptions)) *ListIndexesForMembersPaginator

NewListIndexesForMembersPaginator returns a new ListIndexesForMembersPaginator

func (*ListIndexesForMembersPaginator) HasMorePages 

func (p *ListIndexesForMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIndexesForMembersPaginator) NextPage 

func (p *ListIndexesForMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIndexesForMembersOutput, error)

NextPage retrieves the next ListIndexesForMembers page.

type ListIndexesForMembersPaginatorOptions 

type ListIndexesForMembersPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIndexesForMembersPaginatorOptions is the paginator options for ListIndexesForMembers

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

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

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

	// 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 types.IndexType
	// contains filtered or unexported fields
}

type ListIndexesOutput 

type ListIndexesOutput struct {

	// A structure that contains the details and status of each index.
	Indexes []types.Index

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

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

type ListIndexesPaginator 

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

ListIndexesPaginator is a paginator for ListIndexes

func NewListIndexesPaginator 

func NewListIndexesPaginator(client ListIndexesAPIClient, params *ListIndexesInput, optFns ...func(*ListIndexesPaginatorOptions)) *ListIndexesPaginator

NewListIndexesPaginator returns a new ListIndexesPaginator

func (*ListIndexesPaginator) HasMorePages 

func (p *ListIndexesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIndexesPaginator) NextPage 

func (p *ListIndexesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIndexesOutput, error)

NextPage retrieves the next ListIndexes page.

type ListIndexesPaginatorOptions 

type ListIndexesPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIndexesPaginatorOptions is the paginator options for ListIndexes

type ListSupportedResourceTypesAPIClient 

type ListSupportedResourceTypesAPIClient interface {
	ListSupportedResourceTypes(context.Context, *ListSupportedResourceTypesInput, ...func(*Options)) (*ListSupportedResourceTypesOutput, error)
}

ListSupportedResourceTypesAPIClient is a client that implements the ListSupportedResourceTypes operation.

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

	// 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
	// contains filtered or unexported fields
}

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

	// The list of resource types supported by Resource Explorer.
	ResourceTypes []types.SupportedResourceType

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

type ListSupportedResourceTypesPaginator 

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

ListSupportedResourceTypesPaginator is a paginator for ListSupportedResourceTypes

func NewListSupportedResourceTypesPaginator 

func NewListSupportedResourceTypesPaginator(client ListSupportedResourceTypesAPIClient, params *ListSupportedResourceTypesInput, optFns ...func(*ListSupportedResourceTypesPaginatorOptions)) *ListSupportedResourceTypesPaginator

NewListSupportedResourceTypesPaginator returns a new ListSupportedResourceTypesPaginator

func (*ListSupportedResourceTypesPaginator) HasMorePages 

func (p *ListSupportedResourceTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSupportedResourceTypesPaginator) NextPage 

func (p *ListSupportedResourceTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSupportedResourceTypesOutput, error)

NextPage retrieves the next ListSupportedResourceTypes page.

type ListSupportedResourceTypesPaginatorOptions 

type ListSupportedResourceTypesPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSupportedResourceTypesPaginatorOptions is the paginator options for ListSupportedResourceTypes

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The [Amazon resource name (ARN)] of the view or index that you want to attach tags to.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tag key and value pairs that you want to attach to the specified view or
	// index.
	Tags map[string]string

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

type ListViewsAPIClient 

type ListViewsAPIClient interface {
	ListViews(context.Context, *ListViewsInput, ...func(*Options)) (*ListViewsOutput, error)
}

ListViewsAPIClient is a client that implements the ListViews operation.

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

	// 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
	// contains filtered or unexported fields
}

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

	// The list of views available in the Amazon Web Services Region in which you
	// called this operation.
	Views []string

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

type ListViewsPaginator 

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

ListViewsPaginator is a paginator for ListViews

func NewListViewsPaginator 

func NewListViewsPaginator(client ListViewsAPIClient, params *ListViewsInput, optFns ...func(*ListViewsPaginatorOptions)) *ListViewsPaginator

NewListViewsPaginator returns a new ListViewsPaginator

func (*ListViewsPaginator) HasMorePages 

func (p *ListViewsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListViewsPaginator) NextPage 

func (p *ListViewsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListViewsOutput, error)

NextPage retrieves the next ListViews page.

type ListViewsPaginatorOptions 

type ListViewsPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListViewsPaginatorOptions is the paginator options for ListViews

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

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

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

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

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

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

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

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

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

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

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

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

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver 

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

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

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchAPIClient 

type SearchAPIClient interface {
	Search(context.Context, *SearchInput, ...func(*Options)) (*SearchOutput, error)
}

SearchAPIClient is a client that implements the Search operation.

type SearchInput 

type SearchInput struct {

	// 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].
	//
	// 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.
	//
	// [Search query syntax reference for Resource Explorer]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html
	//
	// This member is required.
	QueryString *string

	// 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 *int32

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

	// Specifies the [Amazon resource name (ARN)] 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.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	ViewArn *string
	// contains filtered or unexported fields
}

type SearchOutput 

type SearchOutput struct {

	// The number of resources that match the query.
	Count *types.ResourceCount

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

	// The list of structures that describe the resources that match the query.
	Resources []types.Resource

	// The [Amazon resource name (ARN)] of the view that this operation used to perform the search.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	ViewArn *string

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

type SearchPaginator 

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

SearchPaginator is a paginator for Search

func NewSearchPaginator 

func NewSearchPaginator(client SearchAPIClient, params *SearchInput, optFns ...func(*SearchPaginatorOptions)) *SearchPaginator

NewSearchPaginator returns a new SearchPaginator

func (*SearchPaginator) HasMorePages 

func (p *SearchPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchPaginator) NextPage 

func (p *SearchPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchOutput, error)

NextPage retrieves the next Search page.

type SearchPaginatorOptions 

type SearchPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchPaginatorOptions is the paginator options for Search

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the view or index that you want to attach
	// tags to.
	//
	// This member is required.
	ResourceArn *string

	// A list of tag key and value pairs that you want to attach to the specified view
	// or index.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the view or index that you want to remove
	// tags from.
	//
	// This member is required.
	ResourceArn *string

	// A list of the keys for the tags that you want to remove from the specified view
	// or index.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

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

type UpdateIndexTypeInput 

type UpdateIndexTypeInput struct {

	// The [Amazon resource name (ARN)] of the index that you want to update.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	Arn *string

	// The type of the index. To understand the difference between LOCAL and AGGREGATOR
	// , see [Turning on cross-Region search]in the Amazon Web Services Resource Explorer User Guide.
	//
	// [Turning on cross-Region search]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html
	//
	// This member is required.
	Type types.IndexType
	// contains filtered or unexported fields
}

type UpdateIndexTypeOutput 

type UpdateIndexTypeOutput struct {

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

	// The date and timestamp when the index was last updated.
	LastUpdatedAt *time.Time

	// Indicates the state of the request to update the index. This operation is
	// asynchronous. Call the GetIndexoperation to check for changes.
	State types.IndexState

	// Specifies the type of the specified index after the operation completes.
	Type types.IndexType

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

type UpdateViewInput 

type UpdateViewInput struct {

	// The [Amazon resource name (ARN)] of the view that you want to modify.
	//
	// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	ViewArn *string

	// 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 Searchoperation, 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] in the Amazon Web Services
	// Resource Explorer User Guide.
	//
	// This query string in the context of this operation supports only [filter prefixes] with optional [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 .
	//
	// [filter prefixes]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters
	// [Search query reference for Resource Explorer]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html
	// [operators]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators
	Filters *types.SearchFilter

	// 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 []types.IncludedProperty
	// contains filtered or unexported fields
}

type UpdateViewOutput 

type UpdateViewOutput struct {

	// Details about the view that you changed with this operation.
	View *types.View

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

Source Files

View all Source files

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
 Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal
document
endpoints

Jump to

Keyboard shortcuts

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