bcmdashboards

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

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

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

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

type CreateDashboardInput struct {

	// The name of the dashboard. The name must be unique within your account.
	//
	// This member is required.
	Name *string

	// An array of widget configurations that define the visualizations to be
	// displayed in the dashboard. Each dashboard can contain up to 20 widgets.
	//
	// This member is required.
	Widgets []types.Widget

	// A description of the dashboard's purpose or contents.
	Description *string

	// The tags to apply to the dashboard resource for organization and management.
	ResourceTags []types.ResourceTag
	// contains filtered or unexported fields
}

type CreateDashboardOutput struct {

	// The ARN of the newly created dashboard.
	//
	// This member is required.
	Arn *string

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

type DeleteDashboardInput struct {

	// The ARN of the dashboard to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteDashboardOutput struct {

	// The ARN of the dashboard that was deleted.
	//
	// This member is required.
	Arn *string

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

type EndpointParameters struct {
	// 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

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string
}

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

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

type EndpointResolverOptions = internalendpoints.Options

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,
	)
}

type GetDashboardInput struct {

	// The ARN of the dashboard to retrieve. This is required to uniquely identify the
	// dashboard.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetDashboardOutput struct {

	// The ARN of the retrieved dashboard.
	//
	// This member is required.
	Arn *string

	// The timestamp when the dashboard was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The name of the retrieved dashboard.
	//
	// This member is required.
	Name *string

	// Indicates the dashboard type.
	//
	// This member is required.
	Type types.DashboardType

	// The timestamp when the dashboard was last modified.
	//
	// This member is required.
	UpdatedAt *time.Time

	// An array of widget configurations that make up the dashboard.
	//
	// This member is required.
	Widgets []types.Widget

	// The description of the retrieved dashboard.
	Description *string

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

type GetResourcePolicyInput struct {

	// The ARN of the dashboard whose resource-based policy you want to retrieve.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type GetResourcePolicyOutput struct {

	// The JSON policy document that represents the dashboard's resource-based policy.
	//
	// This member is required.
	PolicyDocument *string

	// The ARN of the dashboard for which the resource-based policy was retrieved.
	//
	// This member is required.
	ResourceArn *string

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

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

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 ListDashboardsAPIClient interface {
	ListDashboards(context.Context, *ListDashboardsInput, ...func(*Options)) (*ListDashboardsOutput, error)
}

type ListDashboardsInput struct {

	// The maximum number of results to return in a single call. The default value is
	// 20.
	MaxResults *int32

	// The token for the next page of results. Use the value returned in the previous
	// response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDashboardsOutput struct {

	// An array of dashboard references, containing basic information about each
	// dashboard.
	//
	// This member is required.
	Dashboards []types.DashboardReference

	// The token to use to retrieve the next page of results. Not returned if there
	// are no more results to retrieve.
	NextToken *string

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

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

type ListDashboardsPaginatorOptions struct {
	// The maximum number of results to return in a single call. The default value is
	// 20.
	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
}

type ListTagsForResourceInput struct {

	// The unique identifier for the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput struct {

	// The list of tags associated with the specified dashboard resource.
	ResourceTags []types.ResourceTag

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

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

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

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

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

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

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

	// Priority list of preferred auth scheme names (e.g. sigv4a).
	AuthSchemePreference []string
	// contains filtered or unexported fields
}

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

type TagResourceInput struct {

	// The unique identifier for the resource.
	//
	// This member is required.
	ResourceArn *string

	// The tags to add to the dashboard resource.
	//
	// This member is required.
	ResourceTags []types.ResourceTag
	// contains filtered or unexported fields
}

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

type UntagResourceInput struct {

	// The unique identifier for the resource.
	//
	// This member is required.
	ResourceArn *string

	// The keys of the tags to remove from the dashboard resource.
	//
	// This member is required.
	ResourceTagKeys []string
	// contains filtered or unexported fields
}

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

type UpdateDashboardInput struct {

	// The ARN of the dashboard to update.
	//
	// This member is required.
	Arn *string

	// The new description for the dashboard. If not specified, the existing
	// description is retained.
	Description *string

	// The new name for the dashboard. If not specified, the existing name is retained.
	Name *string

	// The updated array of widget configurations for the dashboard. Replaces all
	// existing widgets.
	Widgets []types.Widget
	// contains filtered or unexported fields
}

type UpdateDashboardOutput struct {

	// The ARN of the updated dashboard.
	//
	// This member is required.
	Arn *string

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