types

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have access to perform this operation on this resource.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

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

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AdditionalAuthenticationProvider 

type AdditionalAuthenticationProvider struct {

	// The authentication type: API key, Identity and Access Management (IAM), OpenID
	// Connect (OIDC), Amazon Cognito user pools, or Lambda.
	AuthenticationType AuthenticationType

	// Configuration for Lambda function authorization.
	LambdaAuthorizerConfig *LambdaAuthorizerConfig

	// The OIDC configuration.
	OpenIDConnectConfig *OpenIDConnectConfig

	// The Amazon Cognito user pool configuration.
	UserPoolConfig *CognitoUserPoolConfig
	// contains filtered or unexported fields
}

Describes an additional authentication provider.

type ApiAssociation 

type ApiAssociation struct {

	// The API ID.
	ApiId *string

	// Identifies the status of an association.
	//
	//   - PROCESSING: The API association is being created. You cannot modify
	//   association requests during processing.
	//
	//   - SUCCESS: The API association was successful. You can modify associations
	//   after success.
	//
	//   - FAILED: The API association has failed. You can modify associations after
	//   failure.
	AssociationStatus AssociationStatus

	// Details about the last deployment status.
	DeploymentDetail *string

	// The domain name.
	DomainName *string
	// contains filtered or unexported fields
}

Describes an ApiAssociation object.

type ApiCache 

type ApiCache struct {

	// Caching behavior.
	//
	//   - FULL_REQUEST_CACHING: All requests are fully cached.
	//
	//   - PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
	ApiCachingBehavior ApiCachingBehavior

	// At-rest encryption flag for cache. You cannot update this setting after
	// creation.
	AtRestEncryptionEnabled bool

	// Controls how cache health metrics will be emitted to CloudWatch. Cache health
	// metrics include:
	//
	//   - NetworkBandwidthOutAllowanceExceeded: The network packets dropped because
	//   the throughput exceeded the aggregated bandwidth limit. This is useful for
	//   diagnosing bottlenecks in a cache configuration.
	//
	//   - EngineCPUUtilization: The CPU utilization (percentage) allocated to the
	//   Redis process. This is useful for diagnosing bottlenecks in a cache
	//   configuration.
	//
	// Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED
	// .
	HealthMetricsConfig CacheHealthMetricsConfig

	// The cache instance status.
	//
	//   - AVAILABLE: The instance is available for use.
	//
	//   - CREATING: The instance is currently creating.
	//
	//   - DELETING: The instance is currently deleting.
	//
	//   - MODIFYING: The instance is currently modifying.
	//
	//   - FAILED: The instance has failed creation.
	Status ApiCacheStatus

	// Transit encryption flag when connecting to cache. You cannot update this
	// setting after creation.
	TransitEncryptionEnabled bool

	// TTL in seconds for cache entries.
	//
	// Valid values are 1–3,600 seconds.
	Ttl int64

	// The cache instance type. Valid values are
	//
	//   - SMALL
	//
	//   - MEDIUM
	//
	//   - LARGE
	//
	//   - XLARGE
	//
	//   - LARGE_2X
	//
	//   - LARGE_4X
	//
	//   - LARGE_8X (not available in all regions)
	//
	//   - LARGE_12X
	//
	// Historically, instance types were identified by an EC2-style value. As of July
	// 2020, this is deprecated, and the generic identifiers above should be used.
	//
	// The following legacy instance types are available, but their use is discouraged:
	//
	//   - T2_SMALL: A t2.small instance type.
	//
	//   - T2_MEDIUM: A t2.medium instance type.
	//
	//   - R4_LARGE: A r4.large instance type.
	//
	//   - R4_XLARGE: A r4.xlarge instance type.
	//
	//   - R4_2XLARGE: A r4.2xlarge instance type.
	//
	//   - R4_4XLARGE: A r4.4xlarge instance type.
	//
	//   - R4_8XLARGE: A r4.8xlarge instance type.
	Type ApiCacheType
	// contains filtered or unexported fields
}

The ApiCache object.

type ApiCacheStatus 

type ApiCacheStatus string
const (
	ApiCacheStatusAvailable ApiCacheStatus = "AVAILABLE"
	ApiCacheStatusCreating  ApiCacheStatus = "CREATING"
	ApiCacheStatusDeleting  ApiCacheStatus = "DELETING"
	ApiCacheStatusModifying ApiCacheStatus = "MODIFYING"
	ApiCacheStatusFailed    ApiCacheStatus = "FAILED"
)

Enum values for ApiCacheStatus

func (ApiCacheStatus) Values 

func (ApiCacheStatus) Values() []ApiCacheStatus

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

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

type ApiCacheType 

type ApiCacheType string
const (
	ApiCacheTypeT2Small   ApiCacheType = "T2_SMALL"
	ApiCacheTypeT2Medium  ApiCacheType = "T2_MEDIUM"
	ApiCacheTypeR4Large   ApiCacheType = "R4_LARGE"
	ApiCacheTypeR4Xlarge  ApiCacheType = "R4_XLARGE"
	ApiCacheTypeR42xlarge ApiCacheType = "R4_2XLARGE"
	ApiCacheTypeR44xlarge ApiCacheType = "R4_4XLARGE"
	ApiCacheTypeR48xlarge ApiCacheType = "R4_8XLARGE"
	ApiCacheTypeSmall     ApiCacheType = "SMALL"
	ApiCacheTypeMedium    ApiCacheType = "MEDIUM"
	ApiCacheTypeLarge     ApiCacheType = "LARGE"
	ApiCacheTypeXlarge    ApiCacheType = "XLARGE"
	ApiCacheTypeLarge2x   ApiCacheType = "LARGE_2X"
	ApiCacheTypeLarge4x   ApiCacheType = "LARGE_4X"
	ApiCacheTypeLarge8x   ApiCacheType = "LARGE_8X"
	ApiCacheTypeLarge12x  ApiCacheType = "LARGE_12X"
)

Enum values for ApiCacheType

func (ApiCacheType) Values 

func (ApiCacheType) Values() []ApiCacheType

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

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

type ApiCachingBehavior 

type ApiCachingBehavior string
const (
	ApiCachingBehaviorFullRequestCaching ApiCachingBehavior = "FULL_REQUEST_CACHING"
	ApiCachingBehaviorPerResolverCaching ApiCachingBehavior = "PER_RESOLVER_CACHING"
)

Enum values for ApiCachingBehavior

func (ApiCachingBehavior) Values 

func (ApiCachingBehavior) Values() []ApiCachingBehavior

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

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

type ApiKey 

type ApiKey struct {

	// The time after which the API key is deleted. The date is represented as seconds
	// since the epoch, rounded down to the nearest hour.
	Deletes int64

	// A description of the purpose of the API key.
	Description *string

	// The time after which the API key expires. The date is represented as seconds
	// since the epoch, rounded down to the nearest hour.
	Expires int64

	// The API key ID.
	Id *string
	// contains filtered or unexported fields
}

Describes an API key.

Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:

da1: We introduced this version at launch in November 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid after February 21, 2018, and they should no longer be used.

  • ListApiKeys returns the expiration time in milliseconds.

  • CreateApiKey returns the expiration time in milliseconds.

  • UpdateApiKey is not available for this key version.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we deleted these keys from the table on February 21, 2018.

da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.

  • ListApiKeys returns the expiration time and deletion time in seconds.

  • CreateApiKey returns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.

  • UpdateApiKey returns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. You can update the key expiration time as long as the key isn't deleted.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. However, you can reinstate the key before deletion.

  • Deletion is stored in DynamoDB as seconds. The key is deleted after deletion time.

type ApiKeyLimitExceededException 

type ApiKeyLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The API key exceeded a limit. Try your request again.

func (*ApiKeyLimitExceededException) Error 

func (e *ApiKeyLimitExceededException) Error() string

func (*ApiKeyLimitExceededException) ErrorCode 

func (e *ApiKeyLimitExceededException) ErrorCode() string

func (*ApiKeyLimitExceededException) ErrorFault 

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

func (*ApiKeyLimitExceededException) ErrorMessage 

func (e *ApiKeyLimitExceededException) ErrorMessage() string

type ApiKeyValidityOutOfBoundsException 

type ApiKeyValidityOutOfBoundsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey ) or from update (for UpdateApiKey ).

func (*ApiKeyValidityOutOfBoundsException) Error 

func (e *ApiKeyValidityOutOfBoundsException) Error() string

func (*ApiKeyValidityOutOfBoundsException) ErrorCode 

func (e *ApiKeyValidityOutOfBoundsException) ErrorCode() string

func (*ApiKeyValidityOutOfBoundsException) ErrorFault 

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

func (*ApiKeyValidityOutOfBoundsException) ErrorMessage 

func (e *ApiKeyValidityOutOfBoundsException) ErrorMessage() string

type ApiLimitExceededException 

type ApiLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The GraphQL API exceeded a limit. Try your request again.

func (*ApiLimitExceededException) Error 

func (e *ApiLimitExceededException) Error() string

func (*ApiLimitExceededException) ErrorCode 

func (e *ApiLimitExceededException) ErrorCode() string

func (*ApiLimitExceededException) ErrorFault 

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

func (*ApiLimitExceededException) ErrorMessage 

func (e *ApiLimitExceededException) ErrorMessage() string

type AppSyncRuntime 

type AppSyncRuntime struct {

	// The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS .
	//
	// This member is required.
	Name RuntimeName

	// The version of the runtime to use. Currently, the only allowed version is 1.0.0 .
	//
	// This member is required.
	RuntimeVersion *string
	// contains filtered or unexported fields
}

Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

type AssociationStatus 

type AssociationStatus string
const (
	AssociationStatusProcessing AssociationStatus = "PROCESSING"
	AssociationStatusFailed     AssociationStatus = "FAILED"
	AssociationStatusSuccess    AssociationStatus = "SUCCESS"
)

Enum values for AssociationStatus

func (AssociationStatus) Values 

func (AssociationStatus) Values() []AssociationStatus

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

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

type AuthenticationType 

type AuthenticationType string
const (
	AuthenticationTypeApiKey                 AuthenticationType = "API_KEY"
	AuthenticationTypeAwsIam                 AuthenticationType = "AWS_IAM"
	AuthenticationTypeAmazonCognitoUserPools AuthenticationType = "AMAZON_COGNITO_USER_POOLS"
	AuthenticationTypeOpenidConnect          AuthenticationType = "OPENID_CONNECT"
	AuthenticationTypeAwsLambda              AuthenticationType = "AWS_LAMBDA"
)

Enum values for AuthenticationType

func (AuthenticationType) Values 

func (AuthenticationType) Values() []AuthenticationType

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

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

type AuthorizationConfig 

type AuthorizationConfig struct {

	// The authorization type that the HTTP endpoint requires.
	//
	//   - AWS_IAM: The authorization type is Signature Version 4 (SigV4).
	//
	// This member is required.
	AuthorizationType AuthorizationType

	// The Identity and Access Management (IAM) settings.
	AwsIamConfig *AwsIamConfig
	// contains filtered or unexported fields
}

The authorization configuration in case the HTTP endpoint requires authorization.

type AuthorizationType 

type AuthorizationType string
const (
	AuthorizationTypeAwsIam AuthorizationType = "AWS_IAM"
)

Enum values for AuthorizationType

func (AuthorizationType) Values 

func (AuthorizationType) Values() []AuthorizationType

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

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

type AwsIamConfig 

type AwsIamConfig struct {

	// The signing Amazon Web Services Region for IAM authorization.
	SigningRegion *string

	// The signing service name for IAM authorization.
	SigningServiceName *string
	// contains filtered or unexported fields
}

The Identity and Access Management (IAM) configuration.

type BadRequestDetail 

type BadRequestDetail struct {

	// Contains the list of errors in the request.
	CodeErrors []CodeError
	// contains filtered or unexported fields
}

Provides further details for the reason behind the bad request. For reason type CODE_ERROR , the detail will contain a list of code errors.

type BadRequestException 

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string

	Reason BadRequestReason
	Detail *BadRequestDetail
	// contains filtered or unexported fields
}

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

func (*BadRequestException) Error 

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode 

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault 

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

func (*BadRequestException) ErrorMessage 

func (e *BadRequestException) ErrorMessage() string

type BadRequestReason 

type BadRequestReason string
const (
	BadRequestReasonCodeError BadRequestReason = "CODE_ERROR"
)

Enum values for BadRequestReason

func (BadRequestReason) Values 

func (BadRequestReason) Values() []BadRequestReason

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

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

type CacheHealthMetricsConfig 

type CacheHealthMetricsConfig string
const (
	CacheHealthMetricsConfigEnabled  CacheHealthMetricsConfig = "ENABLED"
	CacheHealthMetricsConfigDisabled CacheHealthMetricsConfig = "DISABLED"
)

Enum values for CacheHealthMetricsConfig

func (CacheHealthMetricsConfig) Values 

func (CacheHealthMetricsConfig) Values() []CacheHealthMetricsConfig

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

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

type CachingConfig 

type CachingConfig struct {

	// The TTL in seconds for a resolver that has caching activated.
	//
	// Valid values are 1–3,600 seconds.
	//
	// This member is required.
	Ttl int64

	// The caching keys for a resolver that has caching activated.
	//
	// Valid values are entries from the $context.arguments , $context.source , and
	// $context.identity maps.
	CachingKeys []string
	// contains filtered or unexported fields
}

The caching configuration for a resolver that has caching activated.

type CodeError 

type CodeError struct {

	// The type of code error.
	//
	// Examples include, but aren't limited to: LINT_ERROR , PARSER_ERROR .
	ErrorType *string

	// The line, column, and span location of the error in the code.
	Location *CodeErrorLocation

	// A user presentable error.
	//
	// Examples include, but aren't limited to: Parsing error: Unterminated string
	// literal .
	Value *string
	// contains filtered or unexported fields
}

Describes an AppSync error.

type CodeErrorLocation 

type CodeErrorLocation struct {

	// The column number in the code. Defaults to 0 if unknown.
	Column int32

	// The line number in the code. Defaults to 0 if unknown.
	Line int32

	// The span/length of the error. Defaults to -1 if unknown.
	Span int32
	// contains filtered or unexported fields
}

Describes the location of the error in a code sample.

type CognitoUserPoolConfig 

type CognitoUserPoolConfig struct {

	// The Amazon Web Services Region in which the user pool was created.
	//
	// This member is required.
	AwsRegion *string

	// The user pool ID.
	//
	// This member is required.
	UserPoolId *string

	// A regular expression for validating the incoming Amazon Cognito user pool app
	// client ID. If this value isn't set, no filtering is applied.
	AppIdClientRegex *string
	// contains filtered or unexported fields
}

Describes an Amazon Cognito user pool configuration.

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Another modification is in progress at this time and it must complete before you can make your change.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

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

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

type ConflictDetectionType 

type ConflictDetectionType string
const (
	ConflictDetectionTypeVersion ConflictDetectionType = "VERSION"
	ConflictDetectionTypeNone    ConflictDetectionType = "NONE"
)

Enum values for ConflictDetectionType

func (ConflictDetectionType) Values 

func (ConflictDetectionType) Values() []ConflictDetectionType

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

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

type ConflictHandlerType 

type ConflictHandlerType string
const (
	ConflictHandlerTypeOptimisticConcurrency ConflictHandlerType = "OPTIMISTIC_CONCURRENCY"
	ConflictHandlerTypeLambda                ConflictHandlerType = "LAMBDA"
	ConflictHandlerTypeAutomerge             ConflictHandlerType = "AUTOMERGE"
	ConflictHandlerTypeNone                  ConflictHandlerType = "NONE"
)

Enum values for ConflictHandlerType

func (ConflictHandlerType) Values 

func (ConflictHandlerType) Values() []ConflictHandlerType

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

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

type DataSource 

type DataSource struct {

	// The data source Amazon Resource Name (ARN).
	DataSourceArn *string

	// The description of the data source.
	Description *string

	// DynamoDB settings.
	DynamodbConfig *DynamodbDataSourceConfig

	// Amazon OpenSearch Service settings.
	ElasticsearchConfig *ElasticsearchDataSourceConfig

	// Amazon EventBridge settings.
	EventBridgeConfig *EventBridgeDataSourceConfig

	// HTTP endpoint settings.
	HttpConfig *HttpDataSourceConfig

	// Lambda settings.
	LambdaConfig *LambdaDataSourceConfig

	// Enables or disables enhanced data source metrics for specified data sources.
	// Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior
	// value is set to PER_DATA_SOURCE_METRICS . If the dataSourceLevelMetricsBehavior
	// is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be
	// ignored. However, you can still set its value.
	//
	// metricsConfig can be ENABLED or DISABLED .
	MetricsConfig DataSourceLevelMetricsConfig

	// The name of the data source.
	Name *string

	// Amazon OpenSearch Service settings.
	OpenSearchServiceConfig *OpenSearchServiceDataSourceConfig

	// Relational database settings.
	RelationalDatabaseConfig *RelationalDatabaseDataSourceConfig

	// The Identity and Access Management (IAM) service role Amazon Resource Name
	// (ARN) for the data source. The system assumes this role when accessing the data
	// source.
	ServiceRoleArn *string

	// The type of the data source.
	//
	//   - AWS_LAMBDA: The data source is an Lambda function.
	//
	//   - AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
	//
	//   - AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service
	//   domain.
	//
	//   - AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service
	//   domain.
	//
	//   - AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
	//
	//   - NONE: There is no data source. Use this type when you want to invoke a
	//   GraphQL operation without connecting to a data source, such as when you're
	//   performing data transformation with resolvers or invoking a subscription from a
	//   mutation.
	//
	//   - HTTP: The data source is an HTTP endpoint.
	//
	//   - RELATIONAL_DATABASE: The data source is a relational database.
	Type DataSourceType
	// contains filtered or unexported fields
}

Describes a data source.

type DataSourceIntrospectionModel 

type DataSourceIntrospectionModel struct {

	// The DataSourceIntrospectionModelField object data.
	Fields []DataSourceIntrospectionModelField

	// The array of DataSourceIntrospectionModelIndex objects.
	Indexes []DataSourceIntrospectionModelIndex

	// The name of the model. For example, this could be the name of a single table in
	// a database.
	Name *string

	// The primary key stored as a DataSourceIntrospectionModelIndex object.
	PrimaryKey *DataSourceIntrospectionModelIndex

	// Contains the output of the SDL that was generated from the introspected types.
	// This is controlled by the includeModelsSDL parameter of the
	// GetDataSourceIntrospection operation.
	Sdl *string
	// contains filtered or unexported fields
}

Contains the introspected data that was retrieved from the data source.

type DataSourceIntrospectionModelField 

type DataSourceIntrospectionModelField struct {

	// The length value of the introspected field.
	Length int64

	// The name of the field that was retrieved from the introspected data.
	Name *string

	// The DataSourceIntrospectionModelFieldType object data.
	Type *DataSourceIntrospectionModelFieldType
	// contains filtered or unexported fields
}

Represents the fields that were retrieved from the introspected data.

type DataSourceIntrospectionModelFieldType 

type DataSourceIntrospectionModelFieldType struct {

	// Specifies the classification of data. For example, this could be set to values
	// like Scalar or NonNull to indicate a fundamental property of the field.
	//
	// Valid values include:
	//
	//   - Scalar : Indicates the value is a primitive type (scalar).
	//
	//   - NonNull : Indicates the field cannot be null .
	//
	//   - List : Indicates the field contains a list.
	Kind *string

	// The name of the data type that represents the field. For example, String is a
	// valid name value.
	Name *string

	// The DataSourceIntrospectionModelFieldType object data. The type is only present
	// if DataSourceIntrospectionModelFieldType.kind is set to NonNull or List .
	//
	// The type typically contains its own kind and name fields to represent the
	// actual type data. For instance, type could contain a kind value of Scalar with
	// a name value of String . The values Scalar and String will be collectively
	// stored in the values field.
	Type *DataSourceIntrospectionModelFieldType

	// The values of the type field. This field represents the AppSync data type
	// equivalent of the introspected field.
	Values []string
	// contains filtered or unexported fields
}

Represents the type data for each field retrieved from the introspection.

type DataSourceIntrospectionModelIndex 

type DataSourceIntrospectionModelIndex struct {

	// The fields of the index.
	Fields []string

	// The name of the index.
	Name *string
	// contains filtered or unexported fields
}

The index that was retrieved from the introspected data.

type DataSourceIntrospectionResult 

type DataSourceIntrospectionResult struct {

	// The array of DataSourceIntrospectionModel objects.
	Models []DataSourceIntrospectionModel

	// Determines the number of types to be returned in a single response before
	// paginating. This value is typically taken from nextToken value from the
	// previous response.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the output of a DataSourceIntrospectionResult . This is the populated result of a GetDataSourceIntrospection operation.

type DataSourceIntrospectionStatus 

type DataSourceIntrospectionStatus string
const (
	DataSourceIntrospectionStatusProcessing DataSourceIntrospectionStatus = "PROCESSING"
	DataSourceIntrospectionStatusFailed     DataSourceIntrospectionStatus = "FAILED"
	DataSourceIntrospectionStatusSuccess    DataSourceIntrospectionStatus = "SUCCESS"
)

Enum values for DataSourceIntrospectionStatus

func (DataSourceIntrospectionStatus) Values 

func (DataSourceIntrospectionStatus) Values() []DataSourceIntrospectionStatus

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

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

type DataSourceLevelMetricsBehavior 

type DataSourceLevelMetricsBehavior string
const (
	DataSourceLevelMetricsBehaviorFullRequestDataSourceMetrics DataSourceLevelMetricsBehavior = "FULL_REQUEST_DATA_SOURCE_METRICS"
	DataSourceLevelMetricsBehaviorPerDataSourceMetrics         DataSourceLevelMetricsBehavior = "PER_DATA_SOURCE_METRICS"
)

Enum values for DataSourceLevelMetricsBehavior

func (DataSourceLevelMetricsBehavior) Values 

func (DataSourceLevelMetricsBehavior) Values() []DataSourceLevelMetricsBehavior

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

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

type DataSourceLevelMetricsConfig 

type DataSourceLevelMetricsConfig string
const (
	DataSourceLevelMetricsConfigEnabled  DataSourceLevelMetricsConfig = "ENABLED"
	DataSourceLevelMetricsConfigDisabled DataSourceLevelMetricsConfig = "DISABLED"
)

Enum values for DataSourceLevelMetricsConfig

func (DataSourceLevelMetricsConfig) Values 

func (DataSourceLevelMetricsConfig) Values() []DataSourceLevelMetricsConfig

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

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

type DataSourceType 

type DataSourceType string
const (
	DataSourceTypeAwsLambda               DataSourceType = "AWS_LAMBDA"
	DataSourceTypeAmazonDynamodb          DataSourceType = "AMAZON_DYNAMODB"
	DataSourceTypeAmazonElasticsearch     DataSourceType = "AMAZON_ELASTICSEARCH"
	DataSourceTypeNone                    DataSourceType = "NONE"
	DataSourceTypeHttp                    DataSourceType = "HTTP"
	DataSourceTypeRelationalDatabase      DataSourceType = "RELATIONAL_DATABASE"
	DataSourceTypeAmazonOpensearchService DataSourceType = "AMAZON_OPENSEARCH_SERVICE"
	DataSourceTypeAmazonEventbridge       DataSourceType = "AMAZON_EVENTBRIDGE"
)

Enum values for DataSourceType

func (DataSourceType) Values 

func (DataSourceType) Values() []DataSourceType

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

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

type DefaultAction 

type DefaultAction string
const (
	DefaultActionAllow DefaultAction = "ALLOW"
	DefaultActionDeny  DefaultAction = "DENY"
)

Enum values for DefaultAction

func (DefaultAction) Values 

func (DefaultAction) Values() []DefaultAction

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

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

type DeltaSyncConfig 

type DeltaSyncConfig struct {

	// The number of minutes that an Item is stored in the data source.
	BaseTableTTL int64

	// The Delta Sync table name.
	DeltaSyncTableName *string

	// The number of minutes that a Delta Sync log entry is stored in the Delta Sync
	// table.
	DeltaSyncTableTTL int64
	// contains filtered or unexported fields
}

Describes a Delta Sync configuration.

type DomainNameConfig 

type DomainNameConfig struct {

	// The domain name that AppSync provides.
	AppsyncDomainName *string

	// The Amazon Resource Name (ARN) of the certificate. This can be an Certificate
	// Manager (ACM) certificate or an Identity and Access Management (IAM) server
	// certificate.
	CertificateArn *string

	// A description of the DomainName configuration.
	Description *string

	// The domain name.
	DomainName *string

	// The ID of your Amazon Route 53 hosted zone.
	HostedZoneId *string
	// contains filtered or unexported fields
}

Describes a configuration for a custom domain.

type DynamodbDataSourceConfig 

type DynamodbDataSourceConfig struct {

	// The Amazon Web Services Region.
	//
	// This member is required.
	AwsRegion *string

	// The table name.
	//
	// This member is required.
	TableName *string

	// The DeltaSyncConfig for a versioned data source.
	DeltaSyncConfig *DeltaSyncConfig

	// Set to TRUE to use Amazon Cognito credentials with this data source.
	UseCallerCredentials bool

	// Set to TRUE to use Conflict Detection and Resolution with this data source.
	Versioned bool
	// contains filtered or unexported fields
}

Describes an Amazon DynamoDB data source configuration.

type ElasticsearchDataSourceConfig 

type ElasticsearchDataSourceConfig struct {

	// The Amazon Web Services Region.
	//
	// This member is required.
	AwsRegion *string

	// The endpoint.
	//
	// This member is required.
	Endpoint *string
	// contains filtered or unexported fields
}

Describes an OpenSearch data source configuration.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfigto specify an OpenSearch data source.

type EnhancedMetricsConfig 

type EnhancedMetricsConfig struct {

	// Controls how data source metrics will be emitted to CloudWatch. Data source
	// metrics include:
	//
	//   - Requests: The number of invocations that occured during a request.
	//
	//   - Latency: The time to complete a data source invocation.
	//
	//   - Errors: The number of errors that occurred during a data source invocation.
	//
	// These metrics can be emitted to CloudWatch per data source or for all data
	// sources in the request. Metrics will be recorded by API ID and data source name.
	// dataSourceLevelMetricsBehavior accepts one of these values at a time:
	//
	//   - FULL_REQUEST_DATA_SOURCE_METRICS : Records and emits metric data for all
	//   data sources in the request.
	//
	//   - PER_DATA_SOURCE_METRICS : Records and emits metric data for data sources
	//   that have the metricsConfig value set to ENABLED .
	//
	// This member is required.
	DataSourceLevelMetricsBehavior DataSourceLevelMetricsBehavior

	//  Controls how operation metrics will be emitted to CloudWatch. Operation
	// metrics include:
	//
	//   - Requests: The number of times a specified GraphQL operation was called.
	//
	//   - GraphQL errors: The number of GraphQL errors that occurred during a
	//   specified GraphQL operation.
	//
	// Metrics will be recorded by API ID and operation name. You can set the value to
	// ENABLED or DISABLED .
	//
	// This member is required.
	OperationLevelMetricsConfig OperationLevelMetricsConfig

	// Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics
	// include:
	//
	//   - GraphQL errors: The number of GraphQL errors that occurred.
	//
	//   - Requests: The number of invocations that occurred during a request.
	//
	//   - Latency: The time to complete a resolver invocation.
	//
	//   - Cache hits: The number of cache hits during a request.
	//
	//   - Cache misses: The number of cache misses during a request.
	//
	// These metrics can be emitted to CloudWatch per resolver or for all resolvers in
	// the request. Metrics will be recorded by API ID and resolver name.
	// resolverLevelMetricsBehavior accepts one of these values at a time:
	//
	//   - FULL_REQUEST_RESOLVER_METRICS : Records and emits metric data for all
	//   resolvers in the request.
	//
	//   - PER_RESOLVER_METRICS : Records and emits metric data for resolvers that have
	//   the metricsConfig value set to ENABLED .
	//
	// This member is required.
	ResolverLevelMetricsBehavior ResolverLevelMetricsBehavior
	// contains filtered or unexported fields
}

Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.

Enhanced metrics can be configured at the resolver, data source, and operation levels. EnhancedMetricsConfig contains three required parameters, each controlling one of these categories:

  • resolverLevelMetricsBehavior : Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

  • GraphQL errors: The number of GraphQL errors that occurred.

  • Requests: The number of invocations that occurred during a request.

  • Latency: The time to complete a resolver invocation.

  • Cache hits: The number of cache hits during a request.

  • Cache misses: The number of cache misses during a request.

These metrics can be emitted to CloudWatch per resolver or for all resolvers in 

the request. Metrics will be recorded by API ID and resolver name.
resolverLevelMetricsBehavior accepts one of these values at a time:

- FULL_REQUEST_RESOLVER_METRICS : Records and emits metric data for all
resolvers in the request.

- PER_RESOLVER_METRICS : Records and emits metric data for resolvers that have
the metricsConfig value set to ENABLED .

- dataSourceLevelMetricsBehavior : Controls how data source metrics will be
emitted to CloudWatch. Data source metrics include:

- Requests: The number of invocations that occured during a request.

- Latency: The time to complete a data source invocation.

- Errors: The number of errors that occurred during a data source invocation.

These metrics can be emitted to CloudWatch per data source or for all data 

sources in the request. Metrics will be recorded by API ID and data source name.
dataSourceLevelMetricsBehavior accepts one of these values at a time:

- FULL_REQUEST_DATA_SOURCE_METRICS : Records and emits metric data for all
data sources in the request.

- PER_DATA_SOURCE_METRICS : Records and emits metric data for data sources
that have the metricsConfig value set to ENABLED .

- operationLevelMetricsConfig : Controls how operation metrics will be emitted
to CloudWatch. Operation metrics include:

- Requests: The number of times a specified GraphQL operation was called.

- GraphQL errors: The number of GraphQL errors that occurred during a
specified GraphQL operation.

Metrics will be recorded by API ID and operation name. You can set the value to 

ENABLED or DISABLED .

type ErrorDetail 

type ErrorDetail struct {

	// The error payload.
	Message *string
	// contains filtered or unexported fields
}

Contains the list of errors generated. When using JavaScript, this will apply to the request or response function evaluation.

type EvaluateCodeErrorDetail 

type EvaluateCodeErrorDetail struct {

	// Contains the list of CodeError objects.
	CodeErrors []CodeError

	// The error payload.
	Message *string
	// contains filtered or unexported fields
}

Contains the list of errors from a code evaluation response.

type EventBridgeDataSourceConfig 

type EventBridgeDataSourceConfig struct {

	// The ARN of the event bus. For more information about event buses, see [Amazon EventBridge event buses].
	//
	// [Amazon EventBridge event buses]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html
	//
	// This member is required.
	EventBusArn *string
	// contains filtered or unexported fields
}

Describes an Amazon EventBridge bus data source configuration.

type FieldLogLevel 

type FieldLogLevel string
const (
	FieldLogLevelNone  FieldLogLevel = "NONE"
	FieldLogLevelError FieldLogLevel = "ERROR"
	FieldLogLevelAll   FieldLogLevel = "ALL"
)

Enum values for FieldLogLevel

func (FieldLogLevel) Values 

func (FieldLogLevel) Values() []FieldLogLevel

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

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

type FunctionConfiguration 

type FunctionConfiguration struct {

	// The function code that contains the request and response functions. When code
	// is used, the runtime is required. The runtime value must be APPSYNC_JS .
	Code *string

	// The name of the DataSource .
	DataSourceName *string

	// The Function description.
	Description *string

	// The Amazon Resource Name (ARN) of the Function object.
	FunctionArn *string

	// A unique ID representing the Function object.
	FunctionId *string

	// The version of the request mapping template. Currently, only the 2018-05-29
	// version of the template is supported.
	FunctionVersion *string

	// The maximum batching size for a resolver.
	MaxBatchSize int32

	// The name of the Function object.
	Name *string

	// The Function request mapping template. Functions support only the 2018-05-29
	// version of the request mapping template.
	RequestMappingTemplate *string

	// The Function response mapping template.
	ResponseMappingTemplate *string

	// Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or
	// Amazon Web Services AppSync function. Specifies the name and version of the
	// runtime to use. Note that if a runtime is specified, code must also be
	// specified.
	Runtime *AppSyncRuntime

	// Describes a Sync configuration for a resolver.
	//
	// Specifies which Conflict Detection strategy and Resolution strategy to use when
	// the resolver is invoked.
	SyncConfig *SyncConfig
	// contains filtered or unexported fields
}

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

type GraphQLApiIntrospectionConfig 

type GraphQLApiIntrospectionConfig string
const (
	GraphQLApiIntrospectionConfigEnabled  GraphQLApiIntrospectionConfig = "ENABLED"
	GraphQLApiIntrospectionConfigDisabled GraphQLApiIntrospectionConfig = "DISABLED"
)

Enum values for GraphQLApiIntrospectionConfig

func (GraphQLApiIntrospectionConfig) Values 

func (GraphQLApiIntrospectionConfig) Values() []GraphQLApiIntrospectionConfig

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

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

type GraphQLApiType 

type GraphQLApiType string
const (
	GraphQLApiTypeGraphql GraphQLApiType = "GRAPHQL"
	GraphQLApiTypeMerged  GraphQLApiType = "MERGED"
)

Enum values for GraphQLApiType

func (GraphQLApiType) Values 

func (GraphQLApiType) Values() []GraphQLApiType

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

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

type GraphQLApiVisibility 

type GraphQLApiVisibility string
const (
	GraphQLApiVisibilityGlobal  GraphQLApiVisibility = "GLOBAL"
	GraphQLApiVisibilityPrivate GraphQLApiVisibility = "PRIVATE"
)

Enum values for GraphQLApiVisibility

func (GraphQLApiVisibility) Values 

func (GraphQLApiVisibility) Values() []GraphQLApiVisibility

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

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

type GraphQLSchemaException 

type GraphQLSchemaException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The GraphQL schema is not valid.

func (*GraphQLSchemaException) Error 

func (e *GraphQLSchemaException) Error() string

func (*GraphQLSchemaException) ErrorCode 

func (e *GraphQLSchemaException) ErrorCode() string

func (*GraphQLSchemaException) ErrorFault 

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

func (*GraphQLSchemaException) ErrorMessage 

func (e *GraphQLSchemaException) ErrorMessage() string

type GraphqlApi 

type GraphqlApi struct {

	// A list of additional authentication providers for the GraphqlApi API.
	AdditionalAuthenticationProviders []AdditionalAuthenticationProvider

	// The API ID.
	ApiId *string

	// The value that indicates whether the GraphQL API is a standard API ( GRAPHQL )
	// or merged API ( MERGED ).
	ApiType GraphQLApiType

	// The Amazon Resource Name (ARN).
	Arn *string

	// The authentication type.
	AuthenticationType AuthenticationType

	// The DNS records for the API.
	Dns map[string]string

	// The enhancedMetricsConfig object.
	EnhancedMetricsConfig *EnhancedMetricsConfig

	// Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED )
	// introspection. If no value is provided, the introspection configuration will be
	// set to ENABLED by default. This field will produce an error if the operation
	// attempts to use the introspection feature while this field is disabled.
	//
	// For more information about introspection, see [GraphQL introspection].
	//
	// [GraphQL introspection]: https://graphql.org/learn/introspection/
	IntrospectionConfig GraphQLApiIntrospectionConfig

	// Configuration for Lambda function authorization.
	LambdaAuthorizerConfig *LambdaAuthorizerConfig

	// The Amazon CloudWatch Logs configuration.
	LogConfig *LogConfig

	// The Identity and Access Management service role ARN for a merged API. The
	// AppSync service assumes this role on behalf of the Merged API to validate access
	// to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API
	// endpoint with the source API changes automatically.
	MergedApiExecutionRoleArn *string

	// The API name.
	Name *string

	// The OpenID Connect configuration.
	OpenIDConnectConfig *OpenIDConnectConfig

	// The account owner of the GraphQL API.
	Owner *string

	// The owner contact information for an API resource.
	//
	// This field accepts any string input with a length of 0 - 256 characters.
	OwnerContact *string

	// The maximum depth a query can have in a single request. Depth refers to the
	// amount of nested levels allowed in the body of query. The default value is 0
	// (or unspecified), which indicates there's no depth limit. If you set a limit, it
	// can be between 1 and 75 nested levels. This field will produce a limit error if
	// the operation falls out of bounds.
	//
	// Note that fields can still be set to nullable or non-nullable. If a
	// non-nullable field produces an error, the error will be thrown upwards to the
	// first nullable field available.
	QueryDepthLimit int32

	// The maximum number of resolvers that can be invoked in a single request. The
	// default value is 0 (or unspecified), which will set the limit to 10000 . When
	// specified, the limit value can be between 1 and 10000 . This field will produce
	// a limit error if the operation falls out of bounds.
	ResolverCountLimit int32

	// The tags.
	Tags map[string]string

	// The URIs.
	Uris map[string]string

	// The Amazon Cognito user pool configuration.
	UserPoolConfig *UserPoolConfig

	// Sets the value of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).
	// If no value is provided, the visibility will be set to GLOBAL by default. This
	// value cannot be changed once the API has been created.
	Visibility GraphQLApiVisibility

	// The ARN of the WAF access control list (ACL) associated with this GraphqlApi ,
	// if one exists.
	WafWebAclArn *string

	// A flag indicating whether to use X-Ray tracing for this GraphqlApi .
	XrayEnabled bool
	// contains filtered or unexported fields
}

Describes a GraphQL API.

type HttpDataSourceConfig 

type HttpDataSourceConfig struct {

	// The authorization configuration in case the HTTP endpoint requires
	// authorization.
	AuthorizationConfig *AuthorizationConfig

	// The HTTP URL endpoint. You can specify either the domain name or IP, and port
	// combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the
	// port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for
	// HTTPS endpoints.
	Endpoint *string
	// contains filtered or unexported fields
}

Describes an HTTP data source configuration.

type InternalFailureException 

type InternalFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An internal AppSync error occurred. Try your request again.

func (*InternalFailureException) Error 

func (e *InternalFailureException) Error() string

func (*InternalFailureException) ErrorCode 

func (e *InternalFailureException) ErrorCode() string

func (*InternalFailureException) ErrorFault 

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

func (*InternalFailureException) ErrorMessage 

func (e *InternalFailureException) ErrorMessage() string

type LambdaAuthorizerConfig 

type LambdaAuthorizerConfig struct {

	// The Amazon Resource Name (ARN) of the Lambda function to be called for
	// authorization. This can be a standard Lambda ARN, a version ARN ( .../v3 ), or
	// an alias ARN.
	//
	// Note: This Lambda function must have the following resource-based policy
	// assigned to it. When configuring Lambda authorizers in the console, this is done
	// for you. To use the Command Line Interface (CLI), run the following:
	//
	//     aws lambda add-permission --function-name
	//     "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id
	//     "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
	//
	// This member is required.
	AuthorizerUri *string

	// The number of seconds a response should be cached for. The default is 0
	// seconds, which disables caching. If you don't specify a value for
	// authorizerResultTtlInSeconds , the default value is used. The maximum value is
	// one hour (3600 seconds). The Lambda function can override this by returning a
	// ttlOverride key in its response.
	AuthorizerResultTtlInSeconds int32

	// A regular expression for validation of tokens before the Lambda function is
	// called.
	IdentityValidationExpression *string
	// contains filtered or unexported fields
}

A LambdaAuthorizerConfig specifies how to authorize AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a time.

type LambdaConflictHandlerConfig 

type LambdaConflictHandlerConfig struct {

	// The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict
	// Handler.
	LambdaConflictHandlerArn *string
	// contains filtered or unexported fields
}

The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict Handler.

type LambdaDataSourceConfig 

type LambdaDataSourceConfig struct {

	// The Amazon Resource Name (ARN) for the Lambda function.
	//
	// This member is required.
	LambdaFunctionArn *string
	// contains filtered or unexported fields
}

Describes an Lambda data source configuration.

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request exceeded a limit. Try your request again.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

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

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type LogConfig 

type LogConfig struct {

	// The service role that AppSync assumes to publish to CloudWatch logs in your
	// account.
	//
	// This member is required.
	CloudWatchLogsRoleArn *string

	// The field logging level. Values can be NONE, ERROR, or ALL.
	//
	//   - NONE: No field-level logs are captured.
	//
	//   - ERROR: Logs the following information only for the fields that are in error:
	//
	//   - The error section in the server response.
	//
	//   - Field-level errors.
	//
	//   - The generated request/response functions that got resolved for error fields.
	//
	//   - ALL: The following information is logged for all fields in the query:
	//
	//   - Field-level tracing information.
	//
	//   - The generated request/response functions that got resolved for each field.
	//
	// This member is required.
	FieldLogLevel FieldLogLevel

	// Set to TRUE to exclude sections that contain information such as headers,
	// context, and evaluated mapping templates, regardless of logging level.
	ExcludeVerboseContent bool
	// contains filtered or unexported fields
}

The Amazon CloudWatch Logs configuration.

type MergeType 

type MergeType string
const (
	MergeTypeManualMerge MergeType = "MANUAL_MERGE"
	MergeTypeAutoMerge   MergeType = "AUTO_MERGE"
)

Enum values for MergeType

func (MergeType) Values 

func (MergeType) Values() []MergeType

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

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

type NotFoundException 

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource specified in the request was not found. Check the resource, and then try again.

func (*NotFoundException) Error 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault 

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

func (*NotFoundException) ErrorMessage 

func (e *NotFoundException) ErrorMessage() string

type OpenIDConnectConfig 

type OpenIDConnectConfig struct {

	// The issuer for the OIDC configuration. The issuer returned by discovery must
	// exactly match the value of iss in the ID token.
	//
	// This member is required.
	Issuer *string

	// The number of milliseconds that a token is valid after being authenticated.
	AuthTTL int64

	// The client identifier of the relying party at the OpenID identity provider.
	// This identifier is typically obtained when the relying party is registered with
	// the OpenID identity provider. You can specify a regular expression so that
	// AppSync can validate against multiple client identifiers at a time.
	ClientId *string

	// The number of milliseconds that a token is valid after it's issued to a user.
	IatTTL int64
	// contains filtered or unexported fields
}

Describes an OpenID Connect (OIDC) configuration.

type OpenSearchServiceDataSourceConfig 

type OpenSearchServiceDataSourceConfig struct {

	// The Amazon Web Services Region.
	//
	// This member is required.
	AwsRegion *string

	// The endpoint.
	//
	// This member is required.
	Endpoint *string
	// contains filtered or unexported fields
}

Describes an OpenSearch data source configuration.

type OperationLevelMetricsConfig 

type OperationLevelMetricsConfig string
const (
	OperationLevelMetricsConfigEnabled  OperationLevelMetricsConfig = "ENABLED"
	OperationLevelMetricsConfigDisabled OperationLevelMetricsConfig = "DISABLED"
)

Enum values for OperationLevelMetricsConfig

func (OperationLevelMetricsConfig) Values 

func (OperationLevelMetricsConfig) Values() []OperationLevelMetricsConfig

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

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

type OutputType 

type OutputType string
const (
	OutputTypeSdl  OutputType = "SDL"
	OutputTypeJson OutputType = "JSON"
)

Enum values for OutputType

func (OutputType) Values 

func (OutputType) Values() []OutputType

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

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

type Ownership 

type Ownership string
const (
	OwnershipCurrentAccount Ownership = "CURRENT_ACCOUNT"
	OwnershipOtherAccounts  Ownership = "OTHER_ACCOUNTS"
)

Enum values for Ownership

func (Ownership) Values 

func (Ownership) Values() []Ownership

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

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

type PipelineConfig 

type PipelineConfig struct {

	// A list of Function objects.
	Functions []string
	// contains filtered or unexported fields
}

The pipeline configuration for a resolver of kind PIPELINE .

type RdsDataApiConfig 

type RdsDataApiConfig struct {

	// The name of the database in the cluster.
	//
	// This member is required.
	DatabaseName *string

	// The resource ARN of the RDS cluster.
	//
	// This member is required.
	ResourceArn *string

	// The secret's ARN that was obtained from Secrets Manager. A secret consists of
	// secret information, the secret value, plus metadata about the secret. A secret
	// value can be a string or binary. It typically includes the ARN, secret name and
	// description, policies, tags, encryption key from the Key Management Service, and
	// key rotation data.
	//
	// This member is required.
	SecretArn *string
	// contains filtered or unexported fields
}

Contains the metadata required to introspect the RDS cluster.

type RdsHttpEndpointConfig 

type RdsHttpEndpointConfig struct {

	// Amazon Web Services Region for Amazon RDS HTTP endpoint.
	AwsRegion *string

	// Amazon Web Services secret store Amazon Resource Name (ARN) for database
	// credentials.
	AwsSecretStoreArn *string

	// Logical database name.
	DatabaseName *string

	// Amazon RDS cluster Amazon Resource Name (ARN).
	DbClusterIdentifier *string

	// Logical schema name.
	Schema *string
	// contains filtered or unexported fields
}

The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.

type RelationalDatabaseDataSourceConfig 

type RelationalDatabaseDataSourceConfig struct {

	// Amazon RDS HTTP endpoint settings.
	RdsHttpEndpointConfig *RdsHttpEndpointConfig

	// Source type for the relational database.
	//
	//   - RDS_HTTP_ENDPOINT: The relational database source type is an Amazon
	//   Relational Database Service (Amazon RDS) HTTP endpoint.
	RelationalDatabaseSourceType RelationalDatabaseSourceType
	// contains filtered or unexported fields
}

Describes a relational database data source configuration.

type RelationalDatabaseSourceType 

type RelationalDatabaseSourceType string
const (
	RelationalDatabaseSourceTypeRdsHttpEndpoint RelationalDatabaseSourceType = "RDS_HTTP_ENDPOINT"
)

Enum values for RelationalDatabaseSourceType

func (RelationalDatabaseSourceType) Values 

func (RelationalDatabaseSourceType) Values() []RelationalDatabaseSourceType

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

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

type Resolver 

type Resolver struct {

	// The caching configuration for the resolver.
	CachingConfig *CachingConfig

	// The resolver code that contains the request and response functions. When code
	// is used, the runtime is required. The runtime value must be APPSYNC_JS .
	Code *string

	// The resolver data source name.
	DataSourceName *string

	// The resolver field name.
	FieldName *string

	// The resolver type.
	//
	//   - UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type.
	//   You can use a UNIT resolver to run a GraphQL query against a single data source.
	//
	//   - PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to
	//   invoke a series of Function objects in a serial manner. You can use a pipeline
	//   resolver to run a GraphQL query against multiple data sources.
	Kind ResolverKind

	// The maximum batching size for a resolver.
	MaxBatchSize int32

	// Enables or disables enhanced resolver metrics for specified resolvers. Note
	// that metricsConfig won't be used unless the resolverLevelMetricsBehavior value
	// is set to PER_RESOLVER_METRICS . If the resolverLevelMetricsBehavior is set to
	// FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However,
	// you can still set its value.
	//
	// metricsConfig can be ENABLED or DISABLED .
	MetricsConfig ResolverLevelMetricsConfig

	// The PipelineConfig .
	PipelineConfig *PipelineConfig

	// The request mapping template.
	RequestMappingTemplate *string

	// The resolver Amazon Resource Name (ARN).
	ResolverArn *string

	// The response mapping template.
	ResponseMappingTemplate *string

	// Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or
	// Amazon Web Services AppSync function. Specifies the name and version of the
	// runtime to use. Note that if a runtime is specified, code must also be
	// specified.
	Runtime *AppSyncRuntime

	// The SyncConfig for a resolver attached to a versioned data source.
	SyncConfig *SyncConfig

	// The resolver type name.
	TypeName *string
	// contains filtered or unexported fields
}

Describes a resolver.

type ResolverKind 

type ResolverKind string
const (
	ResolverKindUnit     ResolverKind = "UNIT"
	ResolverKindPipeline ResolverKind = "PIPELINE"
)

Enum values for ResolverKind

func (ResolverKind) Values 

func (ResolverKind) Values() []ResolverKind

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

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

type ResolverLevelMetricsBehavior 

type ResolverLevelMetricsBehavior string
const (
	ResolverLevelMetricsBehaviorFullRequestResolverMetrics ResolverLevelMetricsBehavior = "FULL_REQUEST_RESOLVER_METRICS"
	ResolverLevelMetricsBehaviorPerResolverMetrics         ResolverLevelMetricsBehavior = "PER_RESOLVER_METRICS"
)

Enum values for ResolverLevelMetricsBehavior

func (ResolverLevelMetricsBehavior) Values 

func (ResolverLevelMetricsBehavior) Values() []ResolverLevelMetricsBehavior

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

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

type ResolverLevelMetricsConfig 

type ResolverLevelMetricsConfig string
const (
	ResolverLevelMetricsConfigEnabled  ResolverLevelMetricsConfig = "ENABLED"
	ResolverLevelMetricsConfigDisabled ResolverLevelMetricsConfig = "DISABLED"
)

Enum values for ResolverLevelMetricsConfig

func (ResolverLevelMetricsConfig) Values 

func (ResolverLevelMetricsConfig) Values() []ResolverLevelMetricsConfig

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

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

type RuntimeName 

type RuntimeName string
const (
	RuntimeNameAppsyncJs RuntimeName = "APPSYNC_JS"
)

Enum values for RuntimeName

func (RuntimeName) Values 

func (RuntimeName) Values() []RuntimeName

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

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

type SchemaStatus 

type SchemaStatus string
const (
	SchemaStatusProcessing    SchemaStatus = "PROCESSING"
	SchemaStatusActive        SchemaStatus = "ACTIVE"
	SchemaStatusDeleting      SchemaStatus = "DELETING"
	SchemaStatusFailed        SchemaStatus = "FAILED"
	SchemaStatusSuccess       SchemaStatus = "SUCCESS"
	SchemaStatusNotApplicable SchemaStatus = "NOT_APPLICABLE"
)

Enum values for SchemaStatus

func (SchemaStatus) Values 

func (SchemaStatus) Values() []SchemaStatus

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

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

type SourceApiAssociation 

type SourceApiAssociation struct {

	// The Amazon Resource Name (ARN) of the source API association.
	AssociationArn *string

	// The ID generated by the AppSync service for the source API association.
	AssociationId *string

	// The description field.
	Description *string

	// The datetime value of the last successful merge of the source API association.
	// The result will be in UTC format and your local time zone.
	LastSuccessfulMergeDate *time.Time

	// The Amazon Resource Name (ARN) of the AppSync Merged API.
	MergedApiArn *string

	// The ID of the AppSync Merged API.
	MergedApiId *string

	// The Amazon Resource Name (ARN) of the AppSync source API.
	SourceApiArn *string

	// The SourceApiAssociationConfig object data.
	SourceApiAssociationConfig *SourceApiAssociationConfig

	// The state of the source API association.
	SourceApiAssociationStatus SourceApiAssociationStatus

	// The detailed message related to the current state of the source API association.
	SourceApiAssociationStatusDetail *string

	// The ID of the AppSync source API.
	SourceApiId *string
	// contains filtered or unexported fields
}

Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API. There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API.

Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access Manager. For more information about sharing resources from other accounts, see What is Amazon Web Services Resource Access Manager?in the Amazon Web Services Resource Access Manager guide.

type SourceApiAssociationConfig 

type SourceApiAssociationConfig struct {

	// The property that indicates which merging option is enabled in the source API
	// association.
	//
	// Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE . Manual merges are
	// the default behavior and require the user to trigger any changes from the source
	// APIs to the merged API manually. Auto merges subscribe the merged API to the
	// changes performed on the source APIs so that any change in the source APIs are
	// also made to the merged API. Auto merges use MergedApiExecutionRoleArn to
	// perform merge operations.
	MergeType MergeType
	// contains filtered or unexported fields
}

Describes properties used to specify configurations related to a source API.

type SourceApiAssociationStatus 

type SourceApiAssociationStatus string
const (
	SourceApiAssociationStatusMergeScheduled          SourceApiAssociationStatus = "MERGE_SCHEDULED"
	SourceApiAssociationStatusMergeFailed             SourceApiAssociationStatus = "MERGE_FAILED"
	SourceApiAssociationStatusMergeSuccess            SourceApiAssociationStatus = "MERGE_SUCCESS"
	SourceApiAssociationStatusMergeInProgress         SourceApiAssociationStatus = "MERGE_IN_PROGRESS"
	SourceApiAssociationStatusAutoMergeScheduleFailed SourceApiAssociationStatus = "AUTO_MERGE_SCHEDULE_FAILED"
	SourceApiAssociationStatusDeletionScheduled       SourceApiAssociationStatus = "DELETION_SCHEDULED"
	SourceApiAssociationStatusDeletionInProgress      SourceApiAssociationStatus = "DELETION_IN_PROGRESS"
	SourceApiAssociationStatusDeletionFailed          SourceApiAssociationStatus = "DELETION_FAILED"
)

Enum values for SourceApiAssociationStatus

func (SourceApiAssociationStatus) Values 

func (SourceApiAssociationStatus) Values() []SourceApiAssociationStatus

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

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

type SourceApiAssociationSummary 

type SourceApiAssociationSummary struct {

	// The Amazon Resource Name (ARN) of the source API association.
	AssociationArn *string

	// The ID generated by the AppSync service for the source API association.
	AssociationId *string

	// The description field.
	Description *string

	// The Amazon Resource Name (ARN) of the AppSync Merged API.
	MergedApiArn *string

	// The ID of the AppSync Merged API.
	MergedApiId *string

	// The Amazon Resource Name (ARN) of the AppSync Source API.
	SourceApiArn *string

	// The ID of the AppSync source API.
	SourceApiId *string
	// contains filtered or unexported fields
}

Describes the ARNs and IDs of associations, Merged APIs, and source APIs.

type SyncConfig 

type SyncConfig struct {

	// The Conflict Detection strategy to use.
	//
	//   - VERSION: Detect conflicts based on object versions for this resolver.
	//
	//   - NONE: Do not detect conflicts when invoking this resolver.
	ConflictDetection ConflictDetectionType

	// The Conflict Resolution strategy to perform in the event of a conflict.
	//
	//   - OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when
	//   versions don't match the latest version at the server.
	//
	//   - AUTOMERGE: Resolve conflicts with the Automerge conflict resolution
	//   strategy.
	//
	//   - LAMBDA: Resolve conflicts with an Lambda function supplied in the
	//   LambdaConflictHandlerConfig .
	ConflictHandler ConflictHandlerType

	// The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
	LambdaConflictHandlerConfig *LambdaConflictHandlerConfig
	// contains filtered or unexported fields
}

Describes a Sync configuration for a resolver.

Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

type Type 

type Type struct {

	// The type Amazon Resource Name (ARN).
	Arn *string

	// The type definition.
	Definition *string

	// The type description.
	Description *string

	// The type format: SDL or JSON.
	Format TypeDefinitionFormat

	// The type name.
	Name *string
	// contains filtered or unexported fields
}

Describes a type.

type TypeDefinitionFormat 

type TypeDefinitionFormat string
const (
	TypeDefinitionFormatSdl  TypeDefinitionFormat = "SDL"
	TypeDefinitionFormatJson TypeDefinitionFormat = "JSON"
)

Enum values for TypeDefinitionFormat

func (TypeDefinitionFormat) Values 

func (TypeDefinitionFormat) Values() []TypeDefinitionFormat

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

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

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You aren't authorized to perform this operation.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

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

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type UserPoolConfig 

type UserPoolConfig struct {

	// The Amazon Web Services Region in which the user pool was created.
	//
	// This member is required.
	AwsRegion *string

	// The action that you want your GraphQL API to take when a request that uses
	// Amazon Cognito user pool authentication doesn't match the Amazon Cognito user
	// pool configuration.
	//
	// This member is required.
	DefaultAction DefaultAction

	// The user pool ID.
	//
	// This member is required.
	UserPoolId *string

	// A regular expression for validating the incoming Amazon Cognito user pool app
	// client ID. If this value isn't set, no filtering is applied.
	AppIdClientRegex *string
	// contains filtered or unexported fields
}

Describes an Amazon Cognito user pool configuration.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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