Documentation
¶
Overview ¶
Package appsync provides the API client, operations, and parameter types for AWS AppSync.
AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AssociateApiInput
- type AssociateApiOutput
- type AssociateMergedGraphqlApiInput
- type AssociateMergedGraphqlApiOutput
- type AssociateSourceGraphqlApiInput
- type AssociateSourceGraphqlApiOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) AssociateApi(ctx context.Context, params *AssociateApiInput, optFns ...func(*Options)) (*AssociateApiOutput, error)
- func (c *Client) AssociateMergedGraphqlApi(ctx context.Context, params *AssociateMergedGraphqlApiInput, ...) (*AssociateMergedGraphqlApiOutput, error)
- func (c *Client) AssociateSourceGraphqlApi(ctx context.Context, params *AssociateSourceGraphqlApiInput, ...) (*AssociateSourceGraphqlApiOutput, error)
- func (c *Client) CreateApi(ctx context.Context, params *CreateApiInput, optFns ...func(*Options)) (*CreateApiOutput, error)
- func (c *Client) CreateApiCache(ctx context.Context, params *CreateApiCacheInput, optFns ...func(*Options)) (*CreateApiCacheOutput, error)
- func (c *Client) CreateApiKey(ctx context.Context, params *CreateApiKeyInput, optFns ...func(*Options)) (*CreateApiKeyOutput, error)
- func (c *Client) CreateChannelNamespace(ctx context.Context, params *CreateChannelNamespaceInput, ...) (*CreateChannelNamespaceOutput, error)
- func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error)
- func (c *Client) CreateDomainName(ctx context.Context, params *CreateDomainNameInput, optFns ...func(*Options)) (*CreateDomainNameOutput, error)
- func (c *Client) CreateFunction(ctx context.Context, params *CreateFunctionInput, optFns ...func(*Options)) (*CreateFunctionOutput, error)
- func (c *Client) CreateGraphqlApi(ctx context.Context, params *CreateGraphqlApiInput, optFns ...func(*Options)) (*CreateGraphqlApiOutput, error)
- func (c *Client) CreateResolver(ctx context.Context, params *CreateResolverInput, optFns ...func(*Options)) (*CreateResolverOutput, error)
- func (c *Client) CreateType(ctx context.Context, params *CreateTypeInput, optFns ...func(*Options)) (*CreateTypeOutput, error)
- func (c *Client) DeleteApi(ctx context.Context, params *DeleteApiInput, optFns ...func(*Options)) (*DeleteApiOutput, error)
- func (c *Client) DeleteApiCache(ctx context.Context, params *DeleteApiCacheInput, optFns ...func(*Options)) (*DeleteApiCacheOutput, error)
- func (c *Client) DeleteApiKey(ctx context.Context, params *DeleteApiKeyInput, optFns ...func(*Options)) (*DeleteApiKeyOutput, error)
- func (c *Client) DeleteChannelNamespace(ctx context.Context, params *DeleteChannelNamespaceInput, ...) (*DeleteChannelNamespaceOutput, error)
- func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)
- func (c *Client) DeleteDomainName(ctx context.Context, params *DeleteDomainNameInput, optFns ...func(*Options)) (*DeleteDomainNameOutput, error)
- func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput, optFns ...func(*Options)) (*DeleteFunctionOutput, error)
- func (c *Client) DeleteGraphqlApi(ctx context.Context, params *DeleteGraphqlApiInput, optFns ...func(*Options)) (*DeleteGraphqlApiOutput, error)
- func (c *Client) DeleteResolver(ctx context.Context, params *DeleteResolverInput, optFns ...func(*Options)) (*DeleteResolverOutput, error)
- func (c *Client) DeleteType(ctx context.Context, params *DeleteTypeInput, optFns ...func(*Options)) (*DeleteTypeOutput, error)
- func (c *Client) DisassociateApi(ctx context.Context, params *DisassociateApiInput, optFns ...func(*Options)) (*DisassociateApiOutput, error)
- func (c *Client) DisassociateMergedGraphqlApi(ctx context.Context, params *DisassociateMergedGraphqlApiInput, ...) (*DisassociateMergedGraphqlApiOutput, error)
- func (c *Client) DisassociateSourceGraphqlApi(ctx context.Context, params *DisassociateSourceGraphqlApiInput, ...) (*DisassociateSourceGraphqlApiOutput, error)
- func (c *Client) EvaluateCode(ctx context.Context, params *EvaluateCodeInput, optFns ...func(*Options)) (*EvaluateCodeOutput, error)
- func (c *Client) EvaluateMappingTemplate(ctx context.Context, params *EvaluateMappingTemplateInput, ...) (*EvaluateMappingTemplateOutput, error)
- func (c *Client) FlushApiCache(ctx context.Context, params *FlushApiCacheInput, optFns ...func(*Options)) (*FlushApiCacheOutput, error)
- func (c *Client) GetApi(ctx context.Context, params *GetApiInput, optFns ...func(*Options)) (*GetApiOutput, error)
- func (c *Client) GetApiAssociation(ctx context.Context, params *GetApiAssociationInput, optFns ...func(*Options)) (*GetApiAssociationOutput, error)
- func (c *Client) GetApiCache(ctx context.Context, params *GetApiCacheInput, optFns ...func(*Options)) (*GetApiCacheOutput, error)
- func (c *Client) GetChannelNamespace(ctx context.Context, params *GetChannelNamespaceInput, ...) (*GetChannelNamespaceOutput, error)
- func (c *Client) GetDataSource(ctx context.Context, params *GetDataSourceInput, optFns ...func(*Options)) (*GetDataSourceOutput, error)
- func (c *Client) GetDataSourceIntrospection(ctx context.Context, params *GetDataSourceIntrospectionInput, ...) (*GetDataSourceIntrospectionOutput, error)
- func (c *Client) GetDomainName(ctx context.Context, params *GetDomainNameInput, optFns ...func(*Options)) (*GetDomainNameOutput, error)
- func (c *Client) GetFunction(ctx context.Context, params *GetFunctionInput, optFns ...func(*Options)) (*GetFunctionOutput, error)
- func (c *Client) GetGraphqlApi(ctx context.Context, params *GetGraphqlApiInput, optFns ...func(*Options)) (*GetGraphqlApiOutput, error)
- func (c *Client) GetGraphqlApiEnvironmentVariables(ctx context.Context, params *GetGraphqlApiEnvironmentVariablesInput, ...) (*GetGraphqlApiEnvironmentVariablesOutput, error)
- func (c *Client) GetIntrospectionSchema(ctx context.Context, params *GetIntrospectionSchemaInput, ...) (*GetIntrospectionSchemaOutput, error)
- func (c *Client) GetResolver(ctx context.Context, params *GetResolverInput, optFns ...func(*Options)) (*GetResolverOutput, error)
- func (c *Client) GetSchemaCreationStatus(ctx context.Context, params *GetSchemaCreationStatusInput, ...) (*GetSchemaCreationStatusOutput, error)
- func (c *Client) GetSourceApiAssociation(ctx context.Context, params *GetSourceApiAssociationInput, ...) (*GetSourceApiAssociationOutput, error)
- func (c *Client) GetType(ctx context.Context, params *GetTypeInput, optFns ...func(*Options)) (*GetTypeOutput, error)
- func (c *Client) ListApiKeys(ctx context.Context, params *ListApiKeysInput, optFns ...func(*Options)) (*ListApiKeysOutput, error)
- func (c *Client) ListApis(ctx context.Context, params *ListApisInput, optFns ...func(*Options)) (*ListApisOutput, error)
- func (c *Client) ListChannelNamespaces(ctx context.Context, params *ListChannelNamespacesInput, ...) (*ListChannelNamespacesOutput, error)
- func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error)
- func (c *Client) ListDomainNames(ctx context.Context, params *ListDomainNamesInput, optFns ...func(*Options)) (*ListDomainNamesOutput, error)
- func (c *Client) ListFunctions(ctx context.Context, params *ListFunctionsInput, optFns ...func(*Options)) (*ListFunctionsOutput, error)
- func (c *Client) ListGraphqlApis(ctx context.Context, params *ListGraphqlApisInput, optFns ...func(*Options)) (*ListGraphqlApisOutput, error)
- func (c *Client) ListResolvers(ctx context.Context, params *ListResolversInput, optFns ...func(*Options)) (*ListResolversOutput, error)
- func (c *Client) ListResolversByFunction(ctx context.Context, params *ListResolversByFunctionInput, ...) (*ListResolversByFunctionOutput, error)
- func (c *Client) ListSourceApiAssociations(ctx context.Context, params *ListSourceApiAssociationsInput, ...) (*ListSourceApiAssociationsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTypes(ctx context.Context, params *ListTypesInput, optFns ...func(*Options)) (*ListTypesOutput, error)
- func (c *Client) ListTypesByAssociation(ctx context.Context, params *ListTypesByAssociationInput, ...) (*ListTypesByAssociationOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PutGraphqlApiEnvironmentVariables(ctx context.Context, params *PutGraphqlApiEnvironmentVariablesInput, ...) (*PutGraphqlApiEnvironmentVariablesOutput, error)
- func (c *Client) StartDataSourceIntrospection(ctx context.Context, params *StartDataSourceIntrospectionInput, ...) (*StartDataSourceIntrospectionOutput, error)
- func (c *Client) StartSchemaCreation(ctx context.Context, params *StartSchemaCreationInput, ...) (*StartSchemaCreationOutput, error)
- func (c *Client) StartSchemaMerge(ctx context.Context, params *StartSchemaMergeInput, optFns ...func(*Options)) (*StartSchemaMergeOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateApi(ctx context.Context, params *UpdateApiInput, optFns ...func(*Options)) (*UpdateApiOutput, error)
- func (c *Client) UpdateApiCache(ctx context.Context, params *UpdateApiCacheInput, optFns ...func(*Options)) (*UpdateApiCacheOutput, error)
- func (c *Client) UpdateApiKey(ctx context.Context, params *UpdateApiKeyInput, optFns ...func(*Options)) (*UpdateApiKeyOutput, error)
- func (c *Client) UpdateChannelNamespace(ctx context.Context, params *UpdateChannelNamespaceInput, ...) (*UpdateChannelNamespaceOutput, error)
- func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error)
- func (c *Client) UpdateDomainName(ctx context.Context, params *UpdateDomainNameInput, optFns ...func(*Options)) (*UpdateDomainNameOutput, error)
- func (c *Client) UpdateFunction(ctx context.Context, params *UpdateFunctionInput, optFns ...func(*Options)) (*UpdateFunctionOutput, error)
- func (c *Client) UpdateGraphqlApi(ctx context.Context, params *UpdateGraphqlApiInput, optFns ...func(*Options)) (*UpdateGraphqlApiOutput, error)
- func (c *Client) UpdateResolver(ctx context.Context, params *UpdateResolverInput, optFns ...func(*Options)) (*UpdateResolverOutput, error)
- func (c *Client) UpdateSourceApiAssociation(ctx context.Context, params *UpdateSourceApiAssociationInput, ...) (*UpdateSourceApiAssociationOutput, error)
- func (c *Client) UpdateType(ctx context.Context, params *UpdateTypeInput, optFns ...func(*Options)) (*UpdateTypeOutput, error)
- type CreateApiCacheInput
- type CreateApiCacheOutput
- type CreateApiInput
- type CreateApiKeyInput
- type CreateApiKeyOutput
- type CreateApiOutput
- type CreateChannelNamespaceInput
- type CreateChannelNamespaceOutput
- type CreateDataSourceInput
- type CreateDataSourceOutput
- type CreateDomainNameInput
- type CreateDomainNameOutput
- type CreateFunctionInput
- type CreateFunctionOutput
- type CreateGraphqlApiInput
- type CreateGraphqlApiOutput
- type CreateResolverInput
- type CreateResolverOutput
- type CreateTypeInput
- type CreateTypeOutput
- type DeleteApiCacheInput
- type DeleteApiCacheOutput
- type DeleteApiInput
- type DeleteApiKeyInput
- type DeleteApiKeyOutput
- type DeleteApiOutput
- type DeleteChannelNamespaceInput
- type DeleteChannelNamespaceOutput
- type DeleteDataSourceInput
- type DeleteDataSourceOutput
- type DeleteDomainNameInput
- type DeleteDomainNameOutput
- type DeleteFunctionInput
- type DeleteFunctionOutput
- type DeleteGraphqlApiInput
- type DeleteGraphqlApiOutput
- type DeleteResolverInput
- type DeleteResolverOutput
- type DeleteTypeInput
- type DeleteTypeOutput
- type DisassociateApiInput
- type DisassociateApiOutput
- type DisassociateMergedGraphqlApiInput
- type DisassociateMergedGraphqlApiOutput
- type DisassociateSourceGraphqlApiInput
- type DisassociateSourceGraphqlApiOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type EvaluateCodeInput
- type EvaluateCodeOutput
- type EvaluateMappingTemplateInput
- type EvaluateMappingTemplateOutput
- type FlushApiCacheInput
- type FlushApiCacheOutput
- type GetApiAssociationInput
- type GetApiAssociationOutput
- type GetApiCacheInput
- type GetApiCacheOutput
- type GetApiInput
- type GetApiOutput
- type GetChannelNamespaceInput
- type GetChannelNamespaceOutput
- type GetDataSourceInput
- type GetDataSourceIntrospectionInput
- type GetDataSourceIntrospectionOutput
- type GetDataSourceOutput
- type GetDomainNameInput
- type GetDomainNameOutput
- type GetFunctionInput
- type GetFunctionOutput
- type GetGraphqlApiEnvironmentVariablesInput
- type GetGraphqlApiEnvironmentVariablesOutput
- type GetGraphqlApiInput
- type GetGraphqlApiOutput
- type GetIntrospectionSchemaInput
- type GetIntrospectionSchemaOutput
- type GetResolverInput
- type GetResolverOutput
- type GetSchemaCreationStatusInput
- type GetSchemaCreationStatusOutput
- type GetSourceApiAssociationInput
- type GetSourceApiAssociationOutput
- type GetTypeInput
- type GetTypeOutput
- type HTTPClient
- type HTTPSignerV4
- type ListApiKeysAPIClient
- type ListApiKeysInput
- type ListApiKeysOutput
- type ListApiKeysPaginator
- type ListApiKeysPaginatorOptions
- type ListApisAPIClient
- type ListApisInput
- type ListApisOutput
- type ListApisPaginator
- type ListApisPaginatorOptions
- type ListChannelNamespacesAPIClient
- type ListChannelNamespacesInput
- type ListChannelNamespacesOutput
- type ListChannelNamespacesPaginator
- type ListChannelNamespacesPaginatorOptions
- type ListDataSourcesAPIClient
- type ListDataSourcesInput
- type ListDataSourcesOutput
- type ListDataSourcesPaginator
- type ListDataSourcesPaginatorOptions
- type ListDomainNamesAPIClient
- type ListDomainNamesInput
- type ListDomainNamesOutput
- type ListDomainNamesPaginator
- type ListDomainNamesPaginatorOptions
- type ListFunctionsAPIClient
- type ListFunctionsInput
- type ListFunctionsOutput
- type ListFunctionsPaginator
- type ListFunctionsPaginatorOptions
- type ListGraphqlApisAPIClient
- type ListGraphqlApisInput
- type ListGraphqlApisOutput
- type ListGraphqlApisPaginator
- type ListGraphqlApisPaginatorOptions
- type ListResolversAPIClient
- type ListResolversByFunctionAPIClient
- type ListResolversByFunctionInput
- type ListResolversByFunctionOutput
- type ListResolversByFunctionPaginator
- type ListResolversByFunctionPaginatorOptions
- type ListResolversInput
- type ListResolversOutput
- type ListResolversPaginator
- type ListResolversPaginatorOptions
- type ListSourceApiAssociationsAPIClient
- type ListSourceApiAssociationsInput
- type ListSourceApiAssociationsOutput
- type ListSourceApiAssociationsPaginator
- type ListSourceApiAssociationsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTypesAPIClient
- type ListTypesByAssociationAPIClient
- type ListTypesByAssociationInput
- type ListTypesByAssociationOutput
- type ListTypesByAssociationPaginator
- type ListTypesByAssociationPaginatorOptions
- type ListTypesInput
- type ListTypesOutput
- type ListTypesPaginator
- type ListTypesPaginatorOptions
- type Options
- type PutGraphqlApiEnvironmentVariablesInput
- type PutGraphqlApiEnvironmentVariablesOutput
- type ResolveEndpoint
- type StartDataSourceIntrospectionInput
- type StartDataSourceIntrospectionOutput
- type StartSchemaCreationInput
- type StartSchemaCreationOutput
- type StartSchemaMergeInput
- type StartSchemaMergeOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateApiCacheInput
- type UpdateApiCacheOutput
- type UpdateApiInput
- type UpdateApiKeyInput
- type UpdateApiKeyOutput
- type UpdateApiOutput
- type UpdateChannelNamespaceInput
- type UpdateChannelNamespaceOutput
- type UpdateDataSourceInput
- type UpdateDataSourceOutput
- type UpdateDomainNameInput
- type UpdateDomainNameOutput
- type UpdateFunctionInput
- type UpdateFunctionOutput
- type UpdateGraphqlApiInput
- type UpdateGraphqlApiOutput
- type UpdateResolverInput
- type UpdateResolverOutput
- type UpdateSourceApiAssociationInput
- type UpdateSourceApiAssociationOutput
- type UpdateTypeInput
- type UpdateTypeOutput
Constants ¶
const ServiceAPIVersion = "2017-07-25"
const ServiceID = "AppSync"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
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.22.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.24.2
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.24.2
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 AssociateApiInput ¶ added in v1.10.0
type AssociateApiOutput ¶ added in v1.10.0
type AssociateApiOutput struct { // The ApiAssociation object. ApiAssociation *types.ApiAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateMergedGraphqlApiInput ¶ added in v1.21.0
type AssociateMergedGraphqlApiInput struct { // The identifier of the AppSync Merged API. This is generated by the AppSync // service. In most cases, Merged APIs (especially in your account) only require // the API ID value or ARN of the merged API. However, Merged APIs in other // accounts (cross-account use cases) strictly require the full resource ARN of the // merged API. // // This member is required. MergedApiIdentifier *string // The identifier of the AppSync Source API. This is generated by the AppSync // service. In most cases, source APIs (especially in your account) only require // the API ID value or ARN of the source API. However, source APIs from other // accounts (cross-account use cases) strictly require the full resource ARN of the // source API. // // This member is required. SourceApiIdentifier *string // The description field. Description *string // The SourceApiAssociationConfig object data. SourceApiAssociationConfig *types.SourceApiAssociationConfig // contains filtered or unexported fields }
type AssociateMergedGraphqlApiOutput ¶ added in v1.21.0
type AssociateMergedGraphqlApiOutput struct { // The SourceApiAssociation object data. SourceApiAssociation *types.SourceApiAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateSourceGraphqlApiInput ¶ added in v1.21.0
type AssociateSourceGraphqlApiInput struct { // The identifier of the AppSync Merged API. This is generated by the AppSync // service. In most cases, Merged APIs (especially in your account) only require // the API ID value or ARN of the merged API. However, Merged APIs in other // accounts (cross-account use cases) strictly require the full resource ARN of the // merged API. // // This member is required. MergedApiIdentifier *string // The identifier of the AppSync Source API. This is generated by the AppSync // service. In most cases, source APIs (especially in your account) only require // the API ID value or ARN of the source API. However, source APIs from other // accounts (cross-account use cases) strictly require the full resource ARN of the // source API. // // This member is required. SourceApiIdentifier *string // The description field. Description *string // The SourceApiAssociationConfig object data. SourceApiAssociationConfig *types.SourceApiAssociationConfig // contains filtered or unexported fields }
type AssociateSourceGraphqlApiOutput ¶ added in v1.21.0
type AssociateSourceGraphqlApiOutput struct { // The SourceApiAssociation object data. SourceApiAssociation *types.SourceApiAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶ added in v1.24.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.24.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 AWS AppSync.
func New ¶
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 ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateApi ¶ added in v1.10.0
func (c *Client) AssociateApi(ctx context.Context, params *AssociateApiInput, optFns ...func(*Options)) (*AssociateApiOutput, error)
Maps an endpoint to your custom domain.
func (*Client) AssociateMergedGraphqlApi ¶ added in v1.21.0
func (c *Client) AssociateMergedGraphqlApi(ctx context.Context, params *AssociateMergedGraphqlApiInput, optFns ...func(*Options)) (*AssociateMergedGraphqlApiOutput, error)
Creates an association between a Merged API and source API using the source API's identifier.
func (*Client) AssociateSourceGraphqlApi ¶ added in v1.21.0
func (c *Client) AssociateSourceGraphqlApi(ctx context.Context, params *AssociateSourceGraphqlApiInput, optFns ...func(*Options)) (*AssociateSourceGraphqlApiOutput, error)
Creates an association between a Merged API and source API using the Merged API's identifier.
func (*Client) CreateApi ¶ added in v1.39.0
func (c *Client) CreateApi(ctx context.Context, params *CreateApiInput, optFns ...func(*Options)) (*CreateApiOutput, error)
Creates an Api object. Use this operation to create an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
func (*Client) CreateApiCache ¶
func (c *Client) CreateApiCache(ctx context.Context, params *CreateApiCacheInput, optFns ...func(*Options)) (*CreateApiCacheOutput, error)
Creates a cache for the GraphQL API.
func (*Client) CreateApiKey ¶
func (c *Client) CreateApiKey(ctx context.Context, params *CreateApiKeyInput, optFns ...func(*Options)) (*CreateApiKeyOutput, error)
Creates a unique key that you can distribute to clients who invoke your API.
func (*Client) CreateChannelNamespace ¶ added in v1.39.0
func (c *Client) CreateChannelNamespace(ctx context.Context, params *CreateChannelNamespaceInput, optFns ...func(*Options)) (*CreateChannelNamespaceOutput, error)
Creates a ChannelNamespace for an Api .
func (*Client) CreateDataSource ¶
func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error)
Creates a DataSource object.
func (*Client) CreateDomainName ¶ added in v1.10.0
func (c *Client) CreateDomainName(ctx context.Context, params *CreateDomainNameInput, optFns ...func(*Options)) (*CreateDomainNameOutput, error)
Creates a custom DomainName object.
func (*Client) CreateFunction ¶
func (c *Client) CreateFunction(ctx context.Context, params *CreateFunctionInput, optFns ...func(*Options)) (*CreateFunctionOutput, error)
Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
func (*Client) CreateGraphqlApi ¶
func (c *Client) CreateGraphqlApi(ctx context.Context, params *CreateGraphqlApiInput, optFns ...func(*Options)) (*CreateGraphqlApiOutput, error)
Creates a GraphqlApi object.
func (*Client) CreateResolver ¶
func (c *Client) CreateResolver(ctx context.Context, params *CreateResolverInput, optFns ...func(*Options)) (*CreateResolverOutput, error)
Creates a Resolver object.
A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.
func (*Client) CreateType ¶
func (c *Client) CreateType(ctx context.Context, params *CreateTypeInput, optFns ...func(*Options)) (*CreateTypeOutput, error)
Creates a Type object.
func (*Client) DeleteApi ¶ added in v1.39.0
func (c *Client) DeleteApi(ctx context.Context, params *DeleteApiInput, optFns ...func(*Options)) (*DeleteApiOutput, error)
Deletes an Api object
func (*Client) DeleteApiCache ¶
func (c *Client) DeleteApiCache(ctx context.Context, params *DeleteApiCacheInput, optFns ...func(*Options)) (*DeleteApiCacheOutput, error)
Deletes an ApiCache object.
func (*Client) DeleteApiKey ¶
func (c *Client) DeleteApiKey(ctx context.Context, params *DeleteApiKeyInput, optFns ...func(*Options)) (*DeleteApiKeyOutput, error)
Deletes an API key.
func (*Client) DeleteChannelNamespace ¶ added in v1.39.0
func (c *Client) DeleteChannelNamespace(ctx context.Context, params *DeleteChannelNamespaceInput, optFns ...func(*Options)) (*DeleteChannelNamespaceOutput, error)
Deletes a ChannelNamespace .
func (*Client) DeleteDataSource ¶
func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)
Deletes a DataSource object.
func (*Client) DeleteDomainName ¶ added in v1.10.0
func (c *Client) DeleteDomainName(ctx context.Context, params *DeleteDomainNameInput, optFns ...func(*Options)) (*DeleteDomainNameOutput, error)
Deletes a custom DomainName object.
func (*Client) DeleteFunction ¶
func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput, optFns ...func(*Options)) (*DeleteFunctionOutput, error)
Deletes a Function .
func (*Client) DeleteGraphqlApi ¶
func (c *Client) DeleteGraphqlApi(ctx context.Context, params *DeleteGraphqlApiInput, optFns ...func(*Options)) (*DeleteGraphqlApiOutput, error)
Deletes a GraphqlApi object.
func (*Client) DeleteResolver ¶
func (c *Client) DeleteResolver(ctx context.Context, params *DeleteResolverInput, optFns ...func(*Options)) (*DeleteResolverOutput, error)
Deletes a Resolver object.
func (*Client) DeleteType ¶
func (c *Client) DeleteType(ctx context.Context, params *DeleteTypeInput, optFns ...func(*Options)) (*DeleteTypeOutput, error)
Deletes a Type object.
func (*Client) DisassociateApi ¶ added in v1.10.0
func (c *Client) DisassociateApi(ctx context.Context, params *DisassociateApiInput, optFns ...func(*Options)) (*DisassociateApiOutput, error)
Removes an ApiAssociation object from a custom domain.
func (*Client) DisassociateMergedGraphqlApi ¶ added in v1.21.0
func (c *Client) DisassociateMergedGraphqlApi(ctx context.Context, params *DisassociateMergedGraphqlApiInput, optFns ...func(*Options)) (*DisassociateMergedGraphqlApiOutput, error)
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
func (*Client) DisassociateSourceGraphqlApi ¶ added in v1.21.0
func (c *Client) DisassociateSourceGraphqlApi(ctx context.Context, params *DisassociateSourceGraphqlApiInput, optFns ...func(*Options)) (*DisassociateSourceGraphqlApiOutput, error)
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
func (*Client) EvaluateCode ¶ added in v1.16.0
func (c *Client) EvaluateCode(ctx context.Context, params *EvaluateCodeInput, optFns ...func(*Options)) (*EvaluateCodeOutput, error)
Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.
func (*Client) EvaluateMappingTemplate ¶ added in v1.15.0
func (c *Client) EvaluateMappingTemplate(ctx context.Context, params *EvaluateMappingTemplateInput, optFns ...func(*Options)) (*EvaluateMappingTemplateOutput, error)
Evaluates a given template and returns the response. The mapping template can be a request or response template.
Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.
Mapping templates are written in the Apache Velocity Template Language (VTL).
func (*Client) FlushApiCache ¶
func (c *Client) FlushApiCache(ctx context.Context, params *FlushApiCacheInput, optFns ...func(*Options)) (*FlushApiCacheOutput, error)
Flushes an ApiCache object.
func (*Client) GetApi ¶ added in v1.39.0
func (c *Client) GetApi(ctx context.Context, params *GetApiInput, optFns ...func(*Options)) (*GetApiOutput, error)
Retrieves an Api object.
func (*Client) GetApiAssociation ¶ added in v1.10.0
func (c *Client) GetApiAssociation(ctx context.Context, params *GetApiAssociationInput, optFns ...func(*Options)) (*GetApiAssociationOutput, error)
Retrieves an ApiAssociation object.
func (*Client) GetApiCache ¶
func (c *Client) GetApiCache(ctx context.Context, params *GetApiCacheInput, optFns ...func(*Options)) (*GetApiCacheOutput, error)
Retrieves an ApiCache object.
func (*Client) GetChannelNamespace ¶ added in v1.39.0
func (c *Client) GetChannelNamespace(ctx context.Context, params *GetChannelNamespaceInput, optFns ...func(*Options)) (*GetChannelNamespaceOutput, error)
Retrieves the channel namespace for a specified Api .
func (*Client) GetDataSource ¶
func (c *Client) GetDataSource(ctx context.Context, params *GetDataSourceInput, optFns ...func(*Options)) (*GetDataSourceOutput, error)
Retrieves a DataSource object.
func (*Client) GetDataSourceIntrospection ¶ added in v1.25.0
func (c *Client) GetDataSourceIntrospection(ctx context.Context, params *GetDataSourceIntrospectionInput, optFns ...func(*Options)) (*GetDataSourceIntrospectionOutput, error)
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.
func (*Client) GetDomainName ¶ added in v1.10.0
func (c *Client) GetDomainName(ctx context.Context, params *GetDomainNameInput, optFns ...func(*Options)) (*GetDomainNameOutput, error)
Retrieves a custom DomainName object.
func (*Client) GetFunction ¶
func (c *Client) GetFunction(ctx context.Context, params *GetFunctionInput, optFns ...func(*Options)) (*GetFunctionOutput, error)
Get a Function .
func (*Client) GetGraphqlApi ¶
func (c *Client) GetGraphqlApi(ctx context.Context, params *GetGraphqlApiInput, optFns ...func(*Options)) (*GetGraphqlApiOutput, error)
Retrieves a GraphqlApi object.
func (*Client) GetGraphqlApiEnvironmentVariables ¶ added in v1.28.0
func (c *Client) GetGraphqlApiEnvironmentVariables(ctx context.Context, params *GetGraphqlApiEnvironmentVariablesInput, optFns ...func(*Options)) (*GetGraphqlApiEnvironmentVariablesOutput, error)
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
func (*Client) GetIntrospectionSchema ¶
func (c *Client) GetIntrospectionSchema(ctx context.Context, params *GetIntrospectionSchemaInput, optFns ...func(*Options)) (*GetIntrospectionSchemaOutput, error)
Retrieves the introspection schema for a GraphQL API.
func (*Client) GetResolver ¶
func (c *Client) GetResolver(ctx context.Context, params *GetResolverInput, optFns ...func(*Options)) (*GetResolverOutput, error)
Retrieves a Resolver object.
func (*Client) GetSchemaCreationStatus ¶
func (c *Client) GetSchemaCreationStatus(ctx context.Context, params *GetSchemaCreationStatusInput, optFns ...func(*Options)) (*GetSchemaCreationStatusOutput, error)
Retrieves the current status of a schema creation operation.
func (*Client) GetSourceApiAssociation ¶ added in v1.21.0
func (c *Client) GetSourceApiAssociation(ctx context.Context, params *GetSourceApiAssociationInput, optFns ...func(*Options)) (*GetSourceApiAssociationOutput, error)
Retrieves a SourceApiAssociation object.
func (*Client) GetType ¶
func (c *Client) GetType(ctx context.Context, params *GetTypeInput, optFns ...func(*Options)) (*GetTypeOutput, error)
Retrieves a Type object.
func (*Client) ListApiKeys ¶
func (c *Client) ListApiKeys(ctx context.Context, params *ListApiKeysInput, optFns ...func(*Options)) (*ListApiKeysOutput, error)
Lists the API keys for a given API.
API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.
func (*Client) ListApis ¶ added in v1.39.0
func (c *Client) ListApis(ctx context.Context, params *ListApisInput, optFns ...func(*Options)) (*ListApisOutput, error)
Lists the APIs in your AppSync account.
ListApis returns only the high level API details. For more detailed information about an API, use GetApi .
func (*Client) ListChannelNamespaces ¶ added in v1.39.0
func (c *Client) ListChannelNamespaces(ctx context.Context, params *ListChannelNamespacesInput, optFns ...func(*Options)) (*ListChannelNamespacesOutput, error)
Lists the channel namespaces for a specified Api .
ListChannelNamespaces returns only high level details for the channel namespace. To retrieve code handlers, use GetChannelNamespace .
func (*Client) ListDataSources ¶
func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error)
Lists the data sources for a given API.
func (*Client) ListDomainNames ¶ added in v1.10.0
func (c *Client) ListDomainNames(ctx context.Context, params *ListDomainNamesInput, optFns ...func(*Options)) (*ListDomainNamesOutput, error)
Lists multiple custom domain names.
func (*Client) ListFunctions ¶
func (c *Client) ListFunctions(ctx context.Context, params *ListFunctionsInput, optFns ...func(*Options)) (*ListFunctionsOutput, error)
List multiple functions.
func (*Client) ListGraphqlApis ¶
func (c *Client) ListGraphqlApis(ctx context.Context, params *ListGraphqlApisInput, optFns ...func(*Options)) (*ListGraphqlApisOutput, error)
Lists your GraphQL APIs.
func (*Client) ListResolvers ¶
func (c *Client) ListResolvers(ctx context.Context, params *ListResolversInput, optFns ...func(*Options)) (*ListResolversOutput, error)
Lists the resolvers for a given API and type.
func (*Client) ListResolversByFunction ¶
func (c *Client) ListResolversByFunction(ctx context.Context, params *ListResolversByFunctionInput, optFns ...func(*Options)) (*ListResolversByFunctionOutput, error)
List the resolvers that are associated with a specific function.
func (*Client) ListSourceApiAssociations ¶ added in v1.21.0
func (c *Client) ListSourceApiAssociations(ctx context.Context, params *ListSourceApiAssociationsInput, optFns ...func(*Options)) (*ListSourceApiAssociationsOutput, error)
Lists the SourceApiAssociationSummary data.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for a resource.
func (*Client) ListTypes ¶
func (c *Client) ListTypes(ctx context.Context, params *ListTypesInput, optFns ...func(*Options)) (*ListTypesOutput, error)
Lists the types for a given API.
func (*Client) ListTypesByAssociation ¶ added in v1.21.0
func (c *Client) ListTypesByAssociation(ctx context.Context, params *ListTypesByAssociationInput, optFns ...func(*Options)) (*ListTypesByAssociationOutput, error)
Lists Type objects by the source API association ID.
func (*Client) Options ¶ added in v1.26.0
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) PutGraphqlApiEnvironmentVariables ¶ added in v1.28.0
func (c *Client) PutGraphqlApiEnvironmentVariables(ctx context.Context, params *PutGraphqlApiEnvironmentVariablesInput, optFns ...func(*Options)) (*PutGraphqlApiEnvironmentVariablesOutput, error)
Creates a list of environmental variables in an API by its ID value.
When creating an environmental variable, it must follow the constraints below:
Both JavaScript and VTL templates support environmental variables.
Environmental variables are not evaluated before function invocation.
Environmental variables only support string values.
Any defined value in an environmental variable is considered a string literal and not expanded.
Variable evaluations should ideally be performed in the function code.
When creating an environmental variable key-value pair, it must follow the additional constraints below:
Keys must begin with a letter.
Keys must be at least two characters long.
Keys can only contain letters, numbers, and the underscore character (_).
Values can be up to 512 characters long.
You can configure up to 50 key-value pairs in a GraphQL API.
You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format {"key1":"value1","key2":"value2", …} . Note that each call of the PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.
func (*Client) StartDataSourceIntrospection ¶ added in v1.25.0
func (c *Client) StartDataSourceIntrospection(ctx context.Context, params *StartDataSourceIntrospectionInput, optFns ...func(*Options)) (*StartDataSourceIntrospectionOutput, error)
Creates a new introspection. Returns the introspectionId of the new introspection after its creation.
func (*Client) StartSchemaCreation ¶
func (c *Client) StartSchemaCreation(ctx context.Context, params *StartSchemaCreationInput, optFns ...func(*Options)) (*StartSchemaCreationOutput, error)
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
func (*Client) StartSchemaMerge ¶ added in v1.21.0
func (c *Client) StartSchemaMerge(ctx context.Context, params *StartSchemaMergeInput, optFns ...func(*Options)) (*StartSchemaMergeOutput, error)
Initiates a merge operation. Returns a status that shows the result of the merge operation.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Tags a resource with user-supplied tags.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Untags a resource.
func (*Client) UpdateApi ¶ added in v1.39.0
func (c *Client) UpdateApi(ctx context.Context, params *UpdateApiInput, optFns ...func(*Options)) (*UpdateApiOutput, error)
Updates an Api .
func (*Client) UpdateApiCache ¶
func (c *Client) UpdateApiCache(ctx context.Context, params *UpdateApiCacheInput, optFns ...func(*Options)) (*UpdateApiCacheOutput, error)
Updates the cache for the GraphQL API.
func (*Client) UpdateApiKey ¶
func (c *Client) UpdateApiKey(ctx context.Context, params *UpdateApiKeyInput, optFns ...func(*Options)) (*UpdateApiKeyOutput, error)
Updates an API key. You can update the key as long as it's not deleted.
func (*Client) UpdateChannelNamespace ¶ added in v1.39.0
func (c *Client) UpdateChannelNamespace(ctx context.Context, params *UpdateChannelNamespaceInput, optFns ...func(*Options)) (*UpdateChannelNamespaceOutput, error)
Updates a ChannelNamespace associated with an Api .
func (*Client) UpdateDataSource ¶
func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error)
Updates a DataSource object.
func (*Client) UpdateDomainName ¶ added in v1.10.0
func (c *Client) UpdateDomainName(ctx context.Context, params *UpdateDomainNameInput, optFns ...func(*Options)) (*UpdateDomainNameOutput, error)
Updates a custom DomainName object.
func (*Client) UpdateFunction ¶
func (c *Client) UpdateFunction(ctx context.Context, params *UpdateFunctionInput, optFns ...func(*Options)) (*UpdateFunctionOutput, error)
Updates a Function object.
func (*Client) UpdateGraphqlApi ¶
func (c *Client) UpdateGraphqlApi(ctx context.Context, params *UpdateGraphqlApiInput, optFns ...func(*Options)) (*UpdateGraphqlApiOutput, error)
Updates a GraphqlApi object.
func (*Client) UpdateResolver ¶
func (c *Client) UpdateResolver(ctx context.Context, params *UpdateResolverInput, optFns ...func(*Options)) (*UpdateResolverOutput, error)
Updates a Resolver object.
func (*Client) UpdateSourceApiAssociation ¶ added in v1.21.0
func (c *Client) UpdateSourceApiAssociation(ctx context.Context, params *UpdateSourceApiAssociationInput, optFns ...func(*Options)) (*UpdateSourceApiAssociationOutput, error)
Updates some of the configuration choices of a particular source API association.
func (*Client) UpdateType ¶
func (c *Client) UpdateType(ctx context.Context, params *UpdateTypeInput, optFns ...func(*Options)) (*UpdateTypeOutput, error)
Updates a Type object.
type CreateApiCacheInput ¶
type CreateApiCacheInput struct { // Caching behavior. // // - FULL_REQUEST_CACHING: All requests from the same user are cached. // Individual resolvers are automatically cached. All API calls will try to return // responses from the cache. // // - PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. // // - OPERATION_LEVEL_CACHING: Full requests are cached together and returned // without executing resolvers. // // This member is required. ApiCachingBehavior types.ApiCachingBehavior // The GraphQL API ID. // // This member is required. ApiId *string // TTL in seconds for cache entries. // // Valid values are 1–3,600 seconds. // // This member is required. 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. // // This member is required. Type types.ApiCacheType // 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 types.CacheHealthMetricsConfig // Transit encryption flag when connecting to cache. You cannot update this // setting after creation. TransitEncryptionEnabled bool // contains filtered or unexported fields }
Represents the input of a CreateApiCache operation.
type CreateApiCacheOutput ¶
type CreateApiCacheOutput struct { // The ApiCache object. ApiCache *types.ApiCache // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Represents the output of a CreateApiCache operation.
type CreateApiInput ¶ added in v1.39.0
type CreateApiInput struct { // The name for the Api . // // This member is required. Name *string // The Event API configuration. This includes the default authorization // configuration for connecting, publishing, and subscribing to an Event API. EventConfig *types.EventConfig // The owner contact information for the Api . OwnerContact *string // A map with keys of TagKey objects and values of TagValue objects. Tags map[string]string // contains filtered or unexported fields }
type CreateApiKeyInput ¶
type CreateApiKeyInput struct { // The ID for your GraphQL API. // // This member is required. ApiId *string // A description of the purpose of the API key. Description *string // From the creation time, the time after which the API key expires. The date is // represented as seconds since the epoch, rounded down to the nearest hour. The // default value for this parameter is 7 days from creation time. For more // information, see . Expires int64 // contains filtered or unexported fields }
type CreateApiKeyOutput ¶
type CreateApiKeyOutput struct { // The API key. ApiKey *types.ApiKey // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateApiOutput ¶ added in v1.39.0
type CreateApiOutput struct { // The Api object. Api *types.Api // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateChannelNamespaceInput ¶ added in v1.39.0
type CreateChannelNamespaceInput struct { // The Api ID. // // This member is required. ApiId *string // The name of the ChannelNamespace . This name must be unique within the Api // // This member is required. Name *string // The event handler functions that run custom business logic to process published // events and subscribe requests. CodeHandlers *string // The authorization mode to use for publishing messages on the channel namespace. // This configuration overrides the default Api authorization configuration. PublishAuthModes []types.AuthMode // The authorization mode to use for subscribing to messages on the channel // namespace. This configuration overrides the default Api authorization // configuration. SubscribeAuthModes []types.AuthMode // A map with keys of TagKey objects and values of TagValue objects. Tags map[string]string // contains filtered or unexported fields }
type CreateChannelNamespaceOutput ¶ added in v1.39.0
type CreateChannelNamespaceOutput struct { // The ChannelNamespace object. ChannelNamespace *types.ChannelNamespace // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDataSourceInput ¶
type CreateDataSourceInput struct { // The API ID for the GraphQL API for the DataSource . // // This member is required. ApiId *string // A user-supplied name for the DataSource . // // This member is required. Name *string // The type of the DataSource . // // This member is required. Type types.DataSourceType // A description of the DataSource . Description *string // Amazon DynamoDB settings. DynamodbConfig *types.DynamodbDataSourceConfig // Amazon OpenSearch Service settings. // // As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch // Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfigto create // an OpenSearch data source. ElasticsearchConfig *types.ElasticsearchDataSourceConfig // Amazon EventBridge settings. EventBridgeConfig *types.EventBridgeDataSourceConfig // HTTP endpoint settings. HttpConfig *types.HttpDataSourceConfig // Lambda settings. LambdaConfig *types.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 types.DataSourceLevelMetricsConfig // Amazon OpenSearch Service settings. OpenSearchServiceConfig *types.OpenSearchServiceDataSourceConfig // Relational database settings. RelationalDatabaseConfig *types.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 // contains filtered or unexported fields }
type CreateDataSourceOutput ¶
type CreateDataSourceOutput struct { // The DataSource object. DataSource *types.DataSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDomainNameInput ¶ added in v1.10.0
type CreateDomainNameInput struct { // 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. // // This member is required. CertificateArn *string // The domain name. // // This member is required. DomainName *string // A description of the DomainName . Description *string // contains filtered or unexported fields }
type CreateDomainNameOutput ¶ added in v1.10.0
type CreateDomainNameOutput struct { // The configuration for the DomainName . DomainNameConfig *types.DomainNameConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateFunctionInput ¶
type CreateFunctionInput struct { // The GraphQL API ID. // // This member is required. ApiId *string // The Function DataSource name. // // This member is required. DataSourceName *string // The Function name. The function name does not have to be unique. // // This member is required. Name *string // 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 Function description. Description *string // The version of the request mapping template. Currently, the supported value is // 2018-05-29. Note that when using VTL and mapping templates, the functionVersion // is required. FunctionVersion *string // The maximum batching size for a resolver. MaxBatchSize int32 // 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 *types.AppSyncRuntime // Describes a Sync configuration for a resolver. // // Specifies which Conflict Detection strategy and Resolution strategy to use when // the resolver is invoked. SyncConfig *types.SyncConfig // contains filtered or unexported fields }
type CreateFunctionOutput ¶
type CreateFunctionOutput struct { // The Function object. FunctionConfiguration *types.FunctionConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateGraphqlApiInput ¶
type CreateGraphqlApiInput struct { // The authentication type: API key, Identity and Access Management (IAM), OpenID // Connect (OIDC), Amazon Cognito user pools, or Lambda. // // This member is required. AuthenticationType types.AuthenticationType // A user-supplied name for the GraphqlApi . // // This member is required. Name *string // A list of additional authentication providers for the GraphqlApi API. AdditionalAuthenticationProviders []types.AdditionalAuthenticationProvider // The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) // or merged API ( MERGED ). ApiType types.GraphQLApiType // The enhancedMetricsConfig object. EnhancedMetricsConfig *types.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 types.GraphQLApiIntrospectionConfig // Configuration for Lambda function authorization. LambdaAuthorizerConfig *types.LambdaAuthorizerConfig // The Amazon CloudWatch Logs configuration. LogConfig *types.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 OIDC configuration. OpenIDConnectConfig *types.OpenIDConnectConfig // 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 // A TagMap object. Tags map[string]string // The Amazon Cognito user pool configuration. UserPoolConfig *types.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 types.GraphQLApiVisibility // A flag indicating whether to use X-Ray tracing for the GraphqlApi . XrayEnabled bool // contains filtered or unexported fields }
type CreateGraphqlApiOutput ¶
type CreateGraphqlApiOutput struct { // The GraphqlApi . GraphqlApi *types.GraphqlApi // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateResolverInput ¶
type CreateResolverInput struct { // The ID for the GraphQL API for which the resolver is being created. // // This member is required. ApiId *string // The name of the field to attach the resolver to. // // This member is required. FieldName *string // The name of the Type . // // This member is required. TypeName *string // The caching configuration for the resolver. CachingConfig *types.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 name of the data source for which the resolver is being created. DataSourceName *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 types.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 types.ResolverLevelMetricsConfig // The PipelineConfig . PipelineConfig *types.PipelineConfig // The mapping template to use for requests. // // A resolver uses a request mapping template to convert a GraphQL expression into // a format that a data source can understand. Mapping templates are written in // Apache Velocity Template Language (VTL). // // VTL request mapping templates are optional when using an Lambda data source. // For all other data sources, VTL request and response mapping templates are // required. RequestMappingTemplate *string // The mapping template to use for responses from the data source. 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 *types.AppSyncRuntime // The SyncConfig for a resolver attached to a versioned data source. SyncConfig *types.SyncConfig // contains filtered or unexported fields }
type CreateResolverOutput ¶
type CreateResolverOutput struct { // The Resolver object. Resolver *types.Resolver // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateTypeInput ¶
type CreateTypeInput struct { // The API ID. // // This member is required. ApiId *string // The type definition, in GraphQL Schema Definition Language (SDL) format. // // For more information, see the [GraphQL SDL documentation]. // // [GraphQL SDL documentation]: http://graphql.org/learn/schema/ // // This member is required. Definition *string // The type format: SDL or JSON. // // This member is required. Format types.TypeDefinitionFormat // contains filtered or unexported fields }
type CreateTypeOutput ¶
type CreateTypeOutput struct { // The Type object. Type *types.Type // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteApiCacheInput ¶
type DeleteApiCacheInput struct { // The API ID. // // This member is required. ApiId *string // contains filtered or unexported fields }
Represents the input of a DeleteApiCache operation.
type DeleteApiCacheOutput ¶
type DeleteApiCacheOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Represents the output of a DeleteApiCache operation.
type DeleteApiInput ¶ added in v1.39.0
type DeleteApiInput struct { // The Api ID. // // This member is required. ApiId *string // contains filtered or unexported fields }
type DeleteApiKeyInput ¶
type DeleteApiKeyOutput ¶
type DeleteApiKeyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteApiOutput ¶ added in v1.39.0
type DeleteApiOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteChannelNamespaceInput ¶ added in v1.39.0
type DeleteChannelNamespaceOutput ¶ added in v1.39.0
type DeleteChannelNamespaceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDataSourceInput ¶
type DeleteDataSourceOutput ¶
type DeleteDataSourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDomainNameInput ¶ added in v1.10.0
type DeleteDomainNameInput struct { // The domain name. // // This member is required. DomainName *string // contains filtered or unexported fields }
type DeleteDomainNameOutput ¶ added in v1.10.0
type DeleteDomainNameOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteFunctionInput ¶
type DeleteFunctionOutput ¶
type DeleteFunctionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteGraphqlApiInput ¶
type DeleteGraphqlApiInput struct { // The API ID. // // This member is required. ApiId *string // contains filtered or unexported fields }
type DeleteGraphqlApiOutput ¶
type DeleteGraphqlApiOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteResolverInput ¶
type DeleteResolverOutput ¶
type DeleteResolverOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteTypeInput ¶
type DeleteTypeOutput ¶
type DeleteTypeOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateApiInput ¶ added in v1.10.0
type DisassociateApiInput struct { // The domain name. // // This member is required. DomainName *string // contains filtered or unexported fields }
type DisassociateApiOutput ¶ added in v1.10.0
type DisassociateApiOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateMergedGraphqlApiInput ¶ added in v1.21.0
type DisassociateMergedGraphqlApiInput struct { // The ID generated by the AppSync service for the source API association. // // This member is required. AssociationId *string // The identifier of the AppSync Source API. This is generated by the AppSync // service. In most cases, source APIs (especially in your account) only require // the API ID value or ARN of the source API. However, source APIs from other // accounts (cross-account use cases) strictly require the full resource ARN of the // source API. // // This member is required. SourceApiIdentifier *string // contains filtered or unexported fields }
type DisassociateMergedGraphqlApiOutput ¶ added in v1.21.0
type DisassociateMergedGraphqlApiOutput struct { // The state of the source API association. SourceApiAssociationStatus types.SourceApiAssociationStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateSourceGraphqlApiInput ¶ added in v1.21.0
type DisassociateSourceGraphqlApiInput struct { // The ID generated by the AppSync service for the source API association. // // This member is required. AssociationId *string // The identifier of the AppSync Merged API. This is generated by the AppSync // service. In most cases, Merged APIs (especially in your account) only require // the API ID value or ARN of the merged API. However, Merged APIs in other // accounts (cross-account use cases) strictly require the full resource ARN of the // merged API. // // This member is required. MergedApiIdentifier *string // contains filtered or unexported fields }
type DisassociateSourceGraphqlApiOutput ¶ added in v1.21.0
type DisassociateSourceGraphqlApiOutput struct { // The state of the source API association. SourceApiAssociationStatus types.SourceApiAssociationStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.22.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.22.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.22.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 ¶ added in v1.1.0
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 ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.22.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.22.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type EvaluateCodeInput ¶ added in v1.16.0
type EvaluateCodeInput struct { // The code definition to be evaluated. Note that code and runtime are both // required for this action. The runtime value must be APPSYNC_JS . // // This member is required. Code *string // The map that holds all of the contextual information for your resolver // invocation. A context is required for this action. // // This member is required. Context *string // The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS // runtime is supported. // // This member is required. Runtime *types.AppSyncRuntime // The function within the code to be evaluated. If provided, the valid values are // request and response . Function *string // contains filtered or unexported fields }
type EvaluateCodeOutput ¶ added in v1.16.0
type EvaluateCodeOutput struct { // Contains the payload of the response error. Error *types.EvaluateCodeErrorDetail // The result of the evaluation operation. EvaluationResult *string // A list of logs that were generated by calls to util.log.info and util.log.error // in the evaluated code. Logs []string // The list of runtime errors that are added to the GraphQL operation response. OutErrors *string // An object available inside each resolver and function handler. A single stash // object lives through a single resolver run. Therefore, you can use the stash to // pass arbitrary data across request and response handlers and across functions in // a pipeline resolver. Stash *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EvaluateMappingTemplateInput ¶ added in v1.15.0
type EvaluateMappingTemplateInput struct { // The map that holds all of the contextual information for your resolver // invocation. A context is required for this action. // // This member is required. Context *string // The mapping template; this can be a request or response template. A template is // required for this action. // // This member is required. Template *string // contains filtered or unexported fields }
type EvaluateMappingTemplateOutput ¶ added in v1.15.0
type EvaluateMappingTemplateOutput struct { // The ErrorDetail object. Error *types.ErrorDetail // The mapping template; this can be a request or response template. EvaluationResult *string // A list of logs that were generated by calls to util.log.info and util.log.error // in the evaluated code. Logs []string // The list of runtime errors that are added to the GraphQL operation response. OutErrors *string // An object available inside each resolver and function handler. A single stash // object lives through a single resolver run. Therefore, you can use the stash to // pass arbitrary data across request and response handlers and across functions in // a pipeline resolver. Stash *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type FlushApiCacheInput ¶
type FlushApiCacheInput struct { // The API ID. // // This member is required. ApiId *string // contains filtered or unexported fields }
Represents the input of a FlushApiCache operation.
type FlushApiCacheOutput ¶
type FlushApiCacheOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Represents the output of a FlushApiCache operation.
type GetApiAssociationInput ¶ added in v1.10.0
type GetApiAssociationInput struct { // The domain name. // // This member is required. DomainName *string // contains filtered or unexported fields }
type GetApiAssociationOutput ¶ added in v1.10.0
type GetApiAssociationOutput struct { // The ApiAssociation object. ApiAssociation *types.ApiAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetApiCacheInput ¶
type GetApiCacheInput struct { // The API ID. // // This member is required. ApiId *string // contains filtered or unexported fields }
Represents the input of a GetApiCache operation.
type GetApiCacheOutput ¶
type GetApiCacheOutput struct { // The ApiCache object. ApiCache *types.ApiCache // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Represents the output of a GetApiCache operation.
type GetApiInput ¶ added in v1.39.0
type GetApiInput struct { // The Api ID. // // This member is required. ApiId *string // contains filtered or unexported fields }
type GetApiOutput ¶ added in v1.39.0
type GetApiOutput struct { // The Api object. Api *types.Api // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetChannelNamespaceInput ¶ added in v1.39.0
type GetChannelNamespaceOutput ¶ added in v1.39.0
type GetChannelNamespaceOutput struct { // The ChannelNamespace object. ChannelNamespace *types.ChannelNamespace // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDataSourceInput ¶
type GetDataSourceIntrospectionInput ¶ added in v1.25.0
type GetDataSourceIntrospectionInput struct { // The introspection ID. Each introspection contains a unique ID that can be used // to reference the instrospection record. // // This member is required. IntrospectionId *string // A boolean flag that determines whether SDL should be generated for introspected // types. If set to true , each model will contain an sdl property that contains // the SDL for that type. The SDL only contains the type data and no additional // metadata or directives. IncludeModelsSDL bool // The maximum number of introspected types that will be returned in a single // response. MaxResults int32 // 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 }
type GetDataSourceIntrospectionOutput ¶ added in v1.25.0
type GetDataSourceIntrospectionOutput struct { // The introspection ID. Each introspection contains a unique ID that can be used // to reference the instrospection record. IntrospectionId *string // The DataSourceIntrospectionResult object data. IntrospectionResult *types.DataSourceIntrospectionResult // The status of the introspection during retrieval. By default, when a new // instrospection is being retrieved, the status will be set to PROCESSING . Once // the operation has been completed, the status will change to SUCCESS or FAILED // depending on how the data was parsed. A FAILED operation will return an error // and its details as an introspectionStatusDetail . IntrospectionStatus types.DataSourceIntrospectionStatus // The error detail field. When a FAILED introspectionStatus is returned, the // introspectionStatusDetail will also return the exact error that was generated // during the operation. IntrospectionStatusDetail *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDataSourceOutput ¶
type GetDataSourceOutput struct { // The DataSource object. DataSource *types.DataSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDomainNameInput ¶ added in v1.10.0
type GetDomainNameInput struct { // The domain name. // // This member is required. DomainName *string // contains filtered or unexported fields }
type GetDomainNameOutput ¶ added in v1.10.0
type GetDomainNameOutput struct { // The configuration for the DomainName . DomainNameConfig *types.DomainNameConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetFunctionInput ¶
type GetFunctionOutput ¶
type GetFunctionOutput struct { // The Function object. FunctionConfiguration *types.FunctionConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetGraphqlApiEnvironmentVariablesInput ¶ added in v1.28.0
type GetGraphqlApiEnvironmentVariablesInput struct { // The ID of the API from which the environmental variable list will be retrieved. // // This member is required. ApiId *string // contains filtered or unexported fields }
type GetGraphqlApiEnvironmentVariablesOutput ¶ added in v1.28.0
type GetGraphqlApiEnvironmentVariablesOutput struct { // The payload containing each environmental variable in the "key" : "value" // format. EnvironmentVariables map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetGraphqlApiInput ¶
type GetGraphqlApiInput struct { // The API ID for the GraphQL API. // // This member is required. ApiId *string // contains filtered or unexported fields }
type GetGraphqlApiOutput ¶
type GetGraphqlApiOutput struct { // The GraphqlApi object. GraphqlApi *types.GraphqlApi // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetIntrospectionSchemaInput ¶
type GetIntrospectionSchemaInput struct { // The API ID. // // This member is required. ApiId *string // The schema format: SDL or JSON. // // This member is required. Format types.OutputType // A flag that specifies whether the schema introspection should contain // directives. IncludeDirectives *bool // contains filtered or unexported fields }
type GetIntrospectionSchemaOutput ¶
type GetIntrospectionSchemaOutput struct { // The schema, in GraphQL Schema Definition Language (SDL) format. // // For more information, see the [GraphQL SDL documentation]. // // [GraphQL SDL documentation]: http://graphql.org/learn/schema/ Schema []byte // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResolverInput ¶
type GetResolverOutput ¶
type GetResolverOutput struct { // The Resolver object. Resolver *types.Resolver // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSchemaCreationStatusInput ¶
type GetSchemaCreationStatusInput struct { // The API ID. // // This member is required. ApiId *string // contains filtered or unexported fields }
type GetSchemaCreationStatusOutput ¶
type GetSchemaCreationStatusOutput struct { // Detailed information about the status of the schema creation operation. Details *string // The current state of the schema (PROCESSING, FAILED, SUCCESS, or // NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data. Status types.SchemaStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSourceApiAssociationInput ¶ added in v1.21.0
type GetSourceApiAssociationInput struct { // The ID generated by the AppSync service for the source API association. // // This member is required. AssociationId *string // The identifier of the AppSync Merged API. This is generated by the AppSync // service. In most cases, Merged APIs (especially in your account) only require // the API ID value or ARN of the merged API. However, Merged APIs in other // accounts (cross-account use cases) strictly require the full resource ARN of the // merged API. // // This member is required. MergedApiIdentifier *string // contains filtered or unexported fields }
type GetSourceApiAssociationOutput ¶ added in v1.21.0
type GetSourceApiAssociationOutput struct { // The SourceApiAssociation object data. SourceApiAssociation *types.SourceApiAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetTypeInput ¶
type GetTypeInput struct { // The API ID. // // This member is required. ApiId *string // The type format: SDL or JSON. // // This member is required. Format types.TypeDefinitionFormat // The type name. // // This member is required. TypeName *string // contains filtered or unexported fields }
type GetTypeOutput ¶
type GetTypeOutput struct { // The Type object. Type *types.Type // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type ListApiKeysAPIClient ¶ added in v1.35.0
type ListApiKeysAPIClient interface {
ListApiKeys(context.Context, *ListApiKeysInput, ...func(*Options)) (*ListApiKeysOutput, error)
}
ListApiKeysAPIClient is a client that implements the ListApiKeys operation.
type ListApiKeysInput ¶
type ListApiKeysInput struct { // The API ID. // // This member is required. ApiId *string // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListApiKeysOutput ¶
type ListApiKeysOutput struct { // The ApiKey objects. ApiKeys []types.ApiKey // An identifier to pass in the next request to this operation to return the next // set of items in the list. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListApiKeysPaginator ¶ added in v1.35.0
type ListApiKeysPaginator struct {
// contains filtered or unexported fields
}
ListApiKeysPaginator is a paginator for ListApiKeys
func NewListApiKeysPaginator ¶ added in v1.35.0
func NewListApiKeysPaginator(client ListApiKeysAPIClient, params *ListApiKeysInput, optFns ...func(*ListApiKeysPaginatorOptions)) *ListApiKeysPaginator
NewListApiKeysPaginator returns a new ListApiKeysPaginator
func (*ListApiKeysPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListApiKeysPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListApiKeysPaginator) NextPage ¶ added in v1.35.0
func (p *ListApiKeysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApiKeysOutput, error)
NextPage retrieves the next ListApiKeys page.
type ListApiKeysPaginatorOptions ¶ added in v1.35.0
type ListApiKeysPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListApiKeysPaginatorOptions is the paginator options for ListApiKeys
type ListApisAPIClient ¶ added in v1.39.0
type ListApisAPIClient interface {
ListApis(context.Context, *ListApisInput, ...func(*Options)) (*ListApisOutput, error)
}
ListApisAPIClient is a client that implements the ListApis operation.
type ListApisInput ¶ added in v1.39.0
type ListApisInput struct { // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListApisOutput ¶ added in v1.39.0
type ListApisOutput struct { // The Api objects. Apis []types.Api // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListApisPaginator ¶ added in v1.39.0
type ListApisPaginator struct {
// contains filtered or unexported fields
}
ListApisPaginator is a paginator for ListApis
func NewListApisPaginator ¶ added in v1.39.0
func NewListApisPaginator(client ListApisAPIClient, params *ListApisInput, optFns ...func(*ListApisPaginatorOptions)) *ListApisPaginator
NewListApisPaginator returns a new ListApisPaginator
func (*ListApisPaginator) HasMorePages ¶ added in v1.39.0
func (p *ListApisPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListApisPaginator) NextPage ¶ added in v1.39.0
func (p *ListApisPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApisOutput, error)
NextPage retrieves the next ListApis page.
type ListApisPaginatorOptions ¶ added in v1.39.0
type ListApisPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListApisPaginatorOptions is the paginator options for ListApis
type ListChannelNamespacesAPIClient ¶ added in v1.39.0
type ListChannelNamespacesAPIClient interface {
ListChannelNamespaces(context.Context, *ListChannelNamespacesInput, ...func(*Options)) (*ListChannelNamespacesOutput, error)
}
ListChannelNamespacesAPIClient is a client that implements the ListChannelNamespaces operation.
type ListChannelNamespacesInput ¶ added in v1.39.0
type ListChannelNamespacesInput struct { // The Api ID. // // This member is required. ApiId *string // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListChannelNamespacesOutput ¶ added in v1.39.0
type ListChannelNamespacesOutput struct { // The ChannelNamespace objects. ChannelNamespaces []types.ChannelNamespace // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListChannelNamespacesPaginator ¶ added in v1.39.0
type ListChannelNamespacesPaginator struct {
// contains filtered or unexported fields
}
ListChannelNamespacesPaginator is a paginator for ListChannelNamespaces
func NewListChannelNamespacesPaginator ¶ added in v1.39.0
func NewListChannelNamespacesPaginator(client ListChannelNamespacesAPIClient, params *ListChannelNamespacesInput, optFns ...func(*ListChannelNamespacesPaginatorOptions)) *ListChannelNamespacesPaginator
NewListChannelNamespacesPaginator returns a new ListChannelNamespacesPaginator
func (*ListChannelNamespacesPaginator) HasMorePages ¶ added in v1.39.0
func (p *ListChannelNamespacesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListChannelNamespacesPaginator) NextPage ¶ added in v1.39.0
func (p *ListChannelNamespacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelNamespacesOutput, error)
NextPage retrieves the next ListChannelNamespaces page.
type ListChannelNamespacesPaginatorOptions ¶ added in v1.39.0
type ListChannelNamespacesPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListChannelNamespacesPaginatorOptions is the paginator options for ListChannelNamespaces
type ListDataSourcesAPIClient ¶ added in v1.35.0
type ListDataSourcesAPIClient interface {
ListDataSources(context.Context, *ListDataSourcesInput, ...func(*Options)) (*ListDataSourcesOutput, error)
}
ListDataSourcesAPIClient is a client that implements the ListDataSources operation.
type ListDataSourcesInput ¶
type ListDataSourcesInput struct { // The API ID. // // This member is required. ApiId *string // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListDataSourcesOutput ¶
type ListDataSourcesOutput struct { // The DataSource objects. DataSources []types.DataSource // An identifier to pass in the next request to this operation to return the next // set of items in the list. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDataSourcesPaginator ¶ added in v1.35.0
type ListDataSourcesPaginator struct {
// contains filtered or unexported fields
}
ListDataSourcesPaginator is a paginator for ListDataSources
func NewListDataSourcesPaginator ¶ added in v1.35.0
func NewListDataSourcesPaginator(client ListDataSourcesAPIClient, params *ListDataSourcesInput, optFns ...func(*ListDataSourcesPaginatorOptions)) *ListDataSourcesPaginator
NewListDataSourcesPaginator returns a new ListDataSourcesPaginator
func (*ListDataSourcesPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListDataSourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDataSourcesPaginator) NextPage ¶ added in v1.35.0
func (p *ListDataSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSourcesOutput, error)
NextPage retrieves the next ListDataSources page.
type ListDataSourcesPaginatorOptions ¶ added in v1.35.0
type ListDataSourcesPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListDataSourcesPaginatorOptions is the paginator options for ListDataSources
type ListDomainNamesAPIClient ¶ added in v1.35.0
type ListDomainNamesAPIClient interface {
ListDomainNames(context.Context, *ListDomainNamesInput, ...func(*Options)) (*ListDomainNamesOutput, error)
}
ListDomainNamesAPIClient is a client that implements the ListDomainNames operation.
type ListDomainNamesInput ¶ added in v1.10.0
type ListDomainNamesInput struct { // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListDomainNamesOutput ¶ added in v1.10.0
type ListDomainNamesOutput struct { // Lists configurations for multiple domain names. DomainNameConfigs []types.DomainNameConfig // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDomainNamesPaginator ¶ added in v1.35.0
type ListDomainNamesPaginator struct {
// contains filtered or unexported fields
}
ListDomainNamesPaginator is a paginator for ListDomainNames
func NewListDomainNamesPaginator ¶ added in v1.35.0
func NewListDomainNamesPaginator(client ListDomainNamesAPIClient, params *ListDomainNamesInput, optFns ...func(*ListDomainNamesPaginatorOptions)) *ListDomainNamesPaginator
NewListDomainNamesPaginator returns a new ListDomainNamesPaginator
func (*ListDomainNamesPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListDomainNamesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDomainNamesPaginator) NextPage ¶ added in v1.35.0
func (p *ListDomainNamesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainNamesOutput, error)
NextPage retrieves the next ListDomainNames page.
type ListDomainNamesPaginatorOptions ¶ added in v1.35.0
type ListDomainNamesPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListDomainNamesPaginatorOptions is the paginator options for ListDomainNames
type ListFunctionsAPIClient ¶ added in v1.35.0
type ListFunctionsAPIClient interface {
ListFunctions(context.Context, *ListFunctionsInput, ...func(*Options)) (*ListFunctionsOutput, error)
}
ListFunctionsAPIClient is a client that implements the ListFunctions operation.
type ListFunctionsInput ¶
type ListFunctionsInput struct { // The GraphQL API ID. // // This member is required. ApiId *string // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListFunctionsOutput ¶
type ListFunctionsOutput struct { // A list of Function objects. Functions []types.FunctionConfiguration // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListFunctionsPaginator ¶ added in v1.35.0
type ListFunctionsPaginator struct {
// contains filtered or unexported fields
}
ListFunctionsPaginator is a paginator for ListFunctions
func NewListFunctionsPaginator ¶ added in v1.35.0
func NewListFunctionsPaginator(client ListFunctionsAPIClient, params *ListFunctionsInput, optFns ...func(*ListFunctionsPaginatorOptions)) *ListFunctionsPaginator
NewListFunctionsPaginator returns a new ListFunctionsPaginator
func (*ListFunctionsPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListFunctionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListFunctionsPaginator) NextPage ¶ added in v1.35.0
func (p *ListFunctionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFunctionsOutput, error)
NextPage retrieves the next ListFunctions page.
type ListFunctionsPaginatorOptions ¶ added in v1.35.0
type ListFunctionsPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListFunctionsPaginatorOptions is the paginator options for ListFunctions
type ListGraphqlApisAPIClient ¶ added in v1.35.0
type ListGraphqlApisAPIClient interface {
ListGraphqlApis(context.Context, *ListGraphqlApisInput, ...func(*Options)) (*ListGraphqlApisOutput, error)
}
ListGraphqlApisAPIClient is a client that implements the ListGraphqlApis operation.
type ListGraphqlApisInput ¶
type ListGraphqlApisInput struct { // The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) // or merged API ( MERGED ). ApiType types.GraphQLApiType // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // The account owner of the GraphQL API. Owner types.Ownership // contains filtered or unexported fields }
type ListGraphqlApisOutput ¶
type ListGraphqlApisOutput struct { // The GraphqlApi objects. GraphqlApis []types.GraphqlApi // An identifier to pass in the next request to this operation to return the next // set of items in the list. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListGraphqlApisPaginator ¶ added in v1.35.0
type ListGraphqlApisPaginator struct {
// contains filtered or unexported fields
}
ListGraphqlApisPaginator is a paginator for ListGraphqlApis
func NewListGraphqlApisPaginator ¶ added in v1.35.0
func NewListGraphqlApisPaginator(client ListGraphqlApisAPIClient, params *ListGraphqlApisInput, optFns ...func(*ListGraphqlApisPaginatorOptions)) *ListGraphqlApisPaginator
NewListGraphqlApisPaginator returns a new ListGraphqlApisPaginator
func (*ListGraphqlApisPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListGraphqlApisPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListGraphqlApisPaginator) NextPage ¶ added in v1.35.0
func (p *ListGraphqlApisPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGraphqlApisOutput, error)
NextPage retrieves the next ListGraphqlApis page.
type ListGraphqlApisPaginatorOptions ¶ added in v1.35.0
type ListGraphqlApisPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListGraphqlApisPaginatorOptions is the paginator options for ListGraphqlApis
type ListResolversAPIClient ¶ added in v1.35.0
type ListResolversAPIClient interface {
ListResolvers(context.Context, *ListResolversInput, ...func(*Options)) (*ListResolversOutput, error)
}
ListResolversAPIClient is a client that implements the ListResolvers operation.
type ListResolversByFunctionAPIClient ¶ added in v1.35.0
type ListResolversByFunctionAPIClient interface {
ListResolversByFunction(context.Context, *ListResolversByFunctionInput, ...func(*Options)) (*ListResolversByFunctionOutput, error)
}
ListResolversByFunctionAPIClient is a client that implements the ListResolversByFunction operation.
type ListResolversByFunctionInput ¶
type ListResolversByFunctionInput struct { // The API ID. // // This member is required. ApiId *string // The function ID. // // This member is required. FunctionId *string // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListResolversByFunctionOutput ¶
type ListResolversByFunctionOutput struct { // An identifier that you can use to return the next set of items in the list. NextToken *string // The list of resolvers. Resolvers []types.Resolver // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResolversByFunctionPaginator ¶ added in v1.35.0
type ListResolversByFunctionPaginator struct {
// contains filtered or unexported fields
}
ListResolversByFunctionPaginator is a paginator for ListResolversByFunction
func NewListResolversByFunctionPaginator ¶ added in v1.35.0
func NewListResolversByFunctionPaginator(client ListResolversByFunctionAPIClient, params *ListResolversByFunctionInput, optFns ...func(*ListResolversByFunctionPaginatorOptions)) *ListResolversByFunctionPaginator
NewListResolversByFunctionPaginator returns a new ListResolversByFunctionPaginator
func (*ListResolversByFunctionPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListResolversByFunctionPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResolversByFunctionPaginator) NextPage ¶ added in v1.35.0
func (p *ListResolversByFunctionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResolversByFunctionOutput, error)
NextPage retrieves the next ListResolversByFunction page.
type ListResolversByFunctionPaginatorOptions ¶ added in v1.35.0
type ListResolversByFunctionPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListResolversByFunctionPaginatorOptions is the paginator options for ListResolversByFunction
type ListResolversInput ¶
type ListResolversInput struct { // The API ID. // // This member is required. ApiId *string // The type name. // // This member is required. TypeName *string // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListResolversOutput ¶
type ListResolversOutput struct { // An identifier to pass in the next request to this operation to return the next // set of items in the list. NextToken *string // The Resolver objects. Resolvers []types.Resolver // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResolversPaginator ¶ added in v1.35.0
type ListResolversPaginator struct {
// contains filtered or unexported fields
}
ListResolversPaginator is a paginator for ListResolvers
func NewListResolversPaginator ¶ added in v1.35.0
func NewListResolversPaginator(client ListResolversAPIClient, params *ListResolversInput, optFns ...func(*ListResolversPaginatorOptions)) *ListResolversPaginator
NewListResolversPaginator returns a new ListResolversPaginator
func (*ListResolversPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListResolversPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResolversPaginator) NextPage ¶ added in v1.35.0
func (p *ListResolversPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResolversOutput, error)
NextPage retrieves the next ListResolvers page.
type ListResolversPaginatorOptions ¶ added in v1.35.0
type ListResolversPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListResolversPaginatorOptions is the paginator options for ListResolvers
type ListSourceApiAssociationsAPIClient ¶ added in v1.35.0
type ListSourceApiAssociationsAPIClient interface {
ListSourceApiAssociations(context.Context, *ListSourceApiAssociationsInput, ...func(*Options)) (*ListSourceApiAssociationsOutput, error)
}
ListSourceApiAssociationsAPIClient is a client that implements the ListSourceApiAssociations operation.
type ListSourceApiAssociationsInput ¶ added in v1.21.0
type ListSourceApiAssociationsInput struct { // The API ID. // // This member is required. ApiId *string // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListSourceApiAssociationsOutput ¶ added in v1.21.0
type ListSourceApiAssociationsOutput struct { // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // The SourceApiAssociationSummary object data. SourceApiAssociationSummaries []types.SourceApiAssociationSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListSourceApiAssociationsPaginator ¶ added in v1.35.0
type ListSourceApiAssociationsPaginator struct {
// contains filtered or unexported fields
}
ListSourceApiAssociationsPaginator is a paginator for ListSourceApiAssociations
func NewListSourceApiAssociationsPaginator ¶ added in v1.35.0
func NewListSourceApiAssociationsPaginator(client ListSourceApiAssociationsAPIClient, params *ListSourceApiAssociationsInput, optFns ...func(*ListSourceApiAssociationsPaginatorOptions)) *ListSourceApiAssociationsPaginator
NewListSourceApiAssociationsPaginator returns a new ListSourceApiAssociationsPaginator
func (*ListSourceApiAssociationsPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListSourceApiAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSourceApiAssociationsPaginator) NextPage ¶ added in v1.35.0
func (p *ListSourceApiAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSourceApiAssociationsOutput, error)
NextPage retrieves the next ListSourceApiAssociations page.
type ListSourceApiAssociationsPaginatorOptions ¶ added in v1.35.0
type ListSourceApiAssociationsPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListSourceApiAssociationsPaginatorOptions is the paginator options for ListSourceApiAssociations
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The GraphqlApi Amazon Resource Name (ARN). // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // A TagMap object. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTypesAPIClient ¶ added in v1.35.0
type ListTypesAPIClient interface {
ListTypes(context.Context, *ListTypesInput, ...func(*Options)) (*ListTypesOutput, error)
}
ListTypesAPIClient is a client that implements the ListTypes operation.
type ListTypesByAssociationAPIClient ¶ added in v1.35.0
type ListTypesByAssociationAPIClient interface {
ListTypesByAssociation(context.Context, *ListTypesByAssociationInput, ...func(*Options)) (*ListTypesByAssociationOutput, error)
}
ListTypesByAssociationAPIClient is a client that implements the ListTypesByAssociation operation.
type ListTypesByAssociationInput ¶ added in v1.21.0
type ListTypesByAssociationInput struct { // The ID generated by the AppSync service for the source API association. // // This member is required. AssociationId *string // The format type. // // This member is required. Format types.TypeDefinitionFormat // The identifier of the AppSync Merged API. This is generated by the AppSync // service. In most cases, Merged APIs (especially in your account) only require // the API ID value or ARN of the merged API. However, Merged APIs in other // accounts (cross-account use cases) strictly require the full resource ARN of the // merged API. // // This member is required. MergedApiIdentifier *string // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListTypesByAssociationOutput ¶ added in v1.21.0
type ListTypesByAssociationOutput struct { // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // The Type objects. Types []types.Type // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTypesByAssociationPaginator ¶ added in v1.35.0
type ListTypesByAssociationPaginator struct {
// contains filtered or unexported fields
}
ListTypesByAssociationPaginator is a paginator for ListTypesByAssociation
func NewListTypesByAssociationPaginator ¶ added in v1.35.0
func NewListTypesByAssociationPaginator(client ListTypesByAssociationAPIClient, params *ListTypesByAssociationInput, optFns ...func(*ListTypesByAssociationPaginatorOptions)) *ListTypesByAssociationPaginator
NewListTypesByAssociationPaginator returns a new ListTypesByAssociationPaginator
func (*ListTypesByAssociationPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListTypesByAssociationPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTypesByAssociationPaginator) NextPage ¶ added in v1.35.0
func (p *ListTypesByAssociationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypesByAssociationOutput, error)
NextPage retrieves the next ListTypesByAssociation page.
type ListTypesByAssociationPaginatorOptions ¶ added in v1.35.0
type ListTypesByAssociationPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListTypesByAssociationPaginatorOptions is the paginator options for ListTypesByAssociation
type ListTypesInput ¶
type ListTypesInput struct { // The API ID. // // This member is required. ApiId *string // The type format: SDL or JSON. // // This member is required. Format types.TypeDefinitionFormat // The maximum number of results that you want the request to return. MaxResults int32 // An identifier that was returned from the previous call to this operation, which // you can use to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListTypesOutput ¶
type ListTypesOutput struct { // An identifier to pass in the next request to this operation to return the next // set of items in the list. NextToken *string // The Type objects. Types []types.Type // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTypesPaginator ¶ added in v1.35.0
type ListTypesPaginator struct {
// contains filtered or unexported fields
}
ListTypesPaginator is a paginator for ListTypes
func NewListTypesPaginator ¶ added in v1.35.0
func NewListTypesPaginator(client ListTypesAPIClient, params *ListTypesInput, optFns ...func(*ListTypesPaginatorOptions)) *ListTypesPaginator
NewListTypesPaginator returns a new ListTypesPaginator
func (*ListTypesPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListTypesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTypesPaginator) NextPage ¶ added in v1.35.0
func (p *ListTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypesOutput, error)
NextPage retrieves the next ListTypes page.
type ListTypesPaginatorOptions ¶ added in v1.35.0
type ListTypesPaginatorOptions struct { // The maximum number of results that you want the request to return. 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 }
ListTypesPaginatorOptions is the paginator options for ListTypes
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) GetIdentityResolver ¶ added in v1.24.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PutGraphqlApiEnvironmentVariablesInput ¶ added in v1.28.0
type PutGraphqlApiEnvironmentVariablesInput struct { // The ID of the API to which the environmental variable list will be written. // // This member is required. ApiId *string // The list of environmental variables to add to the API. // // When creating an environmental variable key-value pair, it must follow the // additional constraints below: // // - Keys must begin with a letter. // // - Keys must be at least two characters long. // // - Keys can only contain letters, numbers, and the underscore character (_). // // - Values can be up to 512 characters long. // // - You can configure up to 50 key-value pairs in a GraphQL API. // // You can create a list of environmental variables by adding it to the // environmentVariables payload as a list in the format // {"key1":"value1","key2":"value2", …} . Note that each call of the // PutGraphqlApiEnvironmentVariables action will result in the overwriting of the // existing environmental variable list of that API. This means the existing // environmental variables will be lost. To avoid this, you must include all // existing and new environmental variables in the list each time you call this // action. // // This member is required. EnvironmentVariables map[string]string // contains filtered or unexported fields }
type PutGraphqlApiEnvironmentVariablesOutput ¶ added in v1.28.0
type PutGraphqlApiEnvironmentVariablesOutput struct { // The payload containing each environmental variable in the "key" : "value" // format. EnvironmentVariables map[string]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 StartDataSourceIntrospectionInput ¶ added in v1.25.0
type StartDataSourceIntrospectionInput struct { // The rdsDataApiConfig object data. RdsDataApiConfig *types.RdsDataApiConfig // contains filtered or unexported fields }
type StartDataSourceIntrospectionOutput ¶ added in v1.25.0
type StartDataSourceIntrospectionOutput struct { // The introspection ID. Each introspection contains a unique ID that can be used // to reference the instrospection record. IntrospectionId *string // The status of the introspection during creation. By default, when a new // instrospection has been created, the status will be set to PROCESSING . Once the // operation has been completed, the status will change to SUCCESS or FAILED // depending on how the data was parsed. A FAILED operation will return an error // and its details as an introspectionStatusDetail . IntrospectionStatus types.DataSourceIntrospectionStatus // The error detail field. When a FAILED introspectionStatus is returned, the // introspectionStatusDetail will also return the exact error that was generated // during the operation. IntrospectionStatusDetail *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartSchemaCreationOutput ¶
type StartSchemaCreationOutput struct { // The current state of the schema (PROCESSING, FAILED, SUCCESS, or // NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data. Status types.SchemaStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartSchemaMergeInput ¶ added in v1.21.0
type StartSchemaMergeInput struct { // The ID generated by the AppSync service for the source API association. // // This member is required. AssociationId *string // The identifier of the AppSync Merged API. This is generated by the AppSync // service. In most cases, Merged APIs (especially in your account) only require // the API ID value or ARN of the merged API. However, Merged APIs in other // accounts (cross-account use cases) strictly require the full resource ARN of the // merged API. // // This member is required. MergedApiIdentifier *string // contains filtered or unexported fields }
type StartSchemaMergeOutput ¶ added in v1.21.0
type StartSchemaMergeOutput struct { // The state of the source API association. SourceApiAssociationStatus types.SourceApiAssociationStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateApiCacheInput ¶
type UpdateApiCacheInput struct { // Caching behavior. // // - FULL_REQUEST_CACHING: All requests from the same user are cached. // Individual resolvers are automatically cached. All API calls will try to return // responses from the cache. // // - PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. // // - OPERATION_LEVEL_CACHING: Full requests are cached together and returned // without executing resolvers. // // This member is required. ApiCachingBehavior types.ApiCachingBehavior // The GraphQL API ID. // // This member is required. ApiId *string // TTL in seconds for cache entries. // // Valid values are 1–3,600 seconds. // // This member is required. 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. // // This member is required. Type types.ApiCacheType // 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 types.CacheHealthMetricsConfig // contains filtered or unexported fields }
Represents the input of a UpdateApiCache operation.
type UpdateApiCacheOutput ¶
type UpdateApiCacheOutput struct { // The ApiCache object. ApiCache *types.ApiCache // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Represents the output of a UpdateApiCache operation.
type UpdateApiInput ¶ added in v1.39.0
type UpdateApiInput struct { // The Api ID. // // This member is required. ApiId *string // The name of the Api. // // This member is required. Name *string // The new event configuration. This includes the default authorization // configuration for connecting, publishing, and subscribing to an Event API. EventConfig *types.EventConfig // The owner contact information for the Api . OwnerContact *string // contains filtered or unexported fields }
type UpdateApiKeyInput ¶
type UpdateApiKeyInput struct { // The ID for the GraphQL API. // // This member is required. ApiId *string // The API key ID. // // This member is required. Id *string // A description of the purpose of the API key. Description *string // From the update time, the time after which the API key expires. The date is // represented as seconds since the epoch. For more information, see . Expires int64 // contains filtered or unexported fields }
type UpdateApiKeyOutput ¶
type UpdateApiKeyOutput struct { // The API key. ApiKey *types.ApiKey // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateApiOutput ¶ added in v1.39.0
type UpdateApiOutput struct { // The Api object. Api *types.Api // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateChannelNamespaceInput ¶ added in v1.39.0
type UpdateChannelNamespaceInput struct { // The Api ID. // // This member is required. ApiId *string // The name of the ChannelNamespace . // // This member is required. Name *string // The event handler functions that run custom business logic to process published // events and subscribe requests. CodeHandlers *string // The authorization mode to use for publishing messages on the channel namespace. // This configuration overrides the default Api authorization configuration. PublishAuthModes []types.AuthMode // The authorization mode to use for subscribing to messages on the channel // namespace. This configuration overrides the default Api authorization // configuration. SubscribeAuthModes []types.AuthMode // contains filtered or unexported fields }
type UpdateChannelNamespaceOutput ¶ added in v1.39.0
type UpdateChannelNamespaceOutput struct { // The ChannelNamespace object. ChannelNamespace *types.ChannelNamespace // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateDataSourceInput ¶
type UpdateDataSourceInput struct { // The API ID. // // This member is required. ApiId *string // The new name for the data source. // // This member is required. Name *string // The new data source type. // // This member is required. Type types.DataSourceType // The new description for the data source. Description *string // The new Amazon DynamoDB configuration. DynamodbConfig *types.DynamodbDataSourceConfig // The new OpenSearch configuration. // // As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch // Service. This configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfigto update an OpenSearch // data source. ElasticsearchConfig *types.ElasticsearchDataSourceConfig // The new Amazon EventBridge settings. EventBridgeConfig *types.EventBridgeDataSourceConfig // The new HTTP endpoint configuration. HttpConfig *types.HttpDataSourceConfig // The new Lambda configuration. LambdaConfig *types.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 types.DataSourceLevelMetricsConfig // The new OpenSearch configuration. OpenSearchServiceConfig *types.OpenSearchServiceDataSourceConfig // The new relational database configuration. RelationalDatabaseConfig *types.RelationalDatabaseDataSourceConfig // The new service role Amazon Resource Name (ARN) for the data source. ServiceRoleArn *string // contains filtered or unexported fields }
type UpdateDataSourceOutput ¶
type UpdateDataSourceOutput struct { // The updated DataSource object. DataSource *types.DataSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateDomainNameInput ¶ added in v1.10.0
type UpdateDomainNameOutput ¶ added in v1.10.0
type UpdateDomainNameOutput struct { // The configuration for the DomainName . DomainNameConfig *types.DomainNameConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateFunctionInput ¶
type UpdateFunctionInput struct { // The GraphQL API ID. // // This member is required. ApiId *string // The Function DataSource name. // // This member is required. DataSourceName *string // The function ID. // // This member is required. FunctionId *string // The Function name. // // This member is required. Name *string // 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 Function description. Description *string // The version of the request mapping template. Currently, the supported value is // 2018-05-29. Note that when using VTL and mapping templates, the functionVersion // is required. FunctionVersion *string // The maximum batching size for a resolver. MaxBatchSize int32 // The Function request mapping template. Functions support only the 2018-05-29 // version of the request mapping template. RequestMappingTemplate *string // The Function request 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 *types.AppSyncRuntime // Describes a Sync configuration for a resolver. // // Specifies which Conflict Detection strategy and Resolution strategy to use when // the resolver is invoked. SyncConfig *types.SyncConfig // contains filtered or unexported fields }
type UpdateFunctionOutput ¶
type UpdateFunctionOutput struct { // The Function object. FunctionConfiguration *types.FunctionConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateGraphqlApiInput ¶
type UpdateGraphqlApiInput struct { // The API ID. // // This member is required. ApiId *string // The new authentication type for the GraphqlApi object. // // This member is required. AuthenticationType types.AuthenticationType // The new name for the GraphqlApi object. // // This member is required. Name *string // A list of additional authentication providers for the GraphqlApi API. AdditionalAuthenticationProviders []types.AdditionalAuthenticationProvider // The enhancedMetricsConfig object. EnhancedMetricsConfig *types.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 types.GraphQLApiIntrospectionConfig // Configuration for Lambda function authorization. LambdaAuthorizerConfig *types.LambdaAuthorizerConfig // The Amazon CloudWatch Logs configuration for the GraphqlApi object. LogConfig *types.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 OpenID Connect configuration for the GraphqlApi object. OpenIDConnectConfig *types.OpenIDConnectConfig // 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 new Amazon Cognito user pool configuration for the ~GraphqlApi object. UserPoolConfig *types.UserPoolConfig // A flag indicating whether to use X-Ray tracing for the GraphqlApi . XrayEnabled bool // contains filtered or unexported fields }
type UpdateGraphqlApiOutput ¶
type UpdateGraphqlApiOutput struct { // The updated GraphqlApi object. GraphqlApi *types.GraphqlApi // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateResolverInput ¶
type UpdateResolverInput struct { // The API ID. // // This member is required. ApiId *string // The new field name. // // This member is required. FieldName *string // The new type name. // // This member is required. TypeName *string // The caching configuration for the resolver. CachingConfig *types.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 new data source name. DataSourceName *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 types.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 types.ResolverLevelMetricsConfig // The PipelineConfig . PipelineConfig *types.PipelineConfig // The new request mapping template. // // A resolver uses a request mapping template to convert a GraphQL expression into // a format that a data source can understand. Mapping templates are written in // Apache Velocity Template Language (VTL). // // VTL request mapping templates are optional when using an Lambda data source. // For all other data sources, VTL request and response mapping templates are // required. RequestMappingTemplate *string // The new 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 *types.AppSyncRuntime // The SyncConfig for a resolver attached to a versioned data source. SyncConfig *types.SyncConfig // contains filtered or unexported fields }
type UpdateResolverOutput ¶
type UpdateResolverOutput struct { // The updated Resolver object. Resolver *types.Resolver // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateSourceApiAssociationInput ¶ added in v1.21.0
type UpdateSourceApiAssociationInput struct { // The ID generated by the AppSync service for the source API association. // // This member is required. AssociationId *string // The identifier of the AppSync Merged API. This is generated by the AppSync // service. In most cases, Merged APIs (especially in your account) only require // the API ID value or ARN of the merged API. However, Merged APIs in other // accounts (cross-account use cases) strictly require the full resource ARN of the // merged API. // // This member is required. MergedApiIdentifier *string // The description field. Description *string // The SourceApiAssociationConfig object data. SourceApiAssociationConfig *types.SourceApiAssociationConfig // contains filtered or unexported fields }
type UpdateSourceApiAssociationOutput ¶ added in v1.21.0
type UpdateSourceApiAssociationOutput struct { // The SourceApiAssociation object data. SourceApiAssociation *types.SourceApiAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateTypeInput ¶
type UpdateTypeInput struct { // The API ID. // // This member is required. ApiId *string // The new type format: SDL or JSON. // // This member is required. Format types.TypeDefinitionFormat // The new type name. // // This member is required. TypeName *string // The new definition. Definition *string // contains filtered or unexported fields }
type UpdateTypeOutput ¶
type UpdateTypeOutput struct { // The updated Type object. Type *types.Type // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files
¶
- api_client.go
- api_op_AssociateApi.go
- api_op_AssociateMergedGraphqlApi.go
- api_op_AssociateSourceGraphqlApi.go
- api_op_CreateApi.go
- api_op_CreateApiCache.go
- api_op_CreateApiKey.go
- api_op_CreateChannelNamespace.go
- api_op_CreateDataSource.go
- api_op_CreateDomainName.go
- api_op_CreateFunction.go
- api_op_CreateGraphqlApi.go
- api_op_CreateResolver.go
- api_op_CreateType.go
- api_op_DeleteApi.go
- api_op_DeleteApiCache.go
- api_op_DeleteApiKey.go
- api_op_DeleteChannelNamespace.go
- api_op_DeleteDataSource.go
- api_op_DeleteDomainName.go
- api_op_DeleteFunction.go
- api_op_DeleteGraphqlApi.go
- api_op_DeleteResolver.go
- api_op_DeleteType.go
- api_op_DisassociateApi.go
- api_op_DisassociateMergedGraphqlApi.go
- api_op_DisassociateSourceGraphqlApi.go
- api_op_EvaluateCode.go
- api_op_EvaluateMappingTemplate.go
- api_op_FlushApiCache.go
- api_op_GetApi.go
- api_op_GetApiAssociation.go
- api_op_GetApiCache.go
- api_op_GetChannelNamespace.go
- api_op_GetDataSource.go
- api_op_GetDataSourceIntrospection.go
- api_op_GetDomainName.go
- api_op_GetFunction.go
- api_op_GetGraphqlApi.go
- api_op_GetGraphqlApiEnvironmentVariables.go
- api_op_GetIntrospectionSchema.go
- api_op_GetResolver.go
- api_op_GetSchemaCreationStatus.go
- api_op_GetSourceApiAssociation.go
- api_op_GetType.go
- api_op_ListApiKeys.go
- api_op_ListApis.go
- api_op_ListChannelNamespaces.go
- api_op_ListDataSources.go
- api_op_ListDomainNames.go
- api_op_ListFunctions.go
- api_op_ListGraphqlApis.go
- api_op_ListResolvers.go
- api_op_ListResolversByFunction.go
- api_op_ListSourceApiAssociations.go
- api_op_ListTagsForResource.go
- api_op_ListTypes.go
- api_op_ListTypesByAssociation.go
- api_op_PutGraphqlApiEnvironmentVariables.go
- api_op_StartDataSourceIntrospection.go
- api_op_StartSchemaCreation.go
- api_op_StartSchemaMerge.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateApi.go
- api_op_UpdateApiCache.go
- api_op_UpdateApiKey.go
- api_op_UpdateChannelNamespace.go
- api_op_UpdateDataSource.go
- api_op_UpdateDomainName.go
- api_op_UpdateFunction.go
- api_op_UpdateGraphqlApi.go
- api_op_UpdateResolver.go
- api_op_UpdateSourceApiAssociation.go
- api_op_UpdateType.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go