amplifybackend

package module
v1.27.6 Latest Latest
Warning

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

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

Documentation

Overview

Package amplifybackend provides the API client, operations, and parameter types for AmplifyBackend.

AWS Amplify Admin API

Index

Constants

View Source 
const ServiceAPIVersion = "2020-08-11"
View Source 
const ServiceID = "AmplifyBackend"

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.20.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.20.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.20.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.20.2 

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

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

type Client 

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

Client provides the API client to make operations call for AmplifyBackend.

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

func (c *Client) CloneBackend(ctx context.Context, params *CloneBackendInput, optFns ...func(*Options)) (*CloneBackendOutput, error)

This operation clones an existing backend.

func (*Client) CreateBackend 

func (c *Client) CreateBackend(ctx context.Context, params *CreateBackendInput, optFns ...func(*Options)) (*CreateBackendOutput, error)

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

func (*Client) CreateBackendAPI 

func (c *Client) CreateBackendAPI(ctx context.Context, params *CreateBackendAPIInput, optFns ...func(*Options)) (*CreateBackendAPIOutput, error)

Creates a new backend API resource.

func (*Client) CreateBackendAuth 

func (c *Client) CreateBackendAuth(ctx context.Context, params *CreateBackendAuthInput, optFns ...func(*Options)) (*CreateBackendAuthOutput, error)

Creates a new backend authentication resource.

func (*Client) CreateBackendConfig 

func (c *Client) CreateBackendConfig(ctx context.Context, params *CreateBackendConfigInput, optFns ...func(*Options)) (*CreateBackendConfigOutput, error)

Creates a config object for a backend.

func (*Client) CreateBackendStorage added in v1.8.0 

func (c *Client) CreateBackendStorage(ctx context.Context, params *CreateBackendStorageInput, optFns ...func(*Options)) (*CreateBackendStorageOutput, error)

Creates a backend storage resource.

func (*Client) CreateToken 

func (c *Client) CreateToken(ctx context.Context, params *CreateTokenInput, optFns ...func(*Options)) (*CreateTokenOutput, error)

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

func (*Client) DeleteBackend 

func (c *Client) DeleteBackend(ctx context.Context, params *DeleteBackendInput, optFns ...func(*Options)) (*DeleteBackendOutput, error)

Removes an existing environment from your Amplify project.

func (*Client) DeleteBackendAPI 

func (c *Client) DeleteBackendAPI(ctx context.Context, params *DeleteBackendAPIInput, optFns ...func(*Options)) (*DeleteBackendAPIOutput, error)

Deletes an existing backend API resource.

func (*Client) DeleteBackendAuth 

func (c *Client) DeleteBackendAuth(ctx context.Context, params *DeleteBackendAuthInput, optFns ...func(*Options)) (*DeleteBackendAuthOutput, error)

Deletes an existing backend authentication resource.

func (*Client) DeleteBackendStorage added in v1.8.0 

func (c *Client) DeleteBackendStorage(ctx context.Context, params *DeleteBackendStorageInput, optFns ...func(*Options)) (*DeleteBackendStorageOutput, error)

Removes the specified backend storage resource.

func (*Client) DeleteToken 

func (c *Client) DeleteToken(ctx context.Context, params *DeleteTokenInput, optFns ...func(*Options)) (*DeleteTokenOutput, error)

Deletes the challenge token based on the given appId and sessionId.

func (*Client) GenerateBackendAPIModels 

func (c *Client) GenerateBackendAPIModels(ctx context.Context, params *GenerateBackendAPIModelsInput, optFns ...func(*Options)) (*GenerateBackendAPIModelsOutput, error)

Generates a model schema for an existing backend API resource.

func (*Client) GetBackend 

func (c *Client) GetBackend(ctx context.Context, params *GetBackendInput, optFns ...func(*Options)) (*GetBackendOutput, error)

Provides project-level details for your Amplify UI project.

func (*Client) GetBackendAPI 

func (c *Client) GetBackendAPI(ctx context.Context, params *GetBackendAPIInput, optFns ...func(*Options)) (*GetBackendAPIOutput, error)

Gets the details for a backend API.

func (*Client) GetBackendAPIModels 

func (c *Client) GetBackendAPIModels(ctx context.Context, params *GetBackendAPIModelsInput, optFns ...func(*Options)) (*GetBackendAPIModelsOutput, error)

Gets a model introspection schema for an existing backend API resource.

func (*Client) GetBackendAuth 

func (c *Client) GetBackendAuth(ctx context.Context, params *GetBackendAuthInput, optFns ...func(*Options)) (*GetBackendAuthOutput, error)

Gets a backend auth details.

func (*Client) GetBackendJob 

func (c *Client) GetBackendJob(ctx context.Context, params *GetBackendJobInput, optFns ...func(*Options)) (*GetBackendJobOutput, error)

Returns information about a specific job.

func (*Client) GetBackendStorage added in v1.8.0 

func (c *Client) GetBackendStorage(ctx context.Context, params *GetBackendStorageInput, optFns ...func(*Options)) (*GetBackendStorageOutput, error)

Gets details for a backend storage resource.

func (*Client) GetToken 

func (c *Client) GetToken(ctx context.Context, params *GetTokenInput, optFns ...func(*Options)) (*GetTokenOutput, error)

Gets the challenge token based on the given appId and sessionId.

func (*Client) ImportBackendAuth added in v1.2.0 

func (c *Client) ImportBackendAuth(ctx context.Context, params *ImportBackendAuthInput, optFns ...func(*Options)) (*ImportBackendAuthOutput, error)

Imports an existing backend authentication resource.

func (*Client) ImportBackendStorage added in v1.8.0 

func (c *Client) ImportBackendStorage(ctx context.Context, params *ImportBackendStorageInput, optFns ...func(*Options)) (*ImportBackendStorageOutput, error)

Imports an existing backend storage resource.

func (*Client) ListBackendJobs 

func (c *Client) ListBackendJobs(ctx context.Context, params *ListBackendJobsInput, optFns ...func(*Options)) (*ListBackendJobsOutput, error)

Lists the jobs for the backend of an Amplify app.

func (*Client) ListS3Buckets added in v1.8.0 

func (c *Client) ListS3Buckets(ctx context.Context, params *ListS3BucketsInput, optFns ...func(*Options)) (*ListS3BucketsOutput, error)

The list of S3 buckets in your account.

func (*Client) Options added in v1.21.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) RemoveAllBackends 

func (c *Client) RemoveAllBackends(ctx context.Context, params *RemoveAllBackendsInput, optFns ...func(*Options)) (*RemoveAllBackendsOutput, error)

Removes all backend environments from your Amplify project.

func (*Client) RemoveBackendConfig 

func (c *Client) RemoveBackendConfig(ctx context.Context, params *RemoveBackendConfigInput, optFns ...func(*Options)) (*RemoveBackendConfigOutput, error)

Removes the AWS resources required to access the Amplify Admin UI.

func (*Client) UpdateBackendAPI 

func (c *Client) UpdateBackendAPI(ctx context.Context, params *UpdateBackendAPIInput, optFns ...func(*Options)) (*UpdateBackendAPIOutput, error)

Updates an existing backend API resource.

func (*Client) UpdateBackendAuth 

func (c *Client) UpdateBackendAuth(ctx context.Context, params *UpdateBackendAuthInput, optFns ...func(*Options)) (*UpdateBackendAuthOutput, error)

Updates an existing backend authentication resource.

func (*Client) UpdateBackendConfig 

func (c *Client) UpdateBackendConfig(ctx context.Context, params *UpdateBackendConfigInput, optFns ...func(*Options)) (*UpdateBackendConfigOutput, error)

Updates the AWS resources required to access the Amplify Admin UI.

func (*Client) UpdateBackendJob 

func (c *Client) UpdateBackendJob(ctx context.Context, params *UpdateBackendJobInput, optFns ...func(*Options)) (*UpdateBackendJobOutput, error)

Updates a specific job.

func (*Client) UpdateBackendStorage added in v1.8.0 

func (c *Client) UpdateBackendStorage(ctx context.Context, params *UpdateBackendStorageInput, optFns ...func(*Options)) (*UpdateBackendStorageOutput, error)

Updates an existing backend storage resource.

type CloneBackendInput 

type CloneBackendInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of the destination backend environment to be created.
	//
	// This member is required.
	TargetEnvironmentName *string
	// contains filtered or unexported fields
}

The request body for CloneBackend.

type CloneBackendOutput 

type CloneBackendOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type CreateBackendAPIInput 

type CreateBackendAPIInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The resource configuration for this request.
	//
	// This member is required.
	ResourceConfig *types.BackendAPIResourceConfig

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for CreateBackendAPI.

type CreateBackendAPIOutput 

type CreateBackendAPIOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type CreateBackendAuthInput 

type CreateBackendAuthInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The resource configuration for this request object.
	//
	// This member is required.
	ResourceConfig *types.CreateBackendAuthResourceConfig

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for CreateBackendAuth.

type CreateBackendAuthOutput 

type CreateBackendAuthOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type CreateBackendConfigInput 

type CreateBackendConfigInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The app ID for the backend manager.
	BackendManagerAppId *string
	// contains filtered or unexported fields
}

The request body for CreateBackendConfig.

type CreateBackendConfigOutput 

type CreateBackendConfigOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// The ID for the job.
	JobId *string

	// The current status of the request.
	Status *string

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

type CreateBackendInput 

type CreateBackendInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the app.
	//
	// This member is required.
	AppName *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The resource configuration for creating a backend.
	ResourceConfig *types.ResourceConfig

	// The name of the resource.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for CreateBackend.

type CreateBackendOutput 

type CreateBackendOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type CreateBackendStorageInput added in v1.8.0 

type CreateBackendStorageInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The resource configuration for creating backend storage.
	//
	// This member is required.
	ResourceConfig *types.CreateBackendStorageResourceConfig

	// The name of the storage resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for CreateBackendStorage.

type CreateBackendStorageOutput added in v1.8.0 

type CreateBackendStorageOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// The ID for the job.
	JobId *string

	// The current status of the request.
	Status *string

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

type CreateTokenInput 

type CreateTokenInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string
	// contains filtered or unexported fields
}

type CreateTokenOutput 

type CreateTokenOutput struct {

	// The app ID.
	AppId *string

	// One-time challenge code for authenticating into the Amplify Admin UI.
	ChallengeCode *string

	// A unique ID provided when creating a new challenge token.
	SessionId *string

	// The expiry time for the one-time generated token code.
	Ttl *string

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

type DeleteBackendAPIInput 

type DeleteBackendAPIInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string

	// Defines the resource configuration for the data model in your Amplify project.
	ResourceConfig *types.BackendAPIResourceConfig
	// contains filtered or unexported fields
}

The request body for DeleteBackendAPI.

type DeleteBackendAPIOutput 

type DeleteBackendAPIOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type DeleteBackendAuthInput 

type DeleteBackendAuthInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for DeleteBackendAuth.

type DeleteBackendAuthOutput 

type DeleteBackendAuthOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type DeleteBackendInput 

type DeleteBackendInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string
	// contains filtered or unexported fields
}

type DeleteBackendOutput 

type DeleteBackendOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type DeleteBackendStorageInput added in v1.8.0 

type DeleteBackendStorageInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of the storage resource.
	//
	// This member is required.
	ResourceName *string

	// The name of the storage service.
	//
	// This member is required.
	ServiceName types.ServiceName
	// contains filtered or unexported fields
}

The request body for DeleteBackendStorage.

type DeleteBackendStorageOutput added in v1.8.0 

type DeleteBackendStorageOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// The ID for the job.
	JobId *string

	// The current status of the request.
	Status *string

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

type DeleteTokenInput 

type DeleteTokenInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The session ID.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type DeleteTokenOutput 

type DeleteTokenOutput struct {

	// Indicates whether the request succeeded or failed.
	IsSuccess *bool

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

type EndpointParameters added in v1.15.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.15.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.15.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.15.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.15.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GenerateBackendAPIModelsInput 

type GenerateBackendAPIModelsInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for GenerateBackendAPIModels.

type GenerateBackendAPIModelsOutput 

type GenerateBackendAPIModelsOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type GetBackendAPIInput 

type GetBackendAPIInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string

	// Defines the resource configuration for the data model in your Amplify project.
	ResourceConfig *types.BackendAPIResourceConfig
	// contains filtered or unexported fields
}

The request body for GetBackendAPI.

type GetBackendAPIModelsInput 

type GetBackendAPIModelsInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for GetBackendAPIModels.

type GetBackendAPIModelsOutput 

type GetBackendAPIModelsOutput struct {

	// Stringified JSON of the model introspection schema for an existing backend API
	// resource.
	ModelIntrospectionSchema *string

	// Stringified JSON of the datastore model.
	Models *string

	// The current status of the request.
	Status types.Status

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

type GetBackendAPIOutput 

type GetBackendAPIOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The resource configuration for this response object.
	ResourceConfig *types.BackendAPIResourceConfig

	// The name of this resource.
	ResourceName *string

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

type GetBackendAuthInput 

type GetBackendAuthInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for GetBackendAuth.

type GetBackendAuthOutput 

type GetBackendAuthOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The resource configuration for authorization requests to the backend of your
	// Amplify project.
	ResourceConfig *types.CreateBackendAuthResourceConfig

	// The name of this resource.
	ResourceName *string

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

type GetBackendInput 

type GetBackendInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string
	// contains filtered or unexported fields
}

The request body for GetBackend.

type GetBackendJobInput 

type GetBackendJobInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The ID for the job.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type GetBackendJobOutput 

type GetBackendJobOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// The time when the job was created.
	CreateTime *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

	// The time when the job was last updated.
	UpdateTime *string

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

type GetBackendOutput 

type GetBackendOutput struct {

	// A stringified version of the cli.json file for your Amplify project.
	AmplifyFeatureFlags *string

	// A stringified version of the current configs for your Amplify project.
	AmplifyMetaConfig *string

	// The app ID.
	AppId *string

	// The name of the app.
	AppName *string

	// A list of backend environments in an array.
	BackendEnvironmentList []string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request failed, this is the returned error.
	Error *string

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

type GetBackendStorageInput added in v1.8.0 

type GetBackendStorageInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of the storage resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for GetBackendStorage.

type GetBackendStorageOutput added in v1.8.0 

type GetBackendStorageOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// The resource configuration for the backend storage resource.
	ResourceConfig *types.GetBackendStorageResourceConfig

	// The name of the storage resource.
	ResourceName *string

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

type GetTokenInput 

type GetTokenInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The session ID.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type GetTokenOutput 

type GetTokenOutput struct {

	// The app ID.
	AppId *string

	// The one-time challenge code for authenticating into the Amplify Admin UI.
	ChallengeCode *string

	// A unique ID provided when creating a new challenge token.
	SessionId *string

	// The expiry time for the one-time generated token code.
	Ttl *string

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

type ImportBackendAuthInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The ID of the Amazon Cognito native client.
	//
	// This member is required.
	NativeClientId *string

	// The ID of the Amazon Cognito user pool.
	//
	// This member is required.
	UserPoolId *string

	// The ID of the Amazon Cognito web client.
	//
	// This member is required.
	WebClientId *string

	// The ID of the Amazon Cognito identity pool.
	IdentityPoolId *string
	// contains filtered or unexported fields
}

The request body for ImportBackendAuth.

type ImportBackendAuthOutput added in v1.2.0 

type ImportBackendAuthOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type ImportBackendStorageInput added in v1.8.0 

type ImportBackendStorageInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of the storage service.
	//
	// This member is required.
	ServiceName types.ServiceName

	// The name of the S3 bucket.
	BucketName *string
	// contains filtered or unexported fields
}

The request body for ImportBackendStorage.

type ImportBackendStorageOutput added in v1.8.0 

type ImportBackendStorageOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// The ID for the job.
	JobId *string

	// The current status of the request.
	Status *string

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

type ListBackendJobsAPIClient added in v1.17.0 

type ListBackendJobsAPIClient interface {
	ListBackendJobs(context.Context, *ListBackendJobsInput, ...func(*Options)) (*ListBackendJobsOutput, error)
}

ListBackendJobsAPIClient is a client that implements the ListBackendJobs operation.

type ListBackendJobsInput 

type ListBackendJobsInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The ID for the job.
	JobId *string

	// The maximum number of results that you want in the response.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string

	// Filters the list of response objects to include only those with the specified
	// operation name.
	Operation *string

	// Filters the list of response objects to include only those with the specified
	// status.
	Status *string
	// contains filtered or unexported fields
}

The request body for ListBackendJobs.

type ListBackendJobsOutput 

type ListBackendJobsOutput struct {

	// An array of jobs and their properties.
	Jobs []types.BackendJobRespObj

	// The token for the next set of results.
	NextToken *string

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

type ListBackendJobsPaginator added in v1.17.0 

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

ListBackendJobsPaginator is a paginator for ListBackendJobs

func NewListBackendJobsPaginator added in v1.17.0 

func NewListBackendJobsPaginator(client ListBackendJobsAPIClient, params *ListBackendJobsInput, optFns ...func(options *ListBackendJobsPaginatorOptions)) *ListBackendJobsPaginator

NewListBackendJobsPaginator returns a new ListBackendJobsPaginator

func (*ListBackendJobsPaginator) HasMorePages added in v1.17.0 

func (p *ListBackendJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBackendJobsPaginator) NextPage added in v1.17.0 

func (p *ListBackendJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBackendJobsOutput, error)

NextPage retrieves the next ListBackendJobs page.

type ListBackendJobsPaginatorOptions added in v1.17.0 

type ListBackendJobsPaginatorOptions struct {
	// (Optional) The maximum number of shards to return in a single call
	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
}

ListBackendJobsPaginatorOptions is the paginator options for ListBackendJobs

type ListS3BucketsInput added in v1.8.0 

type ListS3BucketsInput struct {

	// Reserved for future use.
	NextToken *string
	// contains filtered or unexported fields
}

The request body for S3Buckets.

type ListS3BucketsOutput added in v1.8.0 

type ListS3BucketsOutput struct {

	// The list of S3 buckets.
	Buckets []types.S3BucketInfo

	// Reserved for future use.
	NextToken *string

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

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

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

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

type RemoveAllBackendsInput 

type RemoveAllBackendsInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// Cleans up the Amplify Console app if this value is set to true.
	CleanAmplifyApp *bool
	// contains filtered or unexported fields
}

The request body for RemoveAllBackends.

type RemoveAllBackendsOutput 

type RemoveAllBackendsOutput struct {

	// The app ID.
	AppId *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type RemoveBackendConfigInput 

type RemoveBackendConfigInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string
	// contains filtered or unexported fields
}

type RemoveBackendConfigOutput 

type RemoveBackendConfigOutput struct {

	// If the request fails, this error is returned.
	Error *string

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

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 UpdateBackendAPIInput 

type UpdateBackendAPIInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string

	// Defines the resource configuration for the data model in your Amplify project.
	ResourceConfig *types.BackendAPIResourceConfig
	// contains filtered or unexported fields
}

The request body for UpdateBackendAPI.

type UpdateBackendAPIOutput 

type UpdateBackendAPIOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type UpdateBackendAuthInput 

type UpdateBackendAuthInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The resource configuration for this request object.
	//
	// This member is required.
	ResourceConfig *types.UpdateBackendAuthResourceConfig

	// The name of this resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for UpdateBackendAuth.

type UpdateBackendAuthOutput 

type UpdateBackendAuthOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

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

type UpdateBackendConfigInput 

type UpdateBackendConfigInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// Describes the Amazon Cognito configuration for Admin UI access.
	LoginAuthConfig *types.LoginAuthConfigReqObj
	// contains filtered or unexported fields
}

The request body for UpdateBackendConfig.

type UpdateBackendConfigOutput 

type UpdateBackendConfigOutput struct {

	// The app ID.
	AppId *string

	// The app ID for the backend manager.
	BackendManagerAppId *string

	// If the request fails, this error is returned.
	Error *string

	// Describes the Amazon Cognito configurations for the Admin UI auth resource to
	// log in with.
	LoginAuthConfig *types.LoginAuthConfigReqObj

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

type UpdateBackendJobInput 

type UpdateBackendJobInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The ID for the job.
	//
	// This member is required.
	JobId *string

	// Filters the list of response objects to include only those with the specified
	// operation name.
	Operation *string

	// Filters the list of response objects to include only those with the specified
	// status.
	Status *string
	// contains filtered or unexported fields
}

The request body for GetBackendJob.

type UpdateBackendJobOutput 

type UpdateBackendJobOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// The time when the job was created.
	CreateTime *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

	// The time when the job was last updated.
	UpdateTime *string

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

type UpdateBackendStorageInput added in v1.8.0 

type UpdateBackendStorageInput struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The resource configuration for updating backend storage.
	//
	// This member is required.
	ResourceConfig *types.UpdateBackendStorageResourceConfig

	// The name of the storage resource.
	//
	// This member is required.
	ResourceName *string
	// contains filtered or unexported fields
}

The request body for UpdateBackendStorage.

type UpdateBackendStorageOutput added in v1.8.0 

type UpdateBackendStorageOutput struct {

	// The app ID.
	AppId *string

	// The name of the backend environment.
	BackendEnvironmentName *string

	// The ID for the job.
	JobId *string

	// The current status of the request.
	Status *string

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

Source Files

View all Source files

Directories

Path Synopsis
internal
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.