appfabric

package module
v1.9.0 Latest Latest
Warning

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

Go to latest
Published: Jun 26, 2024 License: Apache-2.0 Imports: 43 Imported by: 6

Documentation

Overview

Package appfabric provides the API client, operations, and parameter types for AppFabric.

Amazon Web Services AppFabric quickly connects software as a service (SaaS) applications across your organization. This allows IT and security teams to easily manage and secure applications using a standard schema, and employees can complete everyday tasks faster using generative artificial intelligence (AI). You can use these APIs to complete AppFabric tasks, such as setting up audit log ingestions or viewing user access. For more information about AppFabric, including the required permissions to use the service, see the Amazon Web Services AppFabric Administration Guide. For more information about using the Command Line Interface (CLI) to manage your AppFabric resources, see the AppFabric section of the CLI Reference.

Index

Constants

View Source
const ServiceAPIVersion = "2023-05-19"
View Source
const ServiceID = "AppFabric"

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 added in v1.1.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.4.2

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 added in v1.4.2

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 AuthResolverParameters added in v1.4.2

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 added in v1.4.2

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

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

type BatchGetUserAccessTasksInput

type BatchGetUserAccessTasksInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The tasks IDs to use for the request.
	//
	// This member is required.
	TaskIdList []string
	// contains filtered or unexported fields
}

type BatchGetUserAccessTasksOutput

type BatchGetUserAccessTasksOutput struct {

	// Contains a list of user access results.
	UserAccessResultsList []types.UserAccessResultItem

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

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) BatchGetUserAccessTasks

func (c *Client) BatchGetUserAccessTasks(ctx context.Context, params *BatchGetUserAccessTasksInput, optFns ...func(*Options)) (*BatchGetUserAccessTasksOutput, error)

Gets user access details in a batch request.

This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.

func (*Client) ConnectAppAuthorization

func (c *Client) ConnectAppAuthorization(ctx context.Context, params *ConnectAppAuthorizationInput, optFns ...func(*Options)) (*ConnectAppAuthorizationOutput, error)

Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.

func (*Client) CreateAppAuthorization

func (c *Client) CreateAppAuthorization(ctx context.Context, params *CreateAppAuthorizationInput, optFns ...func(*Options)) (*CreateAppAuthorizationOutput, error)

Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.

func (*Client) CreateAppBundle

func (c *Client) CreateAppBundle(ctx context.Context, params *CreateAppBundleInput, optFns ...func(*Options)) (*CreateAppBundleOutput, error)

Creates an app bundle to collect data from an application using AppFabric.

func (*Client) CreateIngestion

func (c *Client) CreateIngestion(ctx context.Context, params *CreateIngestionInput, optFns ...func(*Options)) (*CreateIngestionOutput, error)

Creates a data ingestion for an application.

func (*Client) CreateIngestionDestination

func (c *Client) CreateIngestionDestination(ctx context.Context, params *CreateIngestionDestinationInput, optFns ...func(*Options)) (*CreateIngestionDestinationOutput, error)

Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

func (*Client) DeleteAppAuthorization

func (c *Client) DeleteAppAuthorization(ctx context.Context, params *DeleteAppAuthorizationInput, optFns ...func(*Options)) (*DeleteAppAuthorizationOutput, error)

Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.

func (*Client) DeleteAppBundle

func (c *Client) DeleteAppBundle(ctx context.Context, params *DeleteAppBundleInput, optFns ...func(*Options)) (*DeleteAppBundleOutput, error)

Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.

func (*Client) DeleteIngestion

func (c *Client) DeleteIngestion(ctx context.Context, params *DeleteIngestionInput, optFns ...func(*Options)) (*DeleteIngestionOutput, error)

Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.

func (*Client) DeleteIngestionDestination

func (c *Client) DeleteIngestionDestination(ctx context.Context, params *DeleteIngestionDestinationInput, optFns ...func(*Options)) (*DeleteIngestionDestinationOutput, error)

Deletes an ingestion destination.

This deletes the association between an ingestion and it's destination. It doesn't delete previously ingested data or the storage destination, such as the Amazon S3 bucket where the data is delivered. If the ingestion destination is deleted while the associated ingestion is enabled, the ingestion will fail and is eventually disabled.

func (*Client) GetAppAuthorization

func (c *Client) GetAppAuthorization(ctx context.Context, params *GetAppAuthorizationInput, optFns ...func(*Options)) (*GetAppAuthorizationOutput, error)

Returns information about an app authorization.

func (*Client) GetAppBundle

func (c *Client) GetAppBundle(ctx context.Context, params *GetAppBundleInput, optFns ...func(*Options)) (*GetAppBundleOutput, error)

Returns information about an app bundle.

func (*Client) GetIngestion

func (c *Client) GetIngestion(ctx context.Context, params *GetIngestionInput, optFns ...func(*Options)) (*GetIngestionOutput, error)

Returns information about an ingestion.

func (*Client) GetIngestionDestination

func (c *Client) GetIngestionDestination(ctx context.Context, params *GetIngestionDestinationInput, optFns ...func(*Options)) (*GetIngestionDestinationOutput, error)

Returns information about an ingestion destination.

func (*Client) ListAppAuthorizations

func (c *Client) ListAppAuthorizations(ctx context.Context, params *ListAppAuthorizationsInput, optFns ...func(*Options)) (*ListAppAuthorizationsOutput, error)

Returns a list of all app authorizations configured for an app bundle.

func (*Client) ListAppBundles

func (c *Client) ListAppBundles(ctx context.Context, params *ListAppBundlesInput, optFns ...func(*Options)) (*ListAppBundlesOutput, error)

Returns a list of app bundles.

func (*Client) ListIngestionDestinations

func (c *Client) ListIngestionDestinations(ctx context.Context, params *ListIngestionDestinationsInput, optFns ...func(*Options)) (*ListIngestionDestinationsOutput, error)

Returns a list of all ingestion destinations configured for an ingestion.

func (*Client) ListIngestions

func (c *Client) ListIngestions(ctx context.Context, params *ListIngestionsInput, optFns ...func(*Options)) (*ListIngestionsOutput, error)

Returns a list of all ingestions configured for an app bundle.

func (*Client) ListTagsForResource

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

Returns a list of tags for a resource.

func (*Client) Options added in v1.5.0

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) StartIngestion

func (c *Client) StartIngestion(ctx context.Context, params *StartIngestionInput, optFns ...func(*Options)) (*StartIngestionOutput, error)

Starts (enables) an ingestion, which collects data from an application.

func (*Client) StartUserAccessTasks

func (c *Client) StartUserAccessTasks(ctx context.Context, params *StartUserAccessTasksInput, optFns ...func(*Options)) (*StartUserAccessTasksOutput, error)

Starts the tasks to search user access status for a specific email address.

The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.

func (*Client) StopIngestion

func (c *Client) StopIngestion(ctx context.Context, params *StopIngestionInput, optFns ...func(*Options)) (*StopIngestionOutput, error)

Stops (disables) an ingestion.

func (*Client) TagResource

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

Assigns one or more tags (key-value pairs) to the specified resource.

func (*Client) UntagResource

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

Removes a tag or tags from a resource.

func (*Client) UpdateAppAuthorization

func (c *Client) UpdateAppAuthorization(ctx context.Context, params *UpdateAppAuthorizationInput, optFns ...func(*Options)) (*UpdateAppAuthorizationOutput, error)

Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.

If the app authorization was in a connected state, updating the app authorization will set it back to a PendingConnect state.

func (*Client) UpdateIngestionDestination

func (c *Client) UpdateIngestionDestination(ctx context.Context, params *UpdateIngestionDestinationInput, optFns ...func(*Options)) (*UpdateIngestionDestinationOutput, error)

Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

type ConnectAppAuthorizationInput

type ConnectAppAuthorizationInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// authorization to use for the request.
	//
	// This member is required.
	AppAuthorizationIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle that contains the app authorization to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// Contains OAuth2 authorization information.
	//
	// This is required if the app authorization for the request is configured with an
	// OAuth2 ( oauth2 ) authorization type.
	AuthRequest *types.AuthRequest
	// contains filtered or unexported fields
}

type ConnectAppAuthorizationOutput

type ConnectAppAuthorizationOutput struct {

	// Contains a summary of the app authorization.
	//
	// This member is required.
	AppAuthorizationSummary *types.AppAuthorizationSummary

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

type CreateAppAuthorizationInput

type CreateAppAuthorizationInput struct {

	// The name of the application.
	//
	// Valid values are:
	//
	//   - SLACK
	//
	//   - ASANA
	//
	//   - JIRA
	//
	//   - M365
	//
	//   - M365AUDITLOGS
	//
	//   - ZOOM
	//
	//   - ZENDESK
	//
	//   - OKTA
	//
	//   - GOOGLE
	//
	//   - DROPBOX
	//
	//   - SMARTSHEET
	//
	//   - CISCO
	//
	// This member is required.
	App *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The authorization type for the app authorization.
	//
	// This member is required.
	AuthType types.AuthType

	// Contains credentials for the application, such as an API key or OAuth2 client
	// ID and secret.
	//
	// Specify credentials that match the authorization type for your request. For
	// example, if the authorization type for your request is OAuth2 ( oauth2 ), then
	// you should provide only the OAuth2 credentials.
	//
	// This member is required.
	Credential types.Credential

	// Contains information about an application tenant, such as the application
	// display name and identifier.
	//
	// This member is required.
	Tenant *types.Tenant

	// Specifies a unique, case-sensitive identifier that you provide to ensure the
	// idempotency of the request. This lets you safely retry the request without
	// accidentally performing the same operation a second time. Passing the same value
	// to a later call to an operation requires that you also pass the same value for
	// all other parameters. We recommend that you use a [UUID type of value].
	//
	// If you don't provide this value, then Amazon Web Services generates a random
	// one for you.
	//
	// If you retry the operation with the same ClientToken , but with different
	// parameters, the retry fails with an IdempotentParameterMismatch error.
	//
	// [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier
	ClientToken *string

	// A map of the key-value pairs of the tag or tags to assign to the resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAppAuthorizationOutput

type CreateAppAuthorizationOutput struct {

	// Contains information about an app authorization.
	//
	// This member is required.
	AppAuthorization *types.AppAuthorization

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

type CreateAppBundleInput

type CreateAppBundleInput struct {

	// Specifies a unique, case-sensitive identifier that you provide to ensure the
	// idempotency of the request. This lets you safely retry the request without
	// accidentally performing the same operation a second time. Passing the same value
	// to a later call to an operation requires that you also pass the same value for
	// all other parameters. We recommend that you use a [UUID type of value].
	//
	// If you don't provide this value, then Amazon Web Services generates a random
	// one for you.
	//
	// If you retry the operation with the same ClientToken , but with different
	// parameters, the retry fails with an IdempotentParameterMismatch error.
	//
	// [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier
	ClientToken *string

	// The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use
	// to encrypt the application data. If this is not specified, an Amazon Web
	// Services owned key is used for encryption.
	CustomerManagedKeyIdentifier *string

	// A map of the key-value pairs of the tag or tags to assign to the resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAppBundleOutput

type CreateAppBundleOutput struct {

	// Contains information about an app bundle.
	//
	// This member is required.
	AppBundle *types.AppBundle

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

type CreateIngestionDestinationInput

type CreateIngestionDestinationInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// Contains information about the destination of ingested data.
	//
	// This member is required.
	DestinationConfiguration types.DestinationConfiguration

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion to use for the request.
	//
	// This member is required.
	IngestionIdentifier *string

	// Contains information about how ingested data is processed.
	//
	// This member is required.
	ProcessingConfiguration types.ProcessingConfiguration

	// Specifies a unique, case-sensitive identifier that you provide to ensure the
	// idempotency of the request. This lets you safely retry the request without
	// accidentally performing the same operation a second time. Passing the same value
	// to a later call to an operation requires that you also pass the same value for
	// all other parameters. We recommend that you use a [UUID type of value].
	//
	// If you don't provide this value, then Amazon Web Services generates a random
	// one for you.
	//
	// If you retry the operation with the same ClientToken , but with different
	// parameters, the retry fails with an IdempotentParameterMismatch error.
	//
	// [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier
	ClientToken *string

	// A map of the key-value pairs of the tag or tags to assign to the resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateIngestionDestinationOutput

type CreateIngestionDestinationOutput struct {

	// Contains information about an ingestion destination.
	//
	// This member is required.
	IngestionDestination *types.IngestionDestination

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

type CreateIngestionInput

type CreateIngestionInput struct {

	// The name of the application.
	//
	// Valid values are:
	//
	//   - SLACK
	//
	//   - ASANA
	//
	//   - JIRA
	//
	//   - M365
	//
	//   - M365AUDITLOGS
	//
	//   - ZOOM
	//
	//   - ZENDESK
	//
	//   - OKTA
	//
	//   - GOOGLE
	//
	//   - DROPBOX
	//
	//   - SMARTSHEET
	//
	//   - CISCO
	//
	// This member is required.
	App *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The ingestion type.
	//
	// This member is required.
	IngestionType types.IngestionType

	// The ID of the application tenant.
	//
	// This member is required.
	TenantId *string

	// Specifies a unique, case-sensitive identifier that you provide to ensure the
	// idempotency of the request. This lets you safely retry the request without
	// accidentally performing the same operation a second time. Passing the same value
	// to a later call to an operation requires that you also pass the same value for
	// all other parameters. We recommend that you use a [UUID type of value].
	//
	// If you don't provide this value, then Amazon Web Services generates a random
	// one for you.
	//
	// If you retry the operation with the same ClientToken , but with different
	// parameters, the retry fails with an IdempotentParameterMismatch error.
	//
	// [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier
	ClientToken *string

	// A map of the key-value pairs of the tag or tags to assign to the resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateIngestionOutput

type CreateIngestionOutput struct {

	// Contains information about an ingestion.
	//
	// This member is required.
	Ingestion *types.Ingestion

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

type DeleteAppAuthorizationInput

type DeleteAppAuthorizationInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// authorization to use for the request.
	//
	// This member is required.
	AppAuthorizationIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string
	// contains filtered or unexported fields
}

type DeleteAppAuthorizationOutput

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

type DeleteAppBundleInput

type DeleteAppBundleInput struct {

	// The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.
	//
	// This member is required.
	AppBundleIdentifier *string
	// contains filtered or unexported fields
}

type DeleteAppBundleOutput

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

type DeleteIngestionDestinationInput

type DeleteIngestionDestinationInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion destination to use for the request.
	//
	// This member is required.
	IngestionDestinationIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion to use for the request.
	//
	// This member is required.
	IngestionIdentifier *string
	// contains filtered or unexported fields
}

type DeleteIngestionDestinationOutput

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

type DeleteIngestionInput

type DeleteIngestionInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion to use for the request.
	//
	// This member is required.
	IngestionIdentifier *string
	// contains filtered or unexported fields
}

type DeleteIngestionOutput

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

type EndpointParameters added in v1.1.0

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 added in v1.1.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.1.0

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 added in v1.1.0

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 added in v1.1.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAppAuthorizationInput

type GetAppAuthorizationInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// authorization to use for the request.
	//
	// This member is required.
	AppAuthorizationIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string
	// contains filtered or unexported fields
}

type GetAppAuthorizationOutput

type GetAppAuthorizationOutput struct {

	// Contains information about an app authorization.
	//
	// This member is required.
	AppAuthorization *types.AppAuthorization

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

type GetAppBundleInput

type GetAppBundleInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string
	// contains filtered or unexported fields
}

type GetAppBundleOutput

type GetAppBundleOutput struct {

	// Contains information about an app bundle.
	//
	// This member is required.
	AppBundle *types.AppBundle

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

type GetIngestionDestinationInput

type GetIngestionDestinationInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion destination to use for the request.
	//
	// This member is required.
	IngestionDestinationIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion to use for the request.
	//
	// This member is required.
	IngestionIdentifier *string
	// contains filtered or unexported fields
}

type GetIngestionDestinationOutput

type GetIngestionDestinationOutput struct {

	// Contains information about an ingestion destination.
	//
	// This member is required.
	IngestionDestination *types.IngestionDestination

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

type GetIngestionInput

type GetIngestionInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion to use for the request.
	//
	// This member is required.
	IngestionIdentifier *string
	// contains filtered or unexported fields
}

type GetIngestionOutput

type GetIngestionOutput struct {

	// Contains information about an ingestion.
	//
	// This member is required.
	Ingestion *types.Ingestion

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

type ListAppAuthorizationsAPIClient interface {
	ListAppAuthorizations(context.Context, *ListAppAuthorizationsInput, ...func(*Options)) (*ListAppAuthorizationsOutput, error)
}

ListAppAuthorizationsAPIClient is a client that implements the ListAppAuthorizations operation.

type ListAppAuthorizationsInput

type ListAppAuthorizationsInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int32

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAppAuthorizationsOutput

type ListAppAuthorizationsOutput struct {

	// Contains a list of app authorization summaries.
	//
	// This member is required.
	AppAuthorizationSummaryList []types.AppAuthorizationSummary

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string

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

type ListAppAuthorizationsPaginator

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

ListAppAuthorizationsPaginator is a paginator for ListAppAuthorizations

func NewListAppAuthorizationsPaginator

NewListAppAuthorizationsPaginator returns a new ListAppAuthorizationsPaginator

func (*ListAppAuthorizationsPaginator) HasMorePages

func (p *ListAppAuthorizationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppAuthorizationsPaginator) NextPage

NextPage retrieves the next ListAppAuthorizations page.

type ListAppAuthorizationsPaginatorOptions

type ListAppAuthorizationsPaginatorOptions struct {
	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	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
}

ListAppAuthorizationsPaginatorOptions is the paginator options for ListAppAuthorizations

type ListAppBundlesAPIClient

type ListAppBundlesAPIClient interface {
	ListAppBundles(context.Context, *ListAppBundlesInput, ...func(*Options)) (*ListAppBundlesOutput, error)
}

ListAppBundlesAPIClient is a client that implements the ListAppBundles operation.

type ListAppBundlesInput

type ListAppBundlesInput struct {

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int32

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAppBundlesOutput

type ListAppBundlesOutput struct {

	// Contains a list of app bundle summaries.
	//
	// This member is required.
	AppBundleSummaryList []types.AppBundleSummary

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string

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

type ListAppBundlesPaginator

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

ListAppBundlesPaginator is a paginator for ListAppBundles

func NewListAppBundlesPaginator

func NewListAppBundlesPaginator(client ListAppBundlesAPIClient, params *ListAppBundlesInput, optFns ...func(*ListAppBundlesPaginatorOptions)) *ListAppBundlesPaginator

NewListAppBundlesPaginator returns a new ListAppBundlesPaginator

func (*ListAppBundlesPaginator) HasMorePages

func (p *ListAppBundlesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppBundlesPaginator) NextPage

func (p *ListAppBundlesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppBundlesOutput, error)

NextPage retrieves the next ListAppBundles page.

type ListAppBundlesPaginatorOptions

type ListAppBundlesPaginatorOptions struct {
	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	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
}

ListAppBundlesPaginatorOptions is the paginator options for ListAppBundles

type ListIngestionDestinationsAPIClient

type ListIngestionDestinationsAPIClient interface {
	ListIngestionDestinations(context.Context, *ListIngestionDestinationsInput, ...func(*Options)) (*ListIngestionDestinationsOutput, error)
}

ListIngestionDestinationsAPIClient is a client that implements the ListIngestionDestinations operation.

type ListIngestionDestinationsInput

type ListIngestionDestinationsInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion to use for the request.
	//
	// This member is required.
	IngestionIdentifier *string

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int32

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIngestionDestinationsOutput

type ListIngestionDestinationsOutput struct {

	// Contains a list of ingestion destination summaries.
	//
	// This member is required.
	IngestionDestinations []types.IngestionDestinationSummary

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string

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

type ListIngestionDestinationsPaginator

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

ListIngestionDestinationsPaginator is a paginator for ListIngestionDestinations

func NewListIngestionDestinationsPaginator

NewListIngestionDestinationsPaginator returns a new ListIngestionDestinationsPaginator

func (*ListIngestionDestinationsPaginator) HasMorePages

func (p *ListIngestionDestinationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIngestionDestinationsPaginator) NextPage

NextPage retrieves the next ListIngestionDestinations page.

type ListIngestionDestinationsPaginatorOptions

type ListIngestionDestinationsPaginatorOptions struct {
	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	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
}

ListIngestionDestinationsPaginatorOptions is the paginator options for ListIngestionDestinations

type ListIngestionsAPIClient

type ListIngestionsAPIClient interface {
	ListIngestions(context.Context, *ListIngestionsInput, ...func(*Options)) (*ListIngestionsOutput, error)
}

ListIngestionsAPIClient is a client that implements the ListIngestions operation.

type ListIngestionsInput

type ListIngestionsInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int32

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIngestionsOutput

type ListIngestionsOutput struct {

	// Contains a list of ingestion summaries.
	//
	// This member is required.
	Ingestions []types.IngestionSummary

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string

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

type ListIngestionsPaginator

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

ListIngestionsPaginator is a paginator for ListIngestions

func NewListIngestionsPaginator

func NewListIngestionsPaginator(client ListIngestionsAPIClient, params *ListIngestionsInput, optFns ...func(*ListIngestionsPaginatorOptions)) *ListIngestionsPaginator

NewListIngestionsPaginator returns a new ListIngestionsPaginator

func (*ListIngestionsPaginator) HasMorePages

func (p *ListIngestionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIngestionsPaginator) NextPage

func (p *ListIngestionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIngestionsOutput, error)

NextPage retrieves the next ListIngestions page.

type ListIngestionsPaginatorOptions

type ListIngestionsPaginatorOptions struct {
	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	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
}

ListIngestionsPaginatorOptions is the paginator options for ListIngestions

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource for which you want to retrieve
	// tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// A map of the key-value pairs for the tag or tags assigned to the specified
	// resource.
	Tags []types.Tag

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

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

	// Indicates how aws account ID is applied in endpoint2.0 routing
	AccountIDEndpointMode aws.AccountIDEndpointMode

	// 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 added in v1.4.2

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartIngestionInput

type StartIngestionInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion to use for the request.
	//
	// This member is required.
	IngestionIdentifier *string
	// contains filtered or unexported fields
}

type StartIngestionOutput

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

type StartUserAccessTasksInput

type StartUserAccessTasksInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The email address of the target user.
	//
	// This member is required.
	Email *string
	// contains filtered or unexported fields
}

type StartUserAccessTasksOutput

type StartUserAccessTasksOutput struct {

	// Contains a list of user access task information.
	UserAccessTasksList []types.UserAccessTaskItem

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

type StopIngestionInput

type StopIngestionInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion to use for the request.
	//
	// This member is required.
	IngestionIdentifier *string
	// contains filtered or unexported fields
}

type StopIngestionOutput

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

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to tag.
	//
	// This member is required.
	ResourceArn *string

	// A map of the key-value pairs of the tag or tags to assign to the resource.
	//
	// This member is required.
	Tags []types.Tag
	// 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 resource that you want to untag.
	//
	// This member is required.
	ResourceArn *string

	// The keys of the key-value pairs for the tag or tags you want to remove from the
	// specified resource.
	//
	// 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 UpdateAppAuthorizationInput

type UpdateAppAuthorizationInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// authorization to use for the request.
	//
	// This member is required.
	AppAuthorizationIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// Contains credentials for the application, such as an API key or OAuth2 client
	// ID and secret.
	//
	// Specify credentials that match the authorization type of the app authorization
	// to update. For example, if the authorization type of the app authorization is
	// OAuth2 ( oauth2 ), then you should provide only the OAuth2 credentials.
	Credential types.Credential

	// Contains information about an application tenant, such as the application
	// display name and identifier.
	Tenant *types.Tenant
	// contains filtered or unexported fields
}

type UpdateAppAuthorizationOutput

type UpdateAppAuthorizationOutput struct {

	// Contains information about an app authorization.
	//
	// This member is required.
	AppAuthorization *types.AppAuthorization

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

type UpdateIngestionDestinationInput

type UpdateIngestionDestinationInput struct {

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app
	// bundle to use for the request.
	//
	// This member is required.
	AppBundleIdentifier *string

	// Contains information about the destination of ingested data.
	//
	// This member is required.
	DestinationConfiguration types.DestinationConfiguration

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion destination to use for the request.
	//
	// This member is required.
	IngestionDestinationIdentifier *string

	// The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the
	// ingestion to use for the request.
	//
	// This member is required.
	IngestionIdentifier *string
	// contains filtered or unexported fields
}

type UpdateIngestionDestinationOutput

type UpdateIngestionDestinationOutput struct {

	// Contains information about an ingestion destination.
	//
	// This member is required.
	IngestionDestination *types.IngestionDestination

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

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL