'2.0', 'service' => '
AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
', 'operations' => [ 'AssociateApi' => 'Maps an endpoint to your custom domain.
', 'AssociateMergedGraphqlApi' => 'Creates an association between a Merged API and source API using the source API\'s identifier.
', 'AssociateSourceGraphqlApi' => 'Creates an association between a Merged API and source API using the Merged API\'s identifier.
', 'CreateApiCache' => 'Creates a cache for the GraphQL API.
', 'CreateApiKey' => 'Creates a unique key that you can distribute to clients who invoke your API.
', 'CreateDataSource' => 'Creates a DataSource
object.
Creates a custom DomainName
object.
Creates a Function
object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
', 'CreateGraphqlApi' => 'Creates a GraphqlApi
object.
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.
', 'CreateType' => 'Creates a Type
object.
Deletes an ApiCache
object.
Deletes an API key.
', 'DeleteDataSource' => 'Deletes a DataSource
object.
Deletes a custom DomainName
object.
Deletes a Function
.
Deletes a GraphqlApi
object.
Deletes a Resolver
object.
Deletes a Type
object.
Removes an ApiAssociation
object from a custom domain.
Deletes an association between a Merged API and source API using the source API\'s identifier and the association ID.
', 'DisassociateSourceGraphqlApi' => 'Deletes an association between a Merged API and source API using the Merged API\'s identifier and the association ID.
', 'EvaluateCode' => '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.
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).
', 'FlushApiCache' => 'Flushes an ApiCache
object.
Retrieves an ApiAssociation
object.
Retrieves an ApiCache
object.
Retrieves a DataSource
object.
Retrieves a custom DomainName
object.
Get a Function
.
Retrieves a GraphqlApi
object.
Retrieves the introspection schema for a GraphQL API.
', 'GetResolver' => 'Retrieves a Resolver
object.
Retrieves the current status of a schema creation operation.
', 'GetSourceApiAssociation' => 'Retrieves a SourceApiAssociation
object.
Retrieves a Type
object.
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.
Lists the data sources for a given API.
', 'ListDomainNames' => 'Lists multiple custom domain names.
', 'ListFunctions' => 'List multiple functions.
', 'ListGraphqlApis' => 'Lists your GraphQL APIs.
', 'ListResolvers' => 'Lists the resolvers for a given API and type.
', 'ListResolversByFunction' => 'List the resolvers that are associated with a specific function.
', 'ListSourceApiAssociations' => 'Lists the SourceApiAssociationSummary
data.
Lists the tags for a resource.
', 'ListTypes' => 'Lists the types for a given API.
', 'ListTypesByAssociation' => 'Lists Type
objects by the source API association ID.
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
', 'StartSchemaMerge' => 'Initiates a merge operation. Returns a status that shows the result of the merge operation.
', 'TagResource' => 'Tags a resource with user-supplied tags.
', 'UntagResource' => 'Untags a resource.
', 'UpdateApiCache' => 'Updates the cache for the GraphQL API.
', 'UpdateApiKey' => 'Updates an API key. You can update the key as long as it\'s not deleted.
', 'UpdateDataSource' => 'Updates a DataSource
object.
Updates a custom DomainName
object.
Updates a Function
object.
Updates a GraphqlApi
object.
Updates a Resolver
object.
Updates some of the configuration choices of a particular source API association.
', 'UpdateType' => 'Updates a Type
object.
You don\'t have access to perform this operation on this resource.
', 'refs' => [], ], 'AdditionalAuthenticationProvider' => [ 'base' => 'Describes an additional authentication provider.
', 'refs' => [ 'AdditionalAuthenticationProviders$member' => NULL, ], ], 'AdditionalAuthenticationProviders' => [ 'base' => NULL, 'refs' => [ 'CreateGraphqlApiRequest$additionalAuthenticationProviders' => 'A list of additional authentication providers for the GraphqlApi
API.
A list of additional authentication providers for the GraphqlApi
API.
A list of additional authentication providers for the GraphqlApi
API.
Describes an ApiAssociation
object.
The ApiAssociation
object.
The ApiAssociation
object.
The ApiCache
object.
The ApiCache
object.
The ApiCache
object.
The ApiCache
object.
The cache instance status.
AVAILABLE: The instance is available for use.
CREATING: The instance is currently creating.
DELETING: The instance is currently deleting.
MODIFYING: The instance is currently modifying.
FAILED: The instance has failed creation.
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.
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.
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.
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
Describes an API key.
Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:
da1: We introduced this version at launch in November 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid after February 21, 2018, and they should no longer be used.
ListApiKeys
returns the expiration time in milliseconds.
CreateApiKey
returns the expiration time in milliseconds.
UpdateApiKey
is not available for this key version.
DeleteApiKey
deletes the item from the table.
Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we deleted these keys from the table on February 21, 2018.
da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
ListApiKeys
returns the expiration time and deletion time in seconds.
CreateApiKey
returns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.
UpdateApiKey
returns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. You can update the key expiration time as long as the key isn\'t deleted.
DeleteApiKey
deletes the item from the table.
Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. However, you can reinstate the key before deletion.
Deletion is stored in DynamoDB as seconds. The key is deleted after deletion time.
The API key.
', 'UpdateApiKeyResponse$apiKey' => 'The API key.
', ], ], 'ApiKeyLimitExceededException' => [ 'base' => 'The API key exceeded a limit. Try your request again.
', 'refs' => [], ], 'ApiKeyValidityOutOfBoundsException' => [ 'base' => 'The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey
) or from update (for UpdateApiKey
).
The ApiKey
objects.
The GraphQL API exceeded a limit. Try your request again.
', 'refs' => [], ], 'AppSyncRuntime' => [ 'base' => '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.
', 'refs' => [ 'CreateFunctionRequest$runtime' => NULL, 'CreateResolverRequest$runtime' => NULL, 'EvaluateCodeRequest$runtime' => 'The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS
runtime is supported.
Identifies the status of an association.
PROCESSING: The API association is being created. You cannot modify association requests during processing.
SUCCESS: The API association was successful. You can modify associations after success.
FAILED: The API association has failed. You can modify associations after failure.
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
', 'CreateGraphqlApiRequest$authenticationType' => 'The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
', 'GraphqlApi$authenticationType' => 'The authentication type.
', 'UpdateGraphqlApiRequest$authenticationType' => 'The new authentication type for the GraphqlApi
object.
The authorization configuration in case the HTTP endpoint requires authorization.
', 'refs' => [ 'HttpDataSourceConfig$authorizationConfig' => 'The authorization configuration in case the HTTP endpoint requires authorization.
', ], ], 'AuthorizationType' => [ 'base' => NULL, 'refs' => [ 'AuthorizationConfig$authorizationType' => 'The authorization type that the HTTP endpoint requires.
AWS_IAM: The authorization type is Signature Version 4 (SigV4).
The Identity and Access Management (IAM) configuration.
', 'refs' => [ 'AuthorizationConfig$awsIamConfig' => 'The Identity and Access Management (IAM) settings.
', ], ], 'BadRequestDetail' => [ 'base' => 'Provides further details for the reason behind the bad request. For reason type CODE_ERROR
, the detail will contain a list of code errors.
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.
', 'refs' => [], ], 'BadRequestReason' => [ 'base' => 'Provides context for the cause of the bad request. The only supported value is CODE_ERROR
.
The schema, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
', 'StartSchemaCreationRequest$definition' => 'The schema definition, in GraphQL schema language format.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ApiCache$transitEncryptionEnabled' => 'Transit encryption flag when connecting to cache. You cannot update this setting after creation.
', 'ApiCache$atRestEncryptionEnabled' => 'At-rest encryption flag for cache. You cannot update this setting after creation.
', 'CreateApiCacheRequest$transitEncryptionEnabled' => 'Transit encryption flag when connecting to cache. You cannot update this setting after creation.
', 'CreateApiCacheRequest$atRestEncryptionEnabled' => 'At-rest encryption flag for cache. You cannot update this setting after creation.
', 'CreateGraphqlApiRequest$xrayEnabled' => 'A flag indicating whether to use X-Ray tracing for the GraphqlApi
.
Set to TRUE to use Amazon Cognito credentials with this data source.
', 'DynamodbDataSourceConfig$versioned' => 'Set to TRUE to use Conflict Detection and Resolution with this data source.
', 'GraphqlApi$xrayEnabled' => 'A flag indicating whether to use X-Ray tracing for this GraphqlApi
.
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
', 'UpdateGraphqlApiRequest$xrayEnabled' => 'A flag indicating whether to use X-Ray tracing for the GraphqlApi
.
A flag that specifies whether the schema introspection should contain directives.
', ], ], 'CachingConfig' => [ 'base' => 'The caching configuration for a resolver that has caching activated.
', 'refs' => [ 'CreateResolverRequest$cachingConfig' => 'The caching configuration for the resolver.
', 'Resolver$cachingConfig' => 'The caching configuration for the resolver.
', 'UpdateResolverRequest$cachingConfig' => 'The caching configuration for the resolver.
', ], ], 'CachingKeys' => [ 'base' => NULL, 'refs' => [ 'CachingConfig$cachingKeys' => 'The caching keys for a resolver that has caching activated.
Valid values are entries from the $context.arguments
, $context.source
, and $context.identity
maps.
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.
', 'DomainNameConfig$certificateArn' => '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.
', ], ], 'Code' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$code' => '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
.
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
.
The code definition to be evaluated. Note that code
and runtime
are both required for this action. The runtime
value must be APPSYNC_JS
.
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
.
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
.
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
.
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
.
Describes an AppSync error.
', 'refs' => [ 'CodeErrors$member' => NULL, ], ], 'CodeErrorColumn' => [ 'base' => NULL, 'refs' => [ 'CodeErrorLocation$column' => 'The column number in the code. Defaults to 0
if unknown.
The line number in the code. Defaults to 0
if unknown.
Describes the location of the error in a code sample.
', 'refs' => [ 'CodeError$location' => 'The line, column, and span location of the error in the code.
', ], ], 'CodeErrorSpan' => [ 'base' => NULL, 'refs' => [ 'CodeErrorLocation$span' => 'The span/length of the error. Defaults to -1
if unknown.
Contains the list of errors in the request.
', 'EvaluateCodeErrorDetail$codeErrors' => 'Contains the list of CodeError
objects.
Describes an Amazon Cognito user pool configuration.
', 'refs' => [ 'AdditionalAuthenticationProvider$userPoolConfig' => 'The Amazon Cognito user pool configuration.
', ], ], 'ConcurrentModificationException' => [ 'base' => 'Another modification is in progress at this time and it must complete before you can make your change.
', 'refs' => [], ], 'ConflictDetectionType' => [ 'base' => NULL, 'refs' => [ 'SyncConfig$conflictDetection' => 'The Conflict Detection strategy to use.
VERSION: Detect conflicts based on object versions for this resolver.
NONE: Do not detect conflicts when invoking this resolver.
The Conflict Resolution strategy to perform in the event of a conflict.
OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don\'t match the latest version at the server.
AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
LAMBDA: Resolve conflicts with an Lambda function supplied in the LambdaConflictHandlerConfig
.
The map that holds all of the contextual information for your resolver invocation. A context
is required for this action.
The map that holds all of the contextual information for your resolver invocation. A context
is required for this action.
Represents the input of a CreateApiCache
operation.
Represents the output of a CreateApiCache
operation.
Describes a data source.
', 'refs' => [ 'CreateDataSourceResponse$dataSource' => 'The DataSource
object.
The DataSource
object.
The updated DataSource
object.
The type of the DataSource
.
The type of the data source.
AWS_LAMBDA: The data source is an Lambda function.
AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you\'re performing data transformation with resolvers or invoking a subscription from a mutation.
HTTP: The data source is an HTTP endpoint.
RELATIONAL_DATABASE: The data source is a relational database.
The new data source type.
', ], ], 'DataSources' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$dataSources' => 'The DataSource
objects.
The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.
', ], ], 'DefaultAction' => [ 'base' => NULL, 'refs' => [ 'UserPoolConfig$defaultAction' => 'The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn\'t match the Amazon Cognito user pool configuration.
', ], ], 'DeleteApiCacheRequest' => [ 'base' => 'Represents the input of a DeleteApiCache
operation.
Represents the output of a DeleteApiCache
operation.
Describes a Delta Sync configuration.
', 'refs' => [ 'DynamodbDataSourceConfig$deltaSyncConfig' => 'The DeltaSyncConfig
for a versioned data source.
A description of the DomainName
.
A description of the DomainName
configuration.
A description of the DomainName
.
The domain name.
', 'AssociateApiRequest$domainName' => 'The domain name.
', 'CreateDomainNameRequest$domainName' => 'The domain name.
', 'DeleteDomainNameRequest$domainName' => 'The domain name.
', 'DisassociateApiRequest$domainName' => 'The domain name.
', 'DomainNameConfig$domainName' => 'The domain name.
', 'GetApiAssociationRequest$domainName' => 'The domain name.
', 'GetDomainNameRequest$domainName' => 'The domain name.
', 'UpdateDomainNameRequest$domainName' => 'The domain name.
', ], ], 'DomainNameConfig' => [ 'base' => 'Describes a configuration for a custom domain.
', 'refs' => [ 'CreateDomainNameResponse$domainNameConfig' => 'The configuration for the DomainName
.
The configuration for the DomainName
.
The configuration for the DomainName
.
Lists configurations for multiple domain names.
', ], ], 'DynamodbDataSourceConfig' => [ 'base' => 'Describes an Amazon DynamoDB data source configuration.
', 'refs' => [ 'CreateDataSourceRequest$dynamodbConfig' => 'Amazon DynamoDB settings.
', 'DataSource$dynamodbConfig' => 'DynamoDB settings.
', 'UpdateDataSourceRequest$dynamodbConfig' => 'The new Amazon DynamoDB configuration.
', ], ], 'ElasticsearchDataSourceConfig' => [ 'base' => 'Describes an OpenSearch data source configuration.
As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.
', 'refs' => [ 'CreateDataSourceRequest$elasticsearchConfig' => '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$openSearchServiceConfig to create an OpenSearch data source.
', 'DataSource$elasticsearchConfig' => 'Amazon OpenSearch Service settings.
', 'UpdateDataSourceRequest$elasticsearchConfig' => 'The new OpenSearch configuration.
As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
', ], ], 'ErrorDetail' => [ 'base' => 'Contains the list of errors generated. When using JavaScript, this will apply to the request or response function evaluation.
', 'refs' => [ 'EvaluateMappingTemplateResponse$error' => 'The ErrorDetail
object.
The error payload.
', 'EvaluateCodeErrorDetail$message' => 'The error payload.
', 'GraphQLSchemaException$message' => NULL, ], ], 'EvaluateCodeErrorDetail' => [ 'base' => 'Contains the list of errors from a code evaluation response.
', 'refs' => [ 'EvaluateCodeResponse$error' => 'Contains the payload of the response error.
', ], ], 'EvaluateCodeRequest' => [ 'base' => NULL, 'refs' => [], ], 'EvaluateCodeResponse' => [ 'base' => NULL, 'refs' => [], ], 'EvaluateMappingTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'EvaluateMappingTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'EvaluationResult' => [ 'base' => NULL, 'refs' => [ 'EvaluateCodeResponse$evaluationResult' => 'The result of the evaluation operation.
', 'EvaluateMappingTemplateResponse$evaluationResult' => 'The mapping template; this can be a request or response template.
', ], ], 'EventBridgeDataSourceConfig' => [ 'base' => 'Describes an Amazon EventBridge bus data source configuration.
', 'refs' => [ 'CreateDataSourceRequest$eventBridgeConfig' => 'Amazon EventBridge settings.
', 'DataSource$eventBridgeConfig' => 'Amazon EventBridge settings.
', 'UpdateDataSourceRequest$eventBridgeConfig' => 'The new Amazon EventBridge settings.
', ], ], 'FieldLogLevel' => [ 'base' => NULL, 'refs' => [ 'LogConfig$fieldLogLevel' => 'The field logging level. Values can be NONE, ERROR, or ALL.
NONE: No field-level logs are captured.
ERROR: Logs the following information only for the fields that are in error:
The error section in the server response.
Field-level errors.
The generated request/response functions that got resolved for error fields.
ALL: The following information is logged for all fields in the query:
Field-level tracing information.
The generated request/response functions that got resolved for each field.
Represents the input of a FlushApiCache
operation.
Represents the output of a FlushApiCache
operation.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
', 'refs' => [ 'CreateFunctionResponse$functionConfiguration' => 'The Function
object.
The Function
object.
The Function
object.
A list of Function
objects.
A list of Function
objects.
Represents the input of a GetApiCache
operation.
Represents the output of a GetApiCache
operation.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).
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.
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.
The GraphQL schema is not valid.
', 'refs' => [], ], 'GraphqlApi' => [ 'base' => 'Describes a GraphQL API.
', 'refs' => [ 'CreateGraphqlApiResponse$graphqlApi' => 'The GraphqlApi
.
The GraphqlApi
object.
The updated GraphqlApi
object.
The GraphqlApi
objects.
Describes an HTTP data source configuration.
', 'refs' => [ 'CreateDataSourceRequest$httpConfig' => 'HTTP endpoint settings.
', 'DataSource$httpConfig' => 'HTTP endpoint settings.
', 'UpdateDataSourceRequest$httpConfig' => 'The new HTTP endpoint configuration.
', ], ], 'InternalFailureException' => [ 'base' => 'An internal AppSync error occurred. Try your request again.
', 'refs' => [], ], 'LambdaAuthorizerConfig' => [ 'base' => 'A LambdaAuthorizerConfig
specifies how to authorize AppSync API access when using the AWS_LAMBDA
authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a time.
Configuration for Lambda function authorization.
', 'CreateGraphqlApiRequest$lambdaAuthorizerConfig' => 'Configuration for Lambda function authorization.
', 'GraphqlApi$lambdaAuthorizerConfig' => 'Configuration for Lambda function authorization.
', 'UpdateGraphqlApiRequest$lambdaAuthorizerConfig' => 'Configuration for Lambda function authorization.
', ], ], 'LambdaConflictHandlerConfig' => [ 'base' => 'The LambdaConflictHandlerConfig
object when configuring LAMBDA
as the Conflict Handler.
The LambdaConflictHandlerConfig
when configuring LAMBDA
as the Conflict Handler.
Describes an Lambda data source configuration.
', 'refs' => [ 'CreateDataSourceRequest$lambdaConfig' => 'Lambda settings.
', 'DataSource$lambdaConfig' => 'Lambda settings.
', 'UpdateDataSourceRequest$lambdaConfig' => 'The new Lambda configuration.
', ], ], 'LimitExceededException' => [ 'base' => 'The request exceeded a limit. Try your request again.
', 'refs' => [], ], 'ListApiKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApiKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainNamesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainNamesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFunctionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGraphqlApisRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGraphqlApisResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolversByFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolversByFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResolversRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResolversResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSourceApiAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSourceApiAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTypesByAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTypesByAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTypesResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogConfig' => [ 'base' => 'The Amazon CloudWatch Logs configuration.
', 'refs' => [ 'CreateGraphqlApiRequest$logConfig' => 'The Amazon CloudWatch Logs configuration.
', 'GraphqlApi$logConfig' => 'The Amazon CloudWatch Logs configuration.
', 'UpdateGraphqlApiRequest$logConfig' => 'The Amazon CloudWatch Logs configuration for the GraphqlApi
object.
A list of logs that were generated by calls to util.log.info
and util.log.error
in the evaluated code.
A list of logs that were generated by calls to util.log.info
and util.log.error
in the evaluated code.
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
', 'ApiKey$expires' => 'The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
', 'ApiKey$deletes' => 'The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.
', 'CachingConfig$ttl' => 'The TTL in seconds for a resolver that has caching activated.
Valid values are 1–3,600 seconds.
', 'CreateApiCacheRequest$ttl' => 'TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
', 'CreateApiKeyRequest$expires' => '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 .
', 'DeltaSyncConfig$baseTableTTL' => 'The number of minutes that an Item is stored in the data source.
', 'DeltaSyncConfig$deltaSyncTableTTL' => 'The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
', 'OpenIDConnectConfig$iatTTL' => 'The number of milliseconds that a token is valid after it\'s issued to a user.
', 'OpenIDConnectConfig$authTTL' => 'The number of milliseconds that a token is valid after being authenticated.
', 'UpdateApiCacheRequest$ttl' => 'TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
', 'UpdateApiKeyRequest$expires' => '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 .
', ], ], 'MapOfStringToString' => [ 'base' => NULL, 'refs' => [ 'GraphqlApi$uris' => 'The URIs.
', 'GraphqlApi$dns' => 'The DNS records for the API.
', ], ], 'MappingTemplate' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$requestMappingTemplate' => 'The Function
request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
The Function
response mapping template.
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.
', 'CreateResolverRequest$responseMappingTemplate' => 'The mapping template to use for responses from the data source.
', 'FunctionConfiguration$requestMappingTemplate' => 'The Function
request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
The Function
response mapping template.
The request mapping template.
', 'Resolver$responseMappingTemplate' => 'The response mapping template.
', 'UpdateFunctionRequest$requestMappingTemplate' => 'The Function
request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
The Function
request mapping template.
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.
', 'UpdateResolverRequest$responseMappingTemplate' => 'The new response mapping template.
', ], ], 'MaxBatchSize' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$maxBatchSize' => 'The maximum batching size for a resolver.
', 'CreateResolverRequest$maxBatchSize' => 'The maximum batching size for a resolver.
', 'FunctionConfiguration$maxBatchSize' => 'The maximum batching size for a resolver.
', 'Resolver$maxBatchSize' => 'The maximum batching size for a resolver.
', 'UpdateFunctionRequest$maxBatchSize' => 'The maximum batching size for a resolver.
', 'UpdateResolverRequest$maxBatchSize' => 'The maximum batching size for a resolver.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListApiKeysRequest$maxResults' => 'The maximum number of results that you want the request to return.
', 'ListDataSourcesRequest$maxResults' => 'The maximum number of results that you want the request to return.
', 'ListDomainNamesRequest$maxResults' => 'The maximum number of results that you want the request to return.
', 'ListFunctionsRequest$maxResults' => 'The maximum number of results that you want the request to return.
', 'ListGraphqlApisRequest$maxResults' => 'The maximum number of results that you want the request to return.
', 'ListResolversByFunctionRequest$maxResults' => 'The maximum number of results that you want the request to return.
', 'ListResolversRequest$maxResults' => 'The maximum number of results that you want the request to return.
', 'ListSourceApiAssociationsRequest$maxResults' => 'The maximum number of results that you want the request to return.
', 'ListTypesByAssociationRequest$maxResults' => 'The maximum number of results that you want the request to return.
', 'ListTypesRequest$maxResults' => 'The maximum number of results that you want the request to return.
', ], ], 'MergeType' => [ 'base' => NULL, 'refs' => [ 'SourceApiAssociationConfig$mergeType' => 'The property that indicates which merging option is enabled in the source API association.
Valid merge types are MANUAL_MERGE
(default) and AUTO_MERGE
. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn
to perform merge operations.
The resource specified in the request was not found. Check the resource, and then try again.
', 'refs' => [], ], 'OpenIDConnectConfig' => [ 'base' => 'Describes an OpenID Connect (OIDC) configuration.
', 'refs' => [ 'AdditionalAuthenticationProvider$openIDConnectConfig' => 'The OIDC configuration.
', 'CreateGraphqlApiRequest$openIDConnectConfig' => 'The OIDC configuration.
', 'GraphqlApi$openIDConnectConfig' => 'The OpenID Connect configuration.
', 'UpdateGraphqlApiRequest$openIDConnectConfig' => 'The OpenID Connect configuration for the GraphqlApi
object.
Describes an OpenSearch data source configuration.
', 'refs' => [ 'CreateDataSourceRequest$openSearchServiceConfig' => 'Amazon OpenSearch Service settings.
', 'DataSource$openSearchServiceConfig' => 'Amazon OpenSearch Service settings.
', 'UpdateDataSourceRequest$openSearchServiceConfig' => 'The new OpenSearch configuration.
', ], ], 'OutputType' => [ 'base' => NULL, 'refs' => [ 'GetIntrospectionSchemaRequest$format' => 'The schema format: SDL or JSON.
', ], ], 'Ownership' => [ 'base' => NULL, 'refs' => [ 'ListGraphqlApisRequest$owner' => 'The account owner of the GraphQL API.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListApiKeysRequest$nextToken' => '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.
', 'ListApiKeysResponse$nextToken' => 'An identifier to pass in the next request to this operation to return the next set of items in the list.
', 'ListDataSourcesRequest$nextToken' => '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.
', 'ListDataSourcesResponse$nextToken' => 'An identifier to pass in the next request to this operation to return the next set of items in the list.
', 'ListDomainNamesRequest$nextToken' => '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.
', 'ListDomainNamesResponse$nextToken' => '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.
', 'ListFunctionsRequest$nextToken' => '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.
', 'ListFunctionsResponse$nextToken' => '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.
', 'ListGraphqlApisRequest$nextToken' => '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.
', 'ListGraphqlApisResponse$nextToken' => 'An identifier to pass in the next request to this operation to return the next set of items in the list.
', 'ListResolversByFunctionRequest$nextToken' => '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.
', 'ListResolversByFunctionResponse$nextToken' => 'An identifier that you can use to return the next set of items in the list.
', 'ListResolversRequest$nextToken' => '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.
', 'ListResolversResponse$nextToken' => 'An identifier to pass in the next request to this operation to return the next set of items in the list.
', 'ListSourceApiAssociationsRequest$nextToken' => '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.
', 'ListSourceApiAssociationsResponse$nextToken' => '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.
', 'ListTypesByAssociationRequest$nextToken' => '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.
', 'ListTypesByAssociationResponse$nextToken' => '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.
', 'ListTypesRequest$nextToken' => '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.
', 'ListTypesResponse$nextToken' => 'An identifier to pass in the next request to this operation to return the next set of items in the list.
', ], ], 'PipelineConfig' => [ 'base' => 'The pipeline configuration for a resolver of kind PIPELINE
.
The PipelineConfig
.
The PipelineConfig
.
The PipelineConfig
.
The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.
', 'refs' => [ 'RelationalDatabaseDataSourceConfig$rdsHttpEndpointConfig' => 'Amazon RDS HTTP endpoint settings.
', ], ], 'RelationalDatabaseDataSourceConfig' => [ 'base' => 'Describes a relational database data source configuration.
', 'refs' => [ 'CreateDataSourceRequest$relationalDatabaseConfig' => 'Relational database settings.
', 'DataSource$relationalDatabaseConfig' => 'Relational database settings.
', 'UpdateDataSourceRequest$relationalDatabaseConfig' => 'The new relational database configuration.
', ], ], 'RelationalDatabaseSourceType' => [ 'base' => NULL, 'refs' => [ 'RelationalDatabaseDataSourceConfig$relationalDatabaseSourceType' => 'Source type for the relational database.
RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
Describes a resolver.
', 'refs' => [ 'CreateResolverResponse$resolver' => 'The Resolver
object.
The Resolver
object.
The updated Resolver
object.
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.
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.
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.
The list of resolvers.
', 'ListResolversResponse$resolvers' => 'The Resolver
objects.
The GraphqlApi
Amazon Resource Name (ARN).
The GraphqlApi
Amazon Resource Name (ARN).
The GraphqlApi
Amazon Resource Name (ARN).
A user-supplied name for the DataSource
.
The Function
name. The function name does not have to be unique.
The Function
DataSource
name.
The name of the Type
.
The name of the field to attach the resolver to.
', 'CreateResolverRequest$dataSourceName' => 'The name of the data source for which the resolver is being created.
', 'DataSource$name' => 'The name of the data source.
', 'DeleteDataSourceRequest$name' => 'The name of the data source.
', 'DeleteFunctionRequest$functionId' => 'The Function
ID.
The name of the resolver type.
', 'DeleteResolverRequest$fieldName' => 'The resolver field name.
', 'DeleteTypeRequest$typeName' => 'The type name.
', 'FunctionConfiguration$name' => 'The name of the Function
object.
The name of the DataSource
.
The name of the data source.
', 'GetFunctionRequest$functionId' => 'The Function
ID.
The resolver type name.
', 'GetResolverRequest$fieldName' => 'The resolver field name.
', 'GetTypeRequest$typeName' => 'The type name.
', 'GraphqlApi$name' => 'The API name.
', 'Resolver$typeName' => 'The resolver type name.
', 'Resolver$fieldName' => 'The resolver field name.
', 'Resolver$dataSourceName' => 'The resolver data source name.
', 'Type$name' => 'The type name.
', 'UpdateDataSourceRequest$name' => 'The new name for the data source.
', 'UpdateFunctionRequest$name' => 'The Function
name.
The function ID.
', 'UpdateFunctionRequest$dataSourceName' => 'The Function
DataSource
name.
The new type name.
', 'UpdateResolverRequest$fieldName' => 'The new field name.
', 'UpdateResolverRequest$dataSourceName' => 'The new data source name.
', 'UpdateTypeRequest$typeName' => 'The new type name.
', ], ], 'RuntimeName' => [ 'base' => NULL, 'refs' => [ 'AppSyncRuntime$name' => 'The name
of the runtime to use. Currently, the only allowed value is APPSYNC_JS
.
The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
', 'StartSchemaCreationResponse$status' => 'The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
', ], ], 'SourceApiAssociation' => [ 'base' => 'Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API. There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API\'s schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API.
Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access Manager. For more information about sharing resources from other accounts, see What is Amazon Web Services Resource Access Manager? in the Amazon Web Services Resource Access Manager guide.
', 'refs' => [ 'AssociateMergedGraphqlApiResponse$sourceApiAssociation' => 'The SourceApiAssociation
object data.
The SourceApiAssociation
object data.
The SourceApiAssociation
object data.
The SourceApiAssociation
object data.
Describes properties used to specify configurations related to a source API.
', 'refs' => [ 'AssociateMergedGraphqlApiRequest$sourceApiAssociationConfig' => 'The SourceApiAssociationConfig
object data.
The SourceApiAssociationConfig
object data.
The SourceApiAssociationConfig
object data.
The SourceApiAssociationConfig
object data.
The state of the source API association.
', 'DisassociateSourceGraphqlApiResponse$sourceApiAssociationStatus' => 'The state of the source API association.
', 'SourceApiAssociation$sourceApiAssociationStatus' => 'The state of the source API association.
', 'StartSchemaMergeResponse$sourceApiAssociationStatus' => 'The state of the source API association.
', ], ], 'SourceApiAssociationSummary' => [ 'base' => 'Describes the ARNs and IDs of associations, Merged APIs, and source APIs.
', 'refs' => [ 'SourceApiAssociationSummaryList$member' => NULL, ], ], 'SourceApiAssociationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListSourceApiAssociationsResponse$sourceApiAssociationSummaries' => 'The SourceApiAssociationSummary
object data.
The API ID.
', 'ApiAssociation$deploymentDetail' => 'Details about the last deployment status.
', 'ApiKey$id' => 'The API key ID.
', 'ApiKey$description' => 'A description of the purpose of the API key.
', 'ApiKeyLimitExceededException$message' => NULL, 'ApiKeyValidityOutOfBoundsException$message' => NULL, 'ApiLimitExceededException$message' => NULL, 'AppSyncRuntime$runtimeVersion' => 'The version
of the runtime to use. Currently, the only allowed version is 1.0.0
.
The API ID. Private APIs can not be associated with custom domains.
', 'AssociateMergedGraphqlApiRequest$sourceApiIdentifier' => '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.
', 'AssociateMergedGraphqlApiRequest$mergedApiIdentifier' => '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.
', 'AssociateMergedGraphqlApiRequest$description' => 'The description field.
', 'AssociateSourceGraphqlApiRequest$mergedApiIdentifier' => '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.
', 'AssociateSourceGraphqlApiRequest$sourceApiIdentifier' => '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.
', 'AssociateSourceGraphqlApiRequest$description' => 'The description field.
', 'AwsIamConfig$signingRegion' => 'The signing Amazon Web Services Region for IAM authorization.
', 'AwsIamConfig$signingServiceName' => 'The signing service name for IAM authorization.
', 'CachingKeys$member' => NULL, 'CodeError$errorType' => 'The type of code error.
Examples include, but aren\'t limited to: LINT_ERROR
, PARSER_ERROR
.
A user presentable error.
Examples include, but aren\'t limited to: Parsing error: Unterminated string literal
.
The user pool ID.
', 'CognitoUserPoolConfig$awsRegion' => 'The Amazon Web Services Region in which the user pool was created.
', 'CognitoUserPoolConfig$appIdClientRegex' => 'A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn\'t set, no filtering is applied.
', 'CreateApiCacheRequest$apiId' => 'The GraphQL API ID.
', 'CreateApiKeyRequest$apiId' => 'The ID for your GraphQL API.
', 'CreateApiKeyRequest$description' => 'A description of the purpose of the API key.
', 'CreateDataSourceRequest$apiId' => 'The API ID for the GraphQL API for the DataSource
.
A description of the DataSource
.
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.
', 'CreateFunctionRequest$apiId' => 'The GraphQL API ID.
', 'CreateFunctionRequest$description' => 'The Function
description.
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.
A user-supplied name for the GraphqlApi
.
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.
The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
', 'CreateResolverRequest$apiId' => 'The ID for the GraphQL API for which the resolver is being created.
', 'CreateTypeRequest$apiId' => 'The API ID.
', 'CreateTypeRequest$definition' => 'The type definition, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
', 'DataSource$dataSourceArn' => 'The data source Amazon Resource Name (ARN).
', 'DataSource$description' => 'The description of the data source.
', 'DataSource$serviceRoleArn' => '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.
', 'DeleteApiCacheRequest$apiId' => 'The API ID.
', 'DeleteApiKeyRequest$apiId' => 'The API ID.
', 'DeleteApiKeyRequest$id' => 'The ID for the API key.
', 'DeleteDataSourceRequest$apiId' => 'The API ID.
', 'DeleteFunctionRequest$apiId' => 'The GraphQL API ID.
', 'DeleteGraphqlApiRequest$apiId' => 'The API ID.
', 'DeleteResolverRequest$apiId' => 'The API ID.
', 'DeleteTypeRequest$apiId' => 'The API ID.
', 'DeltaSyncConfig$deltaSyncTableName' => 'The Delta Sync table name.
', 'DisassociateMergedGraphqlApiRequest$sourceApiIdentifier' => '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.
', 'DisassociateMergedGraphqlApiRequest$associationId' => 'The ID generated by the AppSync service for the source API association.
', 'DisassociateSourceGraphqlApiRequest$mergedApiIdentifier' => '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.
', 'DisassociateSourceGraphqlApiRequest$associationId' => 'The ID generated by the AppSync service for the source API association.
', 'DomainNameConfig$appsyncDomainName' => 'The domain name that AppSync provides.
', 'DomainNameConfig$hostedZoneId' => 'The ID of your Amazon Route 53 hosted zone.
', 'DynamodbDataSourceConfig$tableName' => 'The table name.
', 'DynamodbDataSourceConfig$awsRegion' => 'The Amazon Web Services Region.
', 'ElasticsearchDataSourceConfig$endpoint' => 'The endpoint.
', 'ElasticsearchDataSourceConfig$awsRegion' => 'The Amazon Web Services Region.
', 'EvaluateCodeRequest$function' => 'The function within the code to be evaluated. If provided, the valid values are request
and response
.
The ARN of the event bus. For more information about event buses, see Amazon EventBridge event buses.
', 'FlushApiCacheRequest$apiId' => 'The API ID.
', 'FunctionConfiguration$functionId' => 'A unique ID representing the Function
object.
The Amazon Resource Name (ARN) of the Function
object.
The Function
description.
The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
', 'FunctionsIds$member' => NULL, 'GetApiCacheRequest$apiId' => 'The API ID.
', 'GetDataSourceRequest$apiId' => 'The API ID.
', 'GetFunctionRequest$apiId' => 'The GraphQL API ID.
', 'GetGraphqlApiRequest$apiId' => 'The API ID for the GraphQL API.
', 'GetIntrospectionSchemaRequest$apiId' => 'The API ID.
', 'GetResolverRequest$apiId' => 'The API ID.
', 'GetSchemaCreationStatusRequest$apiId' => 'The API ID.
', 'GetSchemaCreationStatusResponse$details' => 'Detailed information about the status of the schema creation operation.
', 'GetSourceApiAssociationRequest$mergedApiIdentifier' => '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.
', 'GetSourceApiAssociationRequest$associationId' => 'The ID generated by the AppSync service for the source API association.
', 'GetTypeRequest$apiId' => 'The API ID.
', 'GraphqlApi$apiId' => 'The API ID.
', 'GraphqlApi$arn' => 'The Amazon Resource Name (ARN).
', 'GraphqlApi$wafWebAclArn' => 'The ARN of the WAF access control list (ACL) associated with this GraphqlApi
, if one exists.
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.
The account owner of the GraphQL API.
', 'GraphqlApi$ownerContact' => 'The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
', 'HttpDataSourceConfig$endpoint' => 'The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don\'t specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
', 'InternalFailureException$message' => NULL, 'LambdaAuthorizerConfig$authorizerUri' => 'The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3
), or an alias ARN.
Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:
aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
A regular expression for validation of tokens before the Lambda function is called.
', 'LambdaConflictHandlerConfig$lambdaConflictHandlerArn' => 'The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
', 'LambdaDataSourceConfig$lambdaFunctionArn' => 'The Amazon Resource Name (ARN) for the Lambda function.
', 'LimitExceededException$message' => NULL, 'ListApiKeysRequest$apiId' => 'The API ID.
', 'ListDataSourcesRequest$apiId' => 'The API ID.
', 'ListFunctionsRequest$apiId' => 'The GraphQL API ID.
', 'ListResolversByFunctionRequest$apiId' => 'The API ID.
', 'ListResolversByFunctionRequest$functionId' => 'The function ID.
', 'ListResolversRequest$apiId' => 'The API ID.
', 'ListResolversRequest$typeName' => 'The type name.
', 'ListSourceApiAssociationsRequest$apiId' => 'The API ID.
', 'ListTypesByAssociationRequest$mergedApiIdentifier' => '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.
', 'ListTypesByAssociationRequest$associationId' => 'The ID generated by the AppSync service for the source API association.
', 'ListTypesRequest$apiId' => 'The API ID.
', 'LogConfig$cloudWatchLogsRoleArn' => 'The service role that AppSync assumes to publish to CloudWatch logs in your account.
', 'Logs$member' => NULL, 'MapOfStringToString$key' => NULL, 'MapOfStringToString$value' => NULL, 'NotFoundException$message' => NULL, 'OpenIDConnectConfig$issuer' => 'The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss
in the ID token.
The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.
', 'OpenSearchServiceDataSourceConfig$endpoint' => 'The endpoint.
', 'OpenSearchServiceDataSourceConfig$awsRegion' => 'The Amazon Web Services Region.
', 'RdsHttpEndpointConfig$awsRegion' => 'Amazon Web Services Region for Amazon RDS HTTP endpoint.
', 'RdsHttpEndpointConfig$dbClusterIdentifier' => 'Amazon RDS cluster Amazon Resource Name (ARN).
', 'RdsHttpEndpointConfig$databaseName' => 'Logical database name.
', 'RdsHttpEndpointConfig$schema' => 'Logical schema name.
', 'RdsHttpEndpointConfig$awsSecretStoreArn' => 'Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.
', 'Resolver$resolverArn' => 'The resolver Amazon Resource Name (ARN).
', 'SourceApiAssociation$associationId' => 'The ID generated by the AppSync service for the source API association.
', 'SourceApiAssociation$associationArn' => 'The Amazon Resource Name (ARN) of the source API association.
', 'SourceApiAssociation$sourceApiId' => 'The ID of the AppSync source API.
', 'SourceApiAssociation$sourceApiArn' => 'The Amazon Resource Name (ARN) of the AppSync source API.
', 'SourceApiAssociation$mergedApiArn' => 'The Amazon Resource Name (ARN) of the AppSync Merged API.
', 'SourceApiAssociation$mergedApiId' => 'The ID of the AppSync Merged API.
', 'SourceApiAssociation$description' => 'The description field.
', 'SourceApiAssociation$sourceApiAssociationStatusDetail' => 'The detailed message related to the current state of the source API association.
', 'SourceApiAssociationSummary$associationId' => 'The ID generated by the AppSync service for the source API association.
', 'SourceApiAssociationSummary$associationArn' => 'The Amazon Resource Name (ARN) of the source API association.
', 'SourceApiAssociationSummary$sourceApiId' => 'The ID of the AppSync source API.
', 'SourceApiAssociationSummary$sourceApiArn' => 'The Amazon Resource Name (ARN) of the AppSync Source API.
', 'SourceApiAssociationSummary$mergedApiId' => 'The ID of the AppSync Merged API.
', 'SourceApiAssociationSummary$mergedApiArn' => 'The Amazon Resource Name (ARN) of the AppSync Merged API.
', 'SourceApiAssociationSummary$description' => 'The description field.
', 'StartSchemaCreationRequest$apiId' => 'The API ID.
', 'StartSchemaMergeRequest$associationId' => 'The ID generated by the AppSync service for the source API association.
', 'StartSchemaMergeRequest$mergedApiIdentifier' => '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.
', 'Type$description' => 'The type description.
', 'Type$arn' => 'The type Amazon Resource Name (ARN).
', 'Type$definition' => 'The type definition.
', 'UnauthorizedException$message' => NULL, 'UpdateApiCacheRequest$apiId' => 'The GraphQL API ID.
', 'UpdateApiKeyRequest$apiId' => 'The ID for the GraphQL API.
', 'UpdateApiKeyRequest$id' => 'The API key ID.
', 'UpdateApiKeyRequest$description' => 'A description of the purpose of the API key.
', 'UpdateDataSourceRequest$apiId' => 'The API ID.
', 'UpdateDataSourceRequest$description' => 'The new description for the data source.
', 'UpdateDataSourceRequest$serviceRoleArn' => 'The new service role Amazon Resource Name (ARN) for the data source.
', 'UpdateFunctionRequest$apiId' => 'The GraphQL API ID.
', 'UpdateFunctionRequest$description' => 'The Function
description.
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.
The API ID.
', 'UpdateGraphqlApiRequest$name' => 'The new name for the GraphqlApi
object.
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.
The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
', 'UpdateResolverRequest$apiId' => 'The API ID.
', 'UpdateSourceApiAssociationRequest$associationId' => 'The ID generated by the AppSync service for the source API association.
', 'UpdateSourceApiAssociationRequest$mergedApiIdentifier' => '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.
', 'UpdateSourceApiAssociationRequest$description' => 'The description field.
', 'UpdateTypeRequest$apiId' => 'The API ID.
', 'UpdateTypeRequest$definition' => 'The new definition.
', 'UserPoolConfig$userPoolId' => 'The user pool ID.
', 'UserPoolConfig$awsRegion' => 'The Amazon Web Services Region in which the user pool was created.
', 'UserPoolConfig$appIdClientRegex' => 'A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn\'t set, no filtering is applied.
', ], ], 'SyncConfig' => [ 'base' => 'Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
', 'refs' => [ 'CreateFunctionRequest$syncConfig' => NULL, 'CreateResolverRequest$syncConfig' => 'The SyncConfig
for a resolver attached to a versioned data source.
The SyncConfig
for a resolver attached to a versioned data source.
The SyncConfig
for a resolver attached to a versioned data source.
The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don\'t specify a value for authorizerResultTtlInSeconds
, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride
key in its response.
The key for the tag.
', 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'A list of TagKey
objects.
A map with keys of TagKey
objects and values of TagValue
objects.
A TagMap
object.
The tags.
', 'ListTagsForResourceResponse$tags' => 'A TagMap
object.
A TagMap
object.
The value for the tag.
', 'refs' => [ 'TagMap$value' => NULL, ], ], 'Template' => [ 'base' => NULL, 'refs' => [ 'EvaluateMappingTemplateRequest$template' => 'The mapping template; this can be a request or response template. A template
is required for this action.
Describes a type.
', 'refs' => [ 'CreateTypeResponse$type' => 'The Type
object.
The Type
object.
The updated Type
object.
The type format: SDL or JSON.
', 'GetTypeRequest$format' => 'The type format: SDL or JSON.
', 'ListTypesByAssociationRequest$format' => 'The format type.
', 'ListTypesRequest$format' => 'The type format: SDL or JSON.
', 'Type$format' => 'The type format: SDL or JSON.
', 'UpdateTypeRequest$format' => 'The new type format: SDL or JSON.
', ], ], 'TypeList' => [ 'base' => NULL, 'refs' => [ 'ListTypesByAssociationResponse$types' => 'The Type
objects.
The Type
objects.
You aren\'t authorized to perform this operation.
', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApiCacheRequest' => [ 'base' => 'Represents the input of a UpdateApiCache
operation.
Represents the output of a UpdateApiCache
operation.
Describes an Amazon Cognito user pool configuration.
', 'refs' => [ 'CreateGraphqlApiRequest$userPoolConfig' => 'The Amazon Cognito user pool configuration.
', 'GraphqlApi$userPoolConfig' => 'The Amazon Cognito user pool configuration.
', 'UpdateGraphqlApiRequest$userPoolConfig' => 'The new Amazon Cognito user pool configuration for the ~GraphqlApi
object.