AWS AppSync 2017-07-25
- Client: Aws\AppSync\AppSyncClient
- Service ID: appsync
- Version: 2017-07-25
This page describes the parameters and results for the operations of the AWS AppSync (2017-07-25), and shows how to use the Aws\AppSync\AppSyncClient object to call the described operations. This documentation is specific to the 2017-07-25 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociateApi ( array $params = [] )
- Maps an endpoint to your custom domain.
- AssociateMergedGraphqlApi ( array $params = [] )
- Creates an association between a Merged API and source API using the source API's identifier.
- AssociateSourceGraphqlApi ( array $params = [] )
- Creates an association between a Merged API and source API using the Merged API's identifier.
- CreateApi ( array $params = [] )
- Creates an Api object.
- CreateApiCache ( array $params = [] )
- Creates a cache for the GraphQL API.
- CreateApiKey ( array $params = [] )
- Creates a unique key that you can distribute to clients who invoke your API.
- CreateChannelNamespace ( array $params = [] )
- Creates a ChannelNamespace for an Api.
- CreateDataSource ( array $params = [] )
- Creates a DataSource object.
- CreateDomainName ( array $params = [] )
- Creates a custom DomainName object.
- CreateFunction ( array $params = [] )
- Creates a Function object.
- CreateGraphqlApi ( array $params = [] )
- Creates a GraphqlApi object.
- CreateResolver ( array $params = [] )
- Creates a Resolver object.
- CreateType ( array $params = [] )
- Creates a Type object.
- DeleteApi ( array $params = [] )
- Deletes an Api object
- DeleteApiCache ( array $params = [] )
- Deletes an ApiCache object.
- DeleteApiKey ( array $params = [] )
- Deletes an API key.
- DeleteChannelNamespace ( array $params = [] )
- Deletes a ChannelNamespace.
- DeleteDataSource ( array $params = [] )
- Deletes a DataSource object.
- DeleteDomainName ( array $params = [] )
- Deletes a custom DomainName object.
- DeleteFunction ( array $params = [] )
- Deletes a Function.
- DeleteGraphqlApi ( array $params = [] )
- Deletes a GraphqlApi object.
- DeleteResolver ( array $params = [] )
- Deletes a Resolver object.
- DeleteType ( array $params = [] )
- Deletes a Type object.
- DisassociateApi ( array $params = [] )
- Removes an ApiAssociation object from a custom domain.
- DisassociateMergedGraphqlApi ( array $params = [] )
- Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
- DisassociateSourceGraphqlApi ( array $params = [] )
- Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
- EvaluateCode ( array $params = [] )
- Evaluates the given code and returns the response.
- EvaluateMappingTemplate ( array $params = [] )
- Evaluates a given template and returns the response.
- FlushApiCache ( array $params = [] )
- Flushes an ApiCache object.
- GetApi ( array $params = [] )
- Retrieves an Api object.
- GetApiAssociation ( array $params = [] )
- Retrieves an ApiAssociation object.
- GetApiCache ( array $params = [] )
- Retrieves an ApiCache object.
- GetChannelNamespace ( array $params = [] )
- Retrieves the channel namespace for a specified Api.
- GetDataSource ( array $params = [] )
- Retrieves a DataSource object.
- GetDataSourceIntrospection ( array $params = [] )
- Retrieves the record of an existing introspection.
- GetDomainName ( array $params = [] )
- Retrieves a custom DomainName object.
- GetFunction ( array $params = [] )
- Get a Function.
- GetGraphqlApi ( array $params = [] )
- Retrieves a GraphqlApi object.
- GetGraphqlApiEnvironmentVariables ( array $params = [] )
- Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
- GetIntrospectionSchema ( array $params = [] )
- Retrieves the introspection schema for a GraphQL API.
- GetResolver ( array $params = [] )
- Retrieves a Resolver object.
- GetSchemaCreationStatus ( array $params = [] )
- Retrieves the current status of a schema creation operation.
- GetSourceApiAssociation ( array $params = [] )
- Retrieves a SourceApiAssociation object.
- GetType ( array $params = [] )
- Retrieves a Type object.
- ListApiKeys ( array $params = [] )
- Lists the API keys for a given API.
- ListApis ( array $params = [] )
- Lists the APIs in your AppSync account.
- ListChannelNamespaces ( array $params = [] )
- Lists the channel namespaces for a specified Api.
- ListDataSources ( array $params = [] )
- Lists the data sources for a given API.
- ListDomainNames ( array $params = [] )
- Lists multiple custom domain names.
- ListFunctions ( array $params = [] )
- List multiple functions.
- ListGraphqlApis ( array $params = [] )
- Lists your GraphQL APIs.
- ListResolvers ( array $params = [] )
- Lists the resolvers for a given API and type.
- ListResolversByFunction ( array $params = [] )
- List the resolvers that are associated with a specific function.
- ListSourceApiAssociations ( array $params = [] )
- Lists the SourceApiAssociationSummary data.
- ListTagsForResource ( array $params = [] )
- Lists the tags for a resource.
- ListTypes ( array $params = [] )
- Lists the types for a given API.
- ListTypesByAssociation ( array $params = [] )
- Lists Type objects by the source API association ID.
- PutGraphqlApiEnvironmentVariables ( array $params = [] )
- Creates a list of environmental variables in an API by its ID value.
- StartDataSourceIntrospection ( array $params = [] )
- Creates a new introspection.
- StartSchemaCreation ( array $params = [] )
- Adds a new schema to your GraphQL API.
- StartSchemaMerge ( array $params = [] )
- Initiates a merge operation.
- TagResource ( array $params = [] )
- Tags a resource with user-supplied tags.
- UntagResource ( array $params = [] )
- Untags a resource.
- UpdateApi ( array $params = [] )
- Updates an Api.
- UpdateApiCache ( array $params = [] )
- Updates the cache for the GraphQL API.
- UpdateApiKey ( array $params = [] )
- Updates an API key.
- UpdateChannelNamespace ( array $params = [] )
- Updates a ChannelNamespace associated with an Api.
- UpdateDataSource ( array $params = [] )
- Updates a DataSource object.
- UpdateDomainName ( array $params = [] )
- Updates a custom DomainName object.
- UpdateFunction ( array $params = [] )
- Updates a Function object.
- UpdateGraphqlApi ( array $params = [] )
- Updates a GraphqlApi object.
- UpdateResolver ( array $params = [] )
- Updates a Resolver object.
- UpdateSourceApiAssociation ( array $params = [] )
- Updates some of the configuration choices of a particular source API association.
- UpdateType ( array $params = [] )
- Updates a Type object.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListApiKeys
- ListApis
- ListChannelNamespaces
- ListDataSources
- ListDomainNames
- ListFunctions
- ListGraphqlApis
- ListResolvers
- ListResolversByFunction
- ListSourceApiAssociations
- ListTypes
- ListTypesByAssociation
Operations
AssociateApi
$result = $client->associateApi
([/* ... */]); $promise = $client->associateApiAsync
([/* ... */]);
Maps an endpoint to your custom domain.
Parameter Syntax
$result = $client->associateApi([ 'apiId' => '<string>', // REQUIRED 'domainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID. Private APIs can not be associated with custom domains.
- domainName
-
- Required: Yes
- Type: string
The domain name.
Result Syntax
[ 'apiAssociation' => [ 'apiId' => '<string>', 'associationStatus' => 'PROCESSING|FAILED|SUCCESS', 'deploymentDetail' => '<string>', 'domainName' => '<string>', ], ]
Result Details
Members
- apiAssociation
-
- Type: ApiAssociation structure
The
ApiAssociation
object.
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
AssociateMergedGraphqlApi
$result = $client->associateMergedGraphqlApi
([/* ... */]); $promise = $client->associateMergedGraphqlApiAsync
([/* ... */]);
Creates an association between a Merged API and source API using the source API's identifier.
Parameter Syntax
$result = $client->associateMergedGraphqlApi([ 'description' => '<string>', 'mergedApiIdentifier' => '<string>', // REQUIRED 'sourceApiAssociationConfig' => [ 'mergeType' => 'MANUAL_MERGE|AUTO_MERGE', ], 'sourceApiIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- description
-
- Type: string
The description field.
- mergedApiIdentifier
-
- Required: Yes
- Type: 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.
- sourceApiAssociationConfig
-
- Type: SourceApiAssociationConfig structure
The
SourceApiAssociationConfig
object data. - sourceApiIdentifier
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'sourceApiAssociation' => [ 'associationArn' => '<string>', 'associationId' => '<string>', 'description' => '<string>', 'lastSuccessfulMergeDate' => <DateTime>, 'mergedApiArn' => '<string>', 'mergedApiId' => '<string>', 'sourceApiArn' => '<string>', 'sourceApiAssociationConfig' => [ 'mergeType' => 'MANUAL_MERGE|AUTO_MERGE', ], 'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED', 'sourceApiAssociationStatusDetail' => '<string>', 'sourceApiId' => '<string>', ], ]
Result Details
Members
- sourceApiAssociation
-
- Type: SourceApiAssociation structure
The
SourceApiAssociation
object data.
Errors
- UnauthorizedException:
You aren't authorized to perform this operation.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- LimitExceededException:
The request exceeded a limit. Try your request again.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
AssociateSourceGraphqlApi
$result = $client->associateSourceGraphqlApi
([/* ... */]); $promise = $client->associateSourceGraphqlApiAsync
([/* ... */]);
Creates an association between a Merged API and source API using the Merged API's identifier.
Parameter Syntax
$result = $client->associateSourceGraphqlApi([ 'description' => '<string>', 'mergedApiIdentifier' => '<string>', // REQUIRED 'sourceApiAssociationConfig' => [ 'mergeType' => 'MANUAL_MERGE|AUTO_MERGE', ], 'sourceApiIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- description
-
- Type: string
The description field.
- mergedApiIdentifier
-
- Required: Yes
- Type: 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.
- sourceApiAssociationConfig
-
- Type: SourceApiAssociationConfig structure
The
SourceApiAssociationConfig
object data. - sourceApiIdentifier
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'sourceApiAssociation' => [ 'associationArn' => '<string>', 'associationId' => '<string>', 'description' => '<string>', 'lastSuccessfulMergeDate' => <DateTime>, 'mergedApiArn' => '<string>', 'mergedApiId' => '<string>', 'sourceApiArn' => '<string>', 'sourceApiAssociationConfig' => [ 'mergeType' => 'MANUAL_MERGE|AUTO_MERGE', ], 'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED', 'sourceApiAssociationStatusDetail' => '<string>', 'sourceApiId' => '<string>', ], ]
Result Details
Members
- sourceApiAssociation
-
- Type: SourceApiAssociation structure
The
SourceApiAssociation
object data.
Errors
- UnauthorizedException:
You aren't authorized to perform this operation.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- LimitExceededException:
The request exceeded a limit. Try your request again.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
CreateApi
$result = $client->createApi
([/* ... */]); $promise = $client->createApiAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createApi([ 'eventConfig' => [ 'authProviders' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED 'cognitoConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', // REQUIRED 'userPoolId' => '<string>', // REQUIRED ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', // REQUIRED 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', // REQUIRED ], ], // ... ], 'connectionAuthModes' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], 'defaultPublishAuthModes' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], 'defaultSubscribeAuthModes' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', // REQUIRED 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED ], ], 'name' => '<string>', // REQUIRED 'ownerContact' => '<string>', 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- eventConfig
-
- Type: EventConfig structure
The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.
- name
-
- Required: Yes
- Type: string
The name for the
Api
. - ownerContact
-
- Type: string
The owner contact information for the
Api
. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A map with keys of
TagKey
objects and values ofTagValue
objects.
Result Syntax
[ 'api' => [ 'apiArn' => '<string>', 'apiId' => '<string>', 'created' => <DateTime>, 'dns' => ['<string>', ...], 'eventConfig' => [ 'authProviders' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'cognitoConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'userPoolId' => '<string>', ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], ], // ... ], 'connectionAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'defaultPublishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'defaultSubscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], ], 'name' => '<string>', 'ownerContact' => '<string>', 'tags' => ['<string>', ...], 'wafWebAclArn' => '<string>', 'xrayEnabled' => true || false, ], ]
Result Details
Members
- api
-
- Type: Api structure
The
Api
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource.
CreateApiCache
$result = $client->createApiCache
([/* ... */]); $promise = $client->createApiCacheAsync
([/* ... */]);
Creates a cache for the GraphQL API.
Parameter Syntax
$result = $client->createApiCache([ 'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING', // REQUIRED 'apiId' => '<string>', // REQUIRED 'atRestEncryptionEnabled' => true || false, 'healthMetricsConfig' => 'ENABLED|DISABLED', 'transitEncryptionEnabled' => true || false, 'ttl' => <integer>, // REQUIRED 'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X', // REQUIRED ]);
Parameter Details
Members
- apiCachingBehavior
-
- Required: Yes
- Type: string
Caching behavior.
-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
- apiId
-
- Required: Yes
- Type: string
The GraphQL API ID.
- atRestEncryptionEnabled
-
- Type: boolean
At-rest encryption flag for cache. You cannot update this setting after creation.
- healthMetricsConfig
-
- Type: string
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
orDISABLED
. - transitEncryptionEnabled
-
- Type: boolean
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
- ttl
-
- Required: Yes
- Type: long (int|float)
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
- type
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'apiCache' => [ 'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING', 'atRestEncryptionEnabled' => true || false, 'healthMetricsConfig' => 'ENABLED|DISABLED', 'status' => 'AVAILABLE|CREATING|DELETING|MODIFYING|FAILED', 'transitEncryptionEnabled' => true || false, 'ttl' => <integer>, 'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X', ], ]
Result Details
Members
- apiCache
-
- Type: ApiCache structure
The
ApiCache
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
CreateApiKey
$result = $client->createApiKey
([/* ... */]); $promise = $client->createApiKeyAsync
([/* ... */]);
Creates a unique key that you can distribute to clients who invoke your API.
Parameter Syntax
$result = $client->createApiKey([ 'apiId' => '<string>', // REQUIRED 'description' => '<string>', 'expires' => <integer>, ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The ID for your GraphQL API.
- description
-
- Type: string
A description of the purpose of the API key.
- expires
-
- Type: long (int|float)
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 .
Result Syntax
[ 'apiKey' => [ 'deletes' => <integer>, 'description' => '<string>', 'expires' => <integer>, 'id' => '<string>', ], ]
Result Details
Members
- apiKey
-
- Type: ApiKey structure
The API key.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- LimitExceededException:
The request exceeded a limit. Try your request again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- LimitExceededException:
The request exceeded a limit. Try your request again.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- ApiKeyLimitExceededException:
The API key exceeded a limit. Try your request again.
- ApiKeyValidityOutOfBoundsException:
The API key expiration must be set to a value between 1 and 365 days from creation (for
CreateApiKey
) or from update (forUpdateApiKey
).
CreateChannelNamespace
$result = $client->createChannelNamespace
([/* ... */]); $promise = $client->createChannelNamespaceAsync
([/* ... */]);
Creates a ChannelNamespace
for an Api
.
Parameter Syntax
$result = $client->createChannelNamespace([ 'apiId' => '<string>', // REQUIRED 'codeHandlers' => '<string>', 'name' => '<string>', // REQUIRED 'publishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], 'subscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The
Api
ID. - codeHandlers
-
- Type: string
The event handler functions that run custom business logic to process published events and subscribe requests.
- name
-
- Required: Yes
- Type: string
The name of the
ChannelNamespace
. This name must be unique within theApi
- publishAuthModes
-
- Type: Array of AuthMode structures
The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default
Api
authorization configuration. - subscribeAuthModes
-
- Type: Array of AuthMode structures
The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default
Api
authorization configuration. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A map with keys of
TagKey
objects and values ofTagValue
objects.
Result Syntax
[ 'channelNamespace' => [ 'apiId' => '<string>', 'channelNamespaceArn' => '<string>', 'codeHandlers' => '<string>', 'created' => <DateTime>, 'lastModified' => <DateTime>, 'name' => '<string>', 'publishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'subscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'tags' => ['<string>', ...], ], ]
Result Details
Members
- channelNamespace
-
- Type: ChannelNamespace structure
The
ChannelNamespace
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- ConflictException:
A conflict with a previous successful update is detected. This typically occurs when the previous update did not have time to propagate before the next update was made. A retry (with appropriate backoff logic) is the recommended response to this exception.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- ServiceQuotaExceededException:
The operation exceeded the service quota for this resource.
CreateDataSource
$result = $client->createDataSource
([/* ... */]); $promise = $client->createDataSourceAsync
([/* ... */]);
Creates a DataSource
object.
Parameter Syntax
$result = $client->createDataSource([ 'apiId' => '<string>', // REQUIRED 'description' => '<string>', 'dynamodbConfig' => [ 'awsRegion' => '<string>', // REQUIRED 'deltaSyncConfig' => [ 'baseTableTTL' => <integer>, 'deltaSyncTableName' => '<string>', 'deltaSyncTableTTL' => <integer>, ], 'tableName' => '<string>', // REQUIRED 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '<string>', // REQUIRED 'endpoint' => '<string>', // REQUIRED ], 'eventBridgeConfig' => [ 'eventBusArn' => '<string>', // REQUIRED ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', // REQUIRED 'awsIamConfig' => [ 'signingRegion' => '<string>', 'signingServiceName' => '<string>', ], ], 'endpoint' => '<string>', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '<string>', // REQUIRED ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '<string>', // REQUIRED 'openSearchServiceConfig' => [ 'awsRegion' => '<string>', // REQUIRED 'endpoint' => '<string>', // REQUIRED ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '<string>', 'awsSecretStoreArn' => '<string>', 'databaseName' => '<string>', 'dbClusterIdentifier' => '<string>', 'schema' => '<string>', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '<string>', 'type' => 'AWS_LAMBDA|AMAZON_DYNAMODB|AMAZON_ELASTICSEARCH|NONE|HTTP|RELATIONAL_DATABASE|AMAZON_OPENSEARCH_SERVICE|AMAZON_EVENTBRIDGE|AMAZON_BEDROCK_RUNTIME', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID for the GraphQL API for the
DataSource
. - description
-
- Type: string
A description of the
DataSource
. - dynamodbConfig
-
- Type: DynamodbDataSourceConfig structure
Amazon DynamoDB settings.
- elasticsearchConfig
-
- Type: ElasticsearchDataSourceConfig structure
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.
- eventBridgeConfig
-
- Type: EventBridgeDataSourceConfig structure
Amazon EventBridge settings.
- httpConfig
-
- Type: HttpDataSourceConfig structure
HTTP endpoint settings.
- lambdaConfig
-
- Type: LambdaDataSourceConfig structure
Lambda settings.
- metricsConfig
-
- Type: string
Enables or disables enhanced data source metrics for specified data sources. Note that
metricsConfig
won't be used unless thedataSourceLevelMetricsBehavior
value is set toPER_DATA_SOURCE_METRICS
. If thedataSourceLevelMetricsBehavior
is set toFULL_REQUEST_DATA_SOURCE_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
. - name
-
- Required: Yes
- Type: string
A user-supplied name for the
DataSource
. - openSearchServiceConfig
-
- Type: OpenSearchServiceDataSourceConfig structure
Amazon OpenSearch Service settings.
- relationalDatabaseConfig
-
- Type: RelationalDatabaseDataSourceConfig structure
Relational database settings.
- serviceRoleArn
-
- Type: string
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.
- type
-
- Required: Yes
- Type: string
The type of the
DataSource
.
Result Syntax
[ 'dataSource' => [ 'dataSourceArn' => '<string>', 'description' => '<string>', 'dynamodbConfig' => [ 'awsRegion' => '<string>', 'deltaSyncConfig' => [ 'baseTableTTL' => <integer>, 'deltaSyncTableName' => '<string>', 'deltaSyncTableTTL' => <integer>, ], 'tableName' => '<string>', 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '<string>', 'endpoint' => '<string>', ], 'eventBridgeConfig' => [ 'eventBusArn' => '<string>', ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', 'awsIamConfig' => [ 'signingRegion' => '<string>', 'signingServiceName' => '<string>', ], ], 'endpoint' => '<string>', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '<string>', ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '<string>', 'openSearchServiceConfig' => [ 'awsRegion' => '<string>', 'endpoint' => '<string>', ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '<string>', 'awsSecretStoreArn' => '<string>', 'databaseName' => '<string>', 'dbClusterIdentifier' => '<string>', 'schema' => '<string>', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '<string>', 'type' => 'AWS_LAMBDA|AMAZON_DYNAMODB|AMAZON_ELASTICSEARCH|NONE|HTTP|RELATIONAL_DATABASE|AMAZON_OPENSEARCH_SERVICE|AMAZON_EVENTBRIDGE|AMAZON_BEDROCK_RUNTIME', ], ]
Result Details
Members
- dataSource
-
- Type: DataSource structure
The
DataSource
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
CreateDomainName
$result = $client->createDomainName
([/* ... */]); $promise = $client->createDomainNameAsync
([/* ... */]);
Creates a custom DomainName
object.
Parameter Syntax
$result = $client->createDomainName([ 'certificateArn' => '<string>', // REQUIRED 'description' => '<string>', 'domainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- certificateArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
- description
-
- Type: string
A description of the
DomainName
. - domainName
-
- Required: Yes
- Type: string
The domain name.
Result Syntax
[ 'domainNameConfig' => [ 'appsyncDomainName' => '<string>', 'certificateArn' => '<string>', 'description' => '<string>', 'domainName' => '<string>', 'hostedZoneId' => '<string>', ], ]
Result Details
Members
- domainNameConfig
-
- Type: DomainNameConfig structure
The configuration for the
DomainName
.
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
CreateFunction
$result = $client->createFunction
([/* ... */]); $promise = $client->createFunctionAsync
([/* ... */]);
Creates a Function
object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
Parameter Syntax
$result = $client->createFunction([ 'apiId' => '<string>', // REQUIRED 'code' => '<string>', 'dataSourceName' => '<string>', // REQUIRED 'description' => '<string>', 'functionVersion' => '<string>', 'maxBatchSize' => <integer>, 'name' => '<string>', // REQUIRED 'requestMappingTemplate' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '<string>', // REQUIRED ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The GraphQL API ID.
- code
-
- Type: string
The
function
code that contains the request and response functions. When code is used, theruntime
is required. Theruntime
value must beAPPSYNC_JS
. - dataSourceName
-
- Required: Yes
- Type: string
The
Function
DataSource
name. - description
-
- Type: string
The
Function
description. - functionVersion
-
- Type: string
The
version
of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, thefunctionVersion
is required. - maxBatchSize
-
- Type: int
The maximum batching size for a resolver.
- name
-
- Required: Yes
- Type: string
The
Function
name. The function name does not have to be unique. - requestMappingTemplate
-
- Type: string
The
Function
request mapping template. Functions support only the 2018-05-29 version of the request mapping template. - responseMappingTemplate
-
- Type: string
The
Function
response mapping template. - runtime
-
- Type: AppSyncRuntime structure
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.
- syncConfig
-
- Type: SyncConfig structure
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
Result Syntax
[ 'functionConfiguration' => [ 'code' => '<string>', 'dataSourceName' => '<string>', 'description' => '<string>', 'functionArn' => '<string>', 'functionId' => '<string>', 'functionVersion' => '<string>', 'maxBatchSize' => <integer>, 'name' => '<string>', 'requestMappingTemplate' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '<string>', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], ], ]
Result Details
Members
- functionConfiguration
-
- Type: FunctionConfiguration structure
The
Function
object.
Errors
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- BadRequestException:
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.
CreateGraphqlApi
$result = $client->createGraphqlApi
([/* ... */]); $promise = $client->createGraphqlApiAsync
([/* ... */]);
Creates a GraphqlApi
object.
Parameter Syntax
$result = $client->createGraphqlApi([ 'additionalAuthenticationProviders' => [ [ 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', // REQUIRED 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', // REQUIRED ], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', // REQUIRED 'userPoolId' => '<string>', // REQUIRED ], ], // ... ], 'apiType' => 'GRAPHQL|MERGED', 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED 'enhancedMetricsConfig' => [ 'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS', // REQUIRED 'operationLevelMetricsConfig' => 'ENABLED|DISABLED', // REQUIRED 'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS', // REQUIRED ], 'introspectionConfig' => 'ENABLED|DISABLED', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', // REQUIRED 'identityValidationExpression' => '<string>', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', // REQUIRED 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED ], 'mergedApiExecutionRoleArn' => '<string>', 'name' => '<string>', // REQUIRED 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', // REQUIRED ], 'ownerContact' => '<string>', 'queryDepthLimit' => <integer>, 'resolverCountLimit' => <integer>, 'tags' => ['<string>', ...], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', // REQUIRED 'defaultAction' => 'ALLOW|DENY', // REQUIRED 'userPoolId' => '<string>', // REQUIRED ], 'visibility' => 'GLOBAL|PRIVATE', 'xrayEnabled' => true || false, ]);
Parameter Details
Members
- additionalAuthenticationProviders
-
- Type: Array of AdditionalAuthenticationProvider structures
A list of additional authentication providers for the
GraphqlApi
API. - apiType
-
- Type: string
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL
) or merged API (MERGED
). - authenticationType
-
- Required: Yes
- Type: string
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
- enhancedMetricsConfig
-
- Type: EnhancedMetricsConfig structure
The
enhancedMetricsConfig
object. - introspectionConfig
-
- Type: string
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 toENABLED
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.
- lambdaAuthorizerConfig
-
- Type: LambdaAuthorizerConfig structure
Configuration for Lambda function authorization.
- logConfig
-
- Type: LogConfig structure
The Amazon CloudWatch Logs configuration.
- mergedApiExecutionRoleArn
-
- Type: string
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. - name
-
- Required: Yes
- Type: string
A user-supplied name for the
GraphqlApi
. - openIDConnectConfig
-
- Type: OpenIDConnectConfig structure
The OIDC configuration.
- ownerContact
-
- Type: string
The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
- queryDepthLimit
-
- Type: int
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 between1
and75
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.
- resolverCountLimit
-
- Type: int
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 to10000
. When specified, the limit value can be between1
and10000
. This field will produce a limit error if the operation falls out of bounds. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A
TagMap
object. - userPoolConfig
-
- Type: UserPoolConfig structure
The Amazon Cognito user pool configuration.
- visibility
-
- Type: string
Sets the value of the GraphQL API to public (
GLOBAL
) or private (PRIVATE
). If no value is provided, the visibility will be set toGLOBAL
by default. This value cannot be changed once the API has been created. - xrayEnabled
-
- Type: boolean
A flag indicating whether to use X-Ray tracing for the
GraphqlApi
.
Result Syntax
[ 'graphqlApi' => [ 'additionalAuthenticationProviders' => [ [ 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'userPoolId' => '<string>', ], ], // ... ], 'apiId' => '<string>', 'apiType' => 'GRAPHQL|MERGED', 'arn' => '<string>', 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'dns' => ['<string>', ...], 'enhancedMetricsConfig' => [ 'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS', 'operationLevelMetricsConfig' => 'ENABLED|DISABLED', 'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS', ], 'introspectionConfig' => 'ENABLED|DISABLED', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], 'mergedApiExecutionRoleArn' => '<string>', 'name' => '<string>', 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], 'owner' => '<string>', 'ownerContact' => '<string>', 'queryDepthLimit' => <integer>, 'resolverCountLimit' => <integer>, 'tags' => ['<string>', ...], 'uris' => ['<string>', ...], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'defaultAction' => 'ALLOW|DENY', 'userPoolId' => '<string>', ], 'visibility' => 'GLOBAL|PRIVATE', 'wafWebAclArn' => '<string>', 'xrayEnabled' => true || false, ], ]
Result Details
Members
- graphqlApi
-
- Type: GraphqlApi structure
The
GraphqlApi
.
Errors
- BadRequestException:
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.
- LimitExceededException:
The request exceeded a limit. Try your request again.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- ApiLimitExceededException:
The GraphQL API exceeded a limit. Try your request again.
CreateResolver
$result = $client->createResolver
([/* ... */]); $promise = $client->createResolverAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createResolver([ 'apiId' => '<string>', // REQUIRED 'cachingConfig' => [ 'cachingKeys' => ['<string>', ...], 'ttl' => <integer>, // REQUIRED ], 'code' => '<string>', 'dataSourceName' => '<string>', 'fieldName' => '<string>', // REQUIRED 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => <integer>, 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['<string>', ...], ], 'requestMappingTemplate' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '<string>', // REQUIRED ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The ID for the GraphQL API for which the resolver is being created.
- cachingConfig
-
- Type: CachingConfig structure
The caching configuration for the resolver.
- code
-
- Type: string
The
resolver
code that contains the request and response functions. When code is used, theruntime
is required. Theruntime
value must beAPPSYNC_JS
. - dataSourceName
-
- Type: string
The name of the data source for which the resolver is being created.
- fieldName
-
- Required: Yes
- Type: string
The name of the field to attach the resolver to.
- kind
-
- Type: 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.
- maxBatchSize
-
- Type: int
The maximum batching size for a resolver.
- metricsConfig
-
- Type: string
Enables or disables enhanced resolver metrics for specified resolvers. Note that
metricsConfig
won't be used unless theresolverLevelMetricsBehavior
value is set toPER_RESOLVER_METRICS
. If theresolverLevelMetricsBehavior
is set toFULL_REQUEST_RESOLVER_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
. - pipelineConfig
-
- Type: PipelineConfig structure
The
PipelineConfig
. - requestMappingTemplate
-
- Type: string
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.
- responseMappingTemplate
-
- Type: string
The mapping template to use for responses from the data source.
- runtime
-
- Type: AppSyncRuntime structure
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.
- syncConfig
-
- Type: SyncConfig structure
The
SyncConfig
for a resolver attached to a versioned data source. - typeName
-
- Required: Yes
- Type: string
The name of the
Type
.
Result Syntax
[ 'resolver' => [ 'cachingConfig' => [ 'cachingKeys' => ['<string>', ...], 'ttl' => <integer>, ], 'code' => '<string>', 'dataSourceName' => '<string>', 'fieldName' => '<string>', 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => <integer>, 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['<string>', ...], ], 'requestMappingTemplate' => '<string>', 'resolverArn' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '<string>', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], 'typeName' => '<string>', ], ]
Result Details
Members
- resolver
-
- Type: Resolver structure
The
Resolver
object.
Errors
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- BadRequestException:
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.
CreateType
$result = $client->createType
([/* ... */]); $promise = $client->createTypeAsync
([/* ... */]);
Creates a Type
object.
Parameter Syntax
$result = $client->createType([ 'apiId' => '<string>', // REQUIRED 'definition' => '<string>', // REQUIRED 'format' => 'SDL|JSON', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- definition
-
- Required: Yes
- Type: string
The type definition, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
- format
-
- Required: Yes
- Type: string
The type format: SDL or JSON.
Result Syntax
[ 'type' => [ 'arn' => '<string>', 'definition' => '<string>', 'description' => '<string>', 'format' => 'SDL|JSON', 'name' => '<string>', ], ]
Result Details
Members
- type
-
- Type: Type structure
The
Type
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
DeleteApi
$result = $client->deleteApi
([/* ... */]); $promise = $client->deleteApiAsync
([/* ... */]);
Deletes an Api
object
Parameter Syntax
$result = $client->deleteApi([ 'apiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The
Api
ID.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
DeleteApiCache
$result = $client->deleteApiCache
([/* ... */]); $promise = $client->deleteApiCacheAsync
([/* ... */]);
Deletes an ApiCache
object.
Parameter Syntax
$result = $client->deleteApiCache([ 'apiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
DeleteApiKey
$result = $client->deleteApiKey
([/* ... */]); $promise = $client->deleteApiKeyAsync
([/* ... */]);
Deletes an API key.
Parameter Syntax
$result = $client->deleteApiKey([ 'apiId' => '<string>', // REQUIRED 'id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- id
-
- Required: Yes
- Type: string
The ID for the API key.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
DeleteChannelNamespace
$result = $client->deleteChannelNamespace
([/* ... */]); $promise = $client->deleteChannelNamespaceAsync
([/* ... */]);
Deletes a ChannelNamespace
.
Parameter Syntax
$result = $client->deleteChannelNamespace([ 'apiId' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The ID of the
Api
associated with theChannelNamespace
. - name
-
- Required: Yes
- Type: string
The name of the
ChannelNamespace
.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
DeleteDataSource
$result = $client->deleteDataSource
([/* ... */]); $promise = $client->deleteDataSourceAsync
([/* ... */]);
Deletes a DataSource
object.
Parameter Syntax
$result = $client->deleteDataSource([ 'apiId' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- name
-
- Required: Yes
- Type: string
The name of the data source.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
DeleteDomainName
$result = $client->deleteDomainName
([/* ... */]); $promise = $client->deleteDomainNameAsync
([/* ... */]);
Deletes a custom DomainName
object.
Parameter Syntax
$result = $client->deleteDomainName([ 'domainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- domainName
-
- Required: Yes
- Type: string
The domain name.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
DeleteFunction
$result = $client->deleteFunction
([/* ... */]); $promise = $client->deleteFunctionAsync
([/* ... */]);
Deletes a Function
.
Parameter Syntax
$result = $client->deleteFunction([ 'apiId' => '<string>', // REQUIRED 'functionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The GraphQL API ID.
- functionId
-
- Required: Yes
- Type: string
The
Function
ID.
Result Syntax
[]
Result Details
Errors
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- BadRequestException:
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.
DeleteGraphqlApi
$result = $client->deleteGraphqlApi
([/* ... */]); $promise = $client->deleteGraphqlApiAsync
([/* ... */]);
Deletes a GraphqlApi
object.
Parameter Syntax
$result = $client->deleteGraphqlApi([ 'apiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
DeleteResolver
$result = $client->deleteResolver
([/* ... */]); $promise = $client->deleteResolverAsync
([/* ... */]);
Deletes a Resolver
object.
Parameter Syntax
$result = $client->deleteResolver([ 'apiId' => '<string>', // REQUIRED 'fieldName' => '<string>', // REQUIRED 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- fieldName
-
- Required: Yes
- Type: string
The resolver field name.
- typeName
-
- Required: Yes
- Type: string
The name of the resolver type.
Result Syntax
[]
Result Details
Errors
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- BadRequestException:
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.
DeleteType
$result = $client->deleteType
([/* ... */]); $promise = $client->deleteTypeAsync
([/* ... */]);
Deletes a Type
object.
Parameter Syntax
$result = $client->deleteType([ 'apiId' => '<string>', // REQUIRED 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- typeName
-
- Required: Yes
- Type: string
The type name.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
DisassociateApi
$result = $client->disassociateApi
([/* ... */]); $promise = $client->disassociateApiAsync
([/* ... */]);
Removes an ApiAssociation
object from a custom domain.
Parameter Syntax
$result = $client->disassociateApi([ 'domainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- domainName
-
- Required: Yes
- Type: string
The domain name.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
DisassociateMergedGraphqlApi
$result = $client->disassociateMergedGraphqlApi
([/* ... */]); $promise = $client->disassociateMergedGraphqlApiAsync
([/* ... */]);
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
Parameter Syntax
$result = $client->disassociateMergedGraphqlApi([ 'associationId' => '<string>', // REQUIRED 'sourceApiIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- associationId
-
- Required: Yes
- Type: string
The ID generated by the AppSync service for the source API association.
- sourceApiIdentifier
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED', ]
Result Details
Members
- sourceApiAssociationStatus
-
- Type: string
The state of the source API association.
Errors
- UnauthorizedException:
You aren't authorized to perform this operation.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
DisassociateSourceGraphqlApi
$result = $client->disassociateSourceGraphqlApi
([/* ... */]); $promise = $client->disassociateSourceGraphqlApiAsync
([/* ... */]);
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
Parameter Syntax
$result = $client->disassociateSourceGraphqlApi([ 'associationId' => '<string>', // REQUIRED 'mergedApiIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- associationId
-
- Required: Yes
- Type: string
The ID generated by the AppSync service for the source API association.
- mergedApiIdentifier
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED', ]
Result Details
Members
- sourceApiAssociationStatus
-
- Type: string
The state of the source API association.
Errors
- UnauthorizedException:
You aren't authorized to perform this operation.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
EvaluateCode
$result = $client->evaluateCode
([/* ... */]); $promise = $client->evaluateCodeAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->evaluateCode([ 'code' => '<string>', // REQUIRED 'context' => '<string>', // REQUIRED 'function' => '<string>', 'runtime' => [ // REQUIRED 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- code
-
- Required: Yes
- Type: string
The code definition to be evaluated. Note that
code
andruntime
are both required for this action. Theruntime
value must beAPPSYNC_JS
. - context
-
- Required: Yes
- Type: string
The map that holds all of the contextual information for your resolver invocation. A
context
is required for this action. - function
-
- Type: string
The function within the code to be evaluated. If provided, the valid values are
request
andresponse
. - runtime
-
- Required: Yes
- Type: AppSyncRuntime structure
The runtime to be used when evaluating the code. Currently, only the
APPSYNC_JS
runtime is supported.
Result Syntax
[ 'error' => [ 'codeErrors' => [ [ 'errorType' => '<string>', 'location' => [ 'column' => <integer>, 'line' => <integer>, 'span' => <integer>, ], 'value' => '<string>', ], // ... ], 'message' => '<string>', ], 'evaluationResult' => '<string>', 'logs' => ['<string>', ...], ]
Result Details
Members
- error
-
- Type: EvaluateCodeErrorDetail structure
Contains the payload of the response error.
- evaluationResult
-
- Type: string
The result of the evaluation operation.
- logs
-
- Type: Array of strings
A list of logs that were generated by calls to
util.log.info
andutil.log.error
in the evaluated code.
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- BadRequestException:
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.
EvaluateMappingTemplate
$result = $client->evaluateMappingTemplate
([/* ... */]); $promise = $client->evaluateMappingTemplateAsync
([/* ... */]);
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).
Parameter Syntax
$result = $client->evaluateMappingTemplate([ 'context' => '<string>', // REQUIRED 'template' => '<string>', // REQUIRED ]);
Parameter Details
Members
- context
-
- Required: Yes
- Type: string
The map that holds all of the contextual information for your resolver invocation. A
context
is required for this action. - template
-
- Required: Yes
- Type: string
The mapping template; this can be a request or response template. A
template
is required for this action.
Result Syntax
[ 'error' => [ 'message' => '<string>', ], 'evaluationResult' => '<string>', 'logs' => ['<string>', ...], ]
Result Details
Members
- error
-
- Type: ErrorDetail structure
The
ErrorDetail
object. - evaluationResult
-
- Type: string
The mapping template; this can be a request or response template.
- logs
-
- Type: Array of strings
A list of logs that were generated by calls to
util.log.info
andutil.log.error
in the evaluated code.
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- BadRequestException:
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.
FlushApiCache
$result = $client->flushApiCache
([/* ... */]); $promise = $client->flushApiCacheAsync
([/* ... */]);
Flushes an ApiCache
object.
Parameter Syntax
$result = $client->flushApiCache([ 'apiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
GetApi
$result = $client->getApi
([/* ... */]); $promise = $client->getApiAsync
([/* ... */]);
Retrieves an Api
object.
Parameter Syntax
$result = $client->getApi([ 'apiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The
Api
ID.
Result Syntax
[ 'api' => [ 'apiArn' => '<string>', 'apiId' => '<string>', 'created' => <DateTime>, 'dns' => ['<string>', ...], 'eventConfig' => [ 'authProviders' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'cognitoConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'userPoolId' => '<string>', ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], ], // ... ], 'connectionAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'defaultPublishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'defaultSubscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], ], 'name' => '<string>', 'ownerContact' => '<string>', 'tags' => ['<string>', ...], 'wafWebAclArn' => '<string>', 'xrayEnabled' => true || false, ], ]
Result Details
Members
- api
-
- Type: Api structure
The
Api
object.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
GetApiAssociation
$result = $client->getApiAssociation
([/* ... */]); $promise = $client->getApiAssociationAsync
([/* ... */]);
Retrieves an ApiAssociation
object.
Parameter Syntax
$result = $client->getApiAssociation([ 'domainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- domainName
-
- Required: Yes
- Type: string
The domain name.
Result Syntax
[ 'apiAssociation' => [ 'apiId' => '<string>', 'associationStatus' => 'PROCESSING|FAILED|SUCCESS', 'deploymentDetail' => '<string>', 'domainName' => '<string>', ], ]
Result Details
Members
- apiAssociation
-
- Type: ApiAssociation structure
The
ApiAssociation
object.
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
GetApiCache
$result = $client->getApiCache
([/* ... */]); $promise = $client->getApiCacheAsync
([/* ... */]);
Retrieves an ApiCache
object.
Parameter Syntax
$result = $client->getApiCache([ 'apiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
Result Syntax
[ 'apiCache' => [ 'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING', 'atRestEncryptionEnabled' => true || false, 'healthMetricsConfig' => 'ENABLED|DISABLED', 'status' => 'AVAILABLE|CREATING|DELETING|MODIFYING|FAILED', 'transitEncryptionEnabled' => true || false, 'ttl' => <integer>, 'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X', ], ]
Result Details
Members
- apiCache
-
- Type: ApiCache structure
The
ApiCache
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
GetChannelNamespace
$result = $client->getChannelNamespace
([/* ... */]); $promise = $client->getChannelNamespaceAsync
([/* ... */]);
Retrieves the channel namespace for a specified Api
.
Parameter Syntax
$result = $client->getChannelNamespace([ 'apiId' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The
Api
ID. - name
-
- Required: Yes
- Type: string
The name of the
ChannelNamespace
.
Result Syntax
[ 'channelNamespace' => [ 'apiId' => '<string>', 'channelNamespaceArn' => '<string>', 'codeHandlers' => '<string>', 'created' => <DateTime>, 'lastModified' => <DateTime>, 'name' => '<string>', 'publishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'subscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'tags' => ['<string>', ...], ], ]
Result Details
Members
- channelNamespace
-
- Type: ChannelNamespace structure
The
ChannelNamespace
object.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
GetDataSource
$result = $client->getDataSource
([/* ... */]); $promise = $client->getDataSourceAsync
([/* ... */]);
Retrieves a DataSource
object.
Parameter Syntax
$result = $client->getDataSource([ 'apiId' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- name
-
- Required: Yes
- Type: string
The name of the data source.
Result Syntax
[ 'dataSource' => [ 'dataSourceArn' => '<string>', 'description' => '<string>', 'dynamodbConfig' => [ 'awsRegion' => '<string>', 'deltaSyncConfig' => [ 'baseTableTTL' => <integer>, 'deltaSyncTableName' => '<string>', 'deltaSyncTableTTL' => <integer>, ], 'tableName' => '<string>', 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '<string>', 'endpoint' => '<string>', ], 'eventBridgeConfig' => [ 'eventBusArn' => '<string>', ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', 'awsIamConfig' => [ 'signingRegion' => '<string>', 'signingServiceName' => '<string>', ], ], 'endpoint' => '<string>', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '<string>', ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '<string>', 'openSearchServiceConfig' => [ 'awsRegion' => '<string>', 'endpoint' => '<string>', ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '<string>', 'awsSecretStoreArn' => '<string>', 'databaseName' => '<string>', 'dbClusterIdentifier' => '<string>', 'schema' => '<string>', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '<string>', 'type' => 'AWS_LAMBDA|AMAZON_DYNAMODB|AMAZON_ELASTICSEARCH|NONE|HTTP|RELATIONAL_DATABASE|AMAZON_OPENSEARCH_SERVICE|AMAZON_EVENTBRIDGE|AMAZON_BEDROCK_RUNTIME', ], ]
Result Details
Members
- dataSource
-
- Type: DataSource structure
The
DataSource
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
GetDataSourceIntrospection
$result = $client->getDataSourceIntrospection
([/* ... */]); $promise = $client->getDataSourceIntrospectionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getDataSourceIntrospection([ 'includeModelsSDL' => true || false, 'introspectionId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- includeModelsSDL
-
- Type: boolean
A boolean flag that determines whether SDL should be generated for introspected types. If set to
true
, each model will contain ansdl
property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives. - introspectionId
-
- Required: Yes
- Type: string
The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.
- maxResults
-
- Type: int
The maximum number of introspected types that will be returned in a single response.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'introspectionId' => '<string>', 'introspectionResult' => [ 'models' => [ [ 'fields' => [ [ 'length' => <integer>, 'name' => '<string>', 'type' => [ 'kind' => '<string>', 'name' => '<string>', 'type' => [...], // RECURSIVE 'values' => ['<string>', ...], ], ], // ... ], 'indexes' => [ [ 'fields' => ['<string>', ...], 'name' => '<string>', ], // ... ], 'name' => '<string>', 'primaryKey' => [ 'fields' => ['<string>', ...], 'name' => '<string>', ], 'sdl' => '<string>', ], // ... ], 'nextToken' => '<string>', ], 'introspectionStatus' => 'PROCESSING|FAILED|SUCCESS', 'introspectionStatusDetail' => '<string>', ]
Result Details
Members
- introspectionId
-
- Type: string
The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.
- introspectionResult
-
- Type: DataSourceIntrospectionResult structure
The
DataSourceIntrospectionResult
object data. - introspectionStatus
-
- Type: string
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 toSUCCESS
orFAILED
depending on how the data was parsed. AFAILED
operation will return an error and its details as anintrospectionStatusDetail
. - introspectionStatusDetail
-
- Type: string
The error detail field. When a
FAILED
introspectionStatus
is returned, theintrospectionStatusDetail
will also return the exact error that was generated during the operation.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
GetDomainName
$result = $client->getDomainName
([/* ... */]); $promise = $client->getDomainNameAsync
([/* ... */]);
Retrieves a custom DomainName
object.
Parameter Syntax
$result = $client->getDomainName([ 'domainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- domainName
-
- Required: Yes
- Type: string
The domain name.
Result Syntax
[ 'domainNameConfig' => [ 'appsyncDomainName' => '<string>', 'certificateArn' => '<string>', 'description' => '<string>', 'domainName' => '<string>', 'hostedZoneId' => '<string>', ], ]
Result Details
Members
- domainNameConfig
-
- Type: DomainNameConfig structure
The configuration for the
DomainName
.
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
GetFunction
$result = $client->getFunction
([/* ... */]); $promise = $client->getFunctionAsync
([/* ... */]);
Get a Function
.
Parameter Syntax
$result = $client->getFunction([ 'apiId' => '<string>', // REQUIRED 'functionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The GraphQL API ID.
- functionId
-
- Required: Yes
- Type: string
The
Function
ID.
Result Syntax
[ 'functionConfiguration' => [ 'code' => '<string>', 'dataSourceName' => '<string>', 'description' => '<string>', 'functionArn' => '<string>', 'functionId' => '<string>', 'functionVersion' => '<string>', 'maxBatchSize' => <integer>, 'name' => '<string>', 'requestMappingTemplate' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '<string>', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], ], ]
Result Details
Members
- functionConfiguration
-
- Type: FunctionConfiguration structure
The
Function
object.
Errors
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
GetGraphqlApi
$result = $client->getGraphqlApi
([/* ... */]); $promise = $client->getGraphqlApiAsync
([/* ... */]);
Retrieves a GraphqlApi
object.
Parameter Syntax
$result = $client->getGraphqlApi([ 'apiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID for the GraphQL API.
Result Syntax
[ 'graphqlApi' => [ 'additionalAuthenticationProviders' => [ [ 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'userPoolId' => '<string>', ], ], // ... ], 'apiId' => '<string>', 'apiType' => 'GRAPHQL|MERGED', 'arn' => '<string>', 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'dns' => ['<string>', ...], 'enhancedMetricsConfig' => [ 'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS', 'operationLevelMetricsConfig' => 'ENABLED|DISABLED', 'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS', ], 'introspectionConfig' => 'ENABLED|DISABLED', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], 'mergedApiExecutionRoleArn' => '<string>', 'name' => '<string>', 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], 'owner' => '<string>', 'ownerContact' => '<string>', 'queryDepthLimit' => <integer>, 'resolverCountLimit' => <integer>, 'tags' => ['<string>', ...], 'uris' => ['<string>', ...], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'defaultAction' => 'ALLOW|DENY', 'userPoolId' => '<string>', ], 'visibility' => 'GLOBAL|PRIVATE', 'wafWebAclArn' => '<string>', 'xrayEnabled' => true || false, ], ]
Result Details
Members
- graphqlApi
-
- Type: GraphqlApi structure
The
GraphqlApi
object.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
GetGraphqlApiEnvironmentVariables
$result = $client->getGraphqlApiEnvironmentVariables
([/* ... */]); $promise = $client->getGraphqlApiEnvironmentVariablesAsync
([/* ... */]);
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
Parameter Syntax
$result = $client->getGraphqlApiEnvironmentVariables([ 'apiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The ID of the API from which the environmental variable list will be retrieved.
Result Syntax
[ 'environmentVariables' => ['<string>', ...], ]
Result Details
Members
- environmentVariables
-
- Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings
The payload containing each environmental variable in the
"key" : "value"
format.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
GetIntrospectionSchema
$result = $client->getIntrospectionSchema
([/* ... */]); $promise = $client->getIntrospectionSchemaAsync
([/* ... */]);
Retrieves the introspection schema for a GraphQL API.
Parameter Syntax
$result = $client->getIntrospectionSchema([ 'apiId' => '<string>', // REQUIRED 'format' => 'SDL|JSON', // REQUIRED 'includeDirectives' => true || false, ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- format
-
- Required: Yes
- Type: string
The schema format: SDL or JSON.
- includeDirectives
-
- Type: boolean
A flag that specifies whether the schema introspection should contain directives.
Result Syntax
[ 'schema' => <string || resource || Psr\Http\Message\StreamInterface>, ]
Result Details
Members
- schema
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The schema, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
Errors
- GraphQLSchemaException:
The GraphQL schema is not valid.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
GetResolver
$result = $client->getResolver
([/* ... */]); $promise = $client->getResolverAsync
([/* ... */]);
Retrieves a Resolver
object.
Parameter Syntax
$result = $client->getResolver([ 'apiId' => '<string>', // REQUIRED 'fieldName' => '<string>', // REQUIRED 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- fieldName
-
- Required: Yes
- Type: string
The resolver field name.
- typeName
-
- Required: Yes
- Type: string
The resolver type name.
Result Syntax
[ 'resolver' => [ 'cachingConfig' => [ 'cachingKeys' => ['<string>', ...], 'ttl' => <integer>, ], 'code' => '<string>', 'dataSourceName' => '<string>', 'fieldName' => '<string>', 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => <integer>, 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['<string>', ...], ], 'requestMappingTemplate' => '<string>', 'resolverArn' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '<string>', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], 'typeName' => '<string>', ], ]
Result Details
Members
- resolver
-
- Type: Resolver structure
The
Resolver
object.
Errors
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
GetSchemaCreationStatus
$result = $client->getSchemaCreationStatus
([/* ... */]); $promise = $client->getSchemaCreationStatusAsync
([/* ... */]);
Retrieves the current status of a schema creation operation.
Parameter Syntax
$result = $client->getSchemaCreationStatus([ 'apiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
Result Syntax
[ 'details' => '<string>', 'status' => 'PROCESSING|ACTIVE|DELETING|FAILED|SUCCESS|NOT_APPLICABLE', ]
Result Details
Members
- details
-
- Type: string
Detailed information about the status of the schema creation operation.
- status
-
- Type: 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.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
GetSourceApiAssociation
$result = $client->getSourceApiAssociation
([/* ... */]); $promise = $client->getSourceApiAssociationAsync
([/* ... */]);
Retrieves a SourceApiAssociation
object.
Parameter Syntax
$result = $client->getSourceApiAssociation([ 'associationId' => '<string>', // REQUIRED 'mergedApiIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- associationId
-
- Required: Yes
- Type: string
The ID generated by the AppSync service for the source API association.
- mergedApiIdentifier
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'sourceApiAssociation' => [ 'associationArn' => '<string>', 'associationId' => '<string>', 'description' => '<string>', 'lastSuccessfulMergeDate' => <DateTime>, 'mergedApiArn' => '<string>', 'mergedApiId' => '<string>', 'sourceApiArn' => '<string>', 'sourceApiAssociationConfig' => [ 'mergeType' => 'MANUAL_MERGE|AUTO_MERGE', ], 'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED', 'sourceApiAssociationStatusDetail' => '<string>', 'sourceApiId' => '<string>', ], ]
Result Details
Members
- sourceApiAssociation
-
- Type: SourceApiAssociation structure
The
SourceApiAssociation
object data.
Errors
- UnauthorizedException:
You aren't authorized to perform this operation.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
GetType
$result = $client->getType
([/* ... */]); $promise = $client->getTypeAsync
([/* ... */]);
Retrieves a Type
object.
Parameter Syntax
$result = $client->getType([ 'apiId' => '<string>', // REQUIRED 'format' => 'SDL|JSON', // REQUIRED 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- format
-
- Required: Yes
- Type: string
The type format: SDL or JSON.
- typeName
-
- Required: Yes
- Type: string
The type name.
Result Syntax
[ 'type' => [ 'arn' => '<string>', 'definition' => '<string>', 'description' => '<string>', 'format' => 'SDL|JSON', 'name' => '<string>', ], ]
Result Details
Members
- type
-
- Type: Type structure
The
Type
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListApiKeys
$result = $client->listApiKeys
([/* ... */]); $promise = $client->listApiKeysAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listApiKeys([ 'apiId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'apiKeys' => [ [ 'deletes' => <integer>, 'description' => '<string>', 'expires' => <integer>, 'id' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- apiKeys
-
- Type: Array of ApiKey structures
The
ApiKey
objects. - nextToken
-
- Type: string
An identifier to pass in the next request to this operation to return the next set of items in the list.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListApis
$result = $client->listApis
([/* ... */]); $promise = $client->listApisAsync
([/* ... */]);
Lists the APIs in your AppSync account.
ListApis
returns only the high level API details. For more detailed information about an API, use GetApi
.
Parameter Syntax
$result = $client->listApis([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'apis' => [ [ 'apiArn' => '<string>', 'apiId' => '<string>', 'created' => <DateTime>, 'dns' => ['<string>', ...], 'eventConfig' => [ 'authProviders' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'cognitoConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'userPoolId' => '<string>', ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], ], // ... ], 'connectionAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'defaultPublishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'defaultSubscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], ], 'name' => '<string>', 'ownerContact' => '<string>', 'tags' => ['<string>', ...], 'wafWebAclArn' => '<string>', 'xrayEnabled' => true || false, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- apis
-
- Type: Array of Api structures
The
Api
objects. - nextToken
-
- Type: string
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.
Errors
- BadRequestException:
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.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListChannelNamespaces
$result = $client->listChannelNamespaces
([/* ... */]); $promise = $client->listChannelNamespacesAsync
([/* ... */]);
Lists the channel namespaces for a specified Api
.
ListChannelNamespaces
returns only high level details for the channel namespace. To retrieve code handlers, use GetChannelNamespace
.
Parameter Syntax
$result = $client->listChannelNamespaces([ 'apiId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The
Api
ID. - maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'channelNamespaces' => [ [ 'apiId' => '<string>', 'channelNamespaceArn' => '<string>', 'codeHandlers' => '<string>', 'created' => <DateTime>, 'lastModified' => <DateTime>, 'name' => '<string>', 'publishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'subscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'tags' => ['<string>', ...], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- channelNamespaces
-
- Type: Array of ChannelNamespace structures
The
ChannelNamespace
objects. - nextToken
-
- Type: string
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.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListDataSources
$result = $client->listDataSources
([/* ... */]); $promise = $client->listDataSourcesAsync
([/* ... */]);
Lists the data sources for a given API.
Parameter Syntax
$result = $client->listDataSources([ 'apiId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'dataSources' => [ [ 'dataSourceArn' => '<string>', 'description' => '<string>', 'dynamodbConfig' => [ 'awsRegion' => '<string>', 'deltaSyncConfig' => [ 'baseTableTTL' => <integer>, 'deltaSyncTableName' => '<string>', 'deltaSyncTableTTL' => <integer>, ], 'tableName' => '<string>', 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '<string>', 'endpoint' => '<string>', ], 'eventBridgeConfig' => [ 'eventBusArn' => '<string>', ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', 'awsIamConfig' => [ 'signingRegion' => '<string>', 'signingServiceName' => '<string>', ], ], 'endpoint' => '<string>', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '<string>', ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '<string>', 'openSearchServiceConfig' => [ 'awsRegion' => '<string>', 'endpoint' => '<string>', ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '<string>', 'awsSecretStoreArn' => '<string>', 'databaseName' => '<string>', 'dbClusterIdentifier' => '<string>', 'schema' => '<string>', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '<string>', 'type' => 'AWS_LAMBDA|AMAZON_DYNAMODB|AMAZON_ELASTICSEARCH|NONE|HTTP|RELATIONAL_DATABASE|AMAZON_OPENSEARCH_SERVICE|AMAZON_EVENTBRIDGE|AMAZON_BEDROCK_RUNTIME', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- dataSources
-
- Type: Array of DataSource structures
The
DataSource
objects. - nextToken
-
- Type: string
An identifier to pass in the next request to this operation to return the next set of items in the list.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListDomainNames
$result = $client->listDomainNames
([/* ... */]); $promise = $client->listDomainNamesAsync
([/* ... */]);
Lists multiple custom domain names.
Parameter Syntax
$result = $client->listDomainNames([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'domainNameConfigs' => [ [ 'appsyncDomainName' => '<string>', 'certificateArn' => '<string>', 'description' => '<string>', 'domainName' => '<string>', 'hostedZoneId' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- domainNameConfigs
-
- Type: Array of DomainNameConfig structures
Lists configurations for multiple domain names.
- nextToken
-
- Type: string
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.
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListFunctions
$result = $client->listFunctions
([/* ... */]); $promise = $client->listFunctionsAsync
([/* ... */]);
List multiple functions.
Parameter Syntax
$result = $client->listFunctions([ 'apiId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The GraphQL API ID.
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'functions' => [ [ 'code' => '<string>', 'dataSourceName' => '<string>', 'description' => '<string>', 'functionArn' => '<string>', 'functionId' => '<string>', 'functionVersion' => '<string>', 'maxBatchSize' => <integer>, 'name' => '<string>', 'requestMappingTemplate' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '<string>', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- functions
-
- Type: Array of FunctionConfiguration structures
A list of
Function
objects. - nextToken
-
- Type: string
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.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListGraphqlApis
$result = $client->listGraphqlApis
([/* ... */]); $promise = $client->listGraphqlApisAsync
([/* ... */]);
Lists your GraphQL APIs.
Parameter Syntax
$result = $client->listGraphqlApis([ 'apiType' => 'GRAPHQL|MERGED', 'maxResults' => <integer>, 'nextToken' => '<string>', 'owner' => 'CURRENT_ACCOUNT|OTHER_ACCOUNTS', ]);
Parameter Details
Members
- apiType
-
- Type: string
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL
) or merged API (MERGED
). - maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
- owner
-
- Type: string
The account owner of the GraphQL API.
Result Syntax
[ 'graphqlApis' => [ [ 'additionalAuthenticationProviders' => [ [ 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'userPoolId' => '<string>', ], ], // ... ], 'apiId' => '<string>', 'apiType' => 'GRAPHQL|MERGED', 'arn' => '<string>', 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'dns' => ['<string>', ...], 'enhancedMetricsConfig' => [ 'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS', 'operationLevelMetricsConfig' => 'ENABLED|DISABLED', 'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS', ], 'introspectionConfig' => 'ENABLED|DISABLED', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], 'mergedApiExecutionRoleArn' => '<string>', 'name' => '<string>', 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], 'owner' => '<string>', 'ownerContact' => '<string>', 'queryDepthLimit' => <integer>, 'resolverCountLimit' => <integer>, 'tags' => ['<string>', ...], 'uris' => ['<string>', ...], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'defaultAction' => 'ALLOW|DENY', 'userPoolId' => '<string>', ], 'visibility' => 'GLOBAL|PRIVATE', 'wafWebAclArn' => '<string>', 'xrayEnabled' => true || false, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- graphqlApis
-
- Type: Array of GraphqlApi structures
The
GraphqlApi
objects. - nextToken
-
- Type: string
An identifier to pass in the next request to this operation to return the next set of items in the list.
Errors
- BadRequestException:
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.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListResolvers
$result = $client->listResolvers
([/* ... */]); $promise = $client->listResolversAsync
([/* ... */]);
Lists the resolvers for a given API and type.
Parameter Syntax
$result = $client->listResolvers([ 'apiId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
- typeName
-
- Required: Yes
- Type: string
The type name.
Result Syntax
[ 'nextToken' => '<string>', 'resolvers' => [ [ 'cachingConfig' => [ 'cachingKeys' => ['<string>', ...], 'ttl' => <integer>, ], 'code' => '<string>', 'dataSourceName' => '<string>', 'fieldName' => '<string>', 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => <integer>, 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['<string>', ...], ], 'requestMappingTemplate' => '<string>', 'resolverArn' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '<string>', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], 'typeName' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
An identifier to pass in the next request to this operation to return the next set of items in the list.
- resolvers
-
- Type: Array of Resolver structures
The
Resolver
objects.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListResolversByFunction
$result = $client->listResolversByFunction
([/* ... */]); $promise = $client->listResolversByFunctionAsync
([/* ... */]);
List the resolvers that are associated with a specific function.
Parameter Syntax
$result = $client->listResolversByFunction([ 'apiId' => '<string>', // REQUIRED 'functionId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- functionId
-
- Required: Yes
- Type: string
The function ID.
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'nextToken' => '<string>', 'resolvers' => [ [ 'cachingConfig' => [ 'cachingKeys' => ['<string>', ...], 'ttl' => <integer>, ], 'code' => '<string>', 'dataSourceName' => '<string>', 'fieldName' => '<string>', 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => <integer>, 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['<string>', ...], ], 'requestMappingTemplate' => '<string>', 'resolverArn' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '<string>', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], 'typeName' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
An identifier that you can use to return the next set of items in the list.
- resolvers
-
- Type: Array of Resolver structures
The list of resolvers.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListSourceApiAssociations
$result = $client->listSourceApiAssociations
([/* ... */]); $promise = $client->listSourceApiAssociationsAsync
([/* ... */]);
Lists the SourceApiAssociationSummary
data.
Parameter Syntax
$result = $client->listSourceApiAssociations([ 'apiId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'nextToken' => '<string>', 'sourceApiAssociationSummaries' => [ [ 'associationArn' => '<string>', 'associationId' => '<string>', 'description' => '<string>', 'mergedApiArn' => '<string>', 'mergedApiId' => '<string>', 'sourceApiArn' => '<string>', 'sourceApiId' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
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.
- sourceApiAssociationSummaries
-
- Type: Array of SourceApiAssociationSummary structures
The
SourceApiAssociationSummary
object data.
Errors
- UnauthorizedException:
You aren't authorized to perform this operation.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Lists the tags for a resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The
GraphqlApi
Amazon Resource Name (ARN).
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A
TagMap
object.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- LimitExceededException:
The request exceeded a limit. Try your request again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
ListTypes
$result = $client->listTypes
([/* ... */]); $promise = $client->listTypesAsync
([/* ... */]);
Lists the types for a given API.
Parameter Syntax
$result = $client->listTypes([ 'apiId' => '<string>', // REQUIRED 'format' => 'SDL|JSON', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- format
-
- Required: Yes
- Type: string
The type format: SDL or JSON.
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'nextToken' => '<string>', 'types' => [ [ 'arn' => '<string>', 'definition' => '<string>', 'description' => '<string>', 'format' => 'SDL|JSON', 'name' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
An identifier to pass in the next request to this operation to return the next set of items in the list.
- types
-
- Type: Array of Type structures
The
Type
objects.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
ListTypesByAssociation
$result = $client->listTypesByAssociation
([/* ... */]); $promise = $client->listTypesByAssociationAsync
([/* ... */]);
Lists Type
objects by the source API association ID.
Parameter Syntax
$result = $client->listTypesByAssociation([ 'associationId' => '<string>', // REQUIRED 'format' => 'SDL|JSON', // REQUIRED 'maxResults' => <integer>, 'mergedApiIdentifier' => '<string>', // REQUIRED 'nextToken' => '<string>', ]);
Parameter Details
Members
- associationId
-
- Required: Yes
- Type: string
The ID generated by the AppSync service for the source API association.
- format
-
- Required: Yes
- Type: string
The format type.
- maxResults
-
- Type: int
The maximum number of results that you want the request to return.
- mergedApiIdentifier
-
- Required: Yes
- Type: 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.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'nextToken' => '<string>', 'types' => [ [ 'arn' => '<string>', 'definition' => '<string>', 'description' => '<string>', 'format' => 'SDL|JSON', 'name' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
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.
- types
-
- Type: Array of Type structures
The
Type
objects.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
PutGraphqlApiEnvironmentVariables
$result = $client->putGraphqlApiEnvironmentVariables
([/* ... */]); $promise = $client->putGraphqlApiEnvironmentVariablesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->putGraphqlApiEnvironmentVariables([ 'apiId' => '<string>', // REQUIRED 'environmentVariables' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The ID of the API to which the environmental variable list will be written.
- environmentVariables
-
- Required: Yes
- Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings
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 thePutGraphqlApiEnvironmentVariables
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.
Result Syntax
[ 'environmentVariables' => ['<string>', ...], ]
Result Details
Members
- environmentVariables
-
- Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings
The payload containing each environmental variable in the
"key" : "value"
format.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
StartDataSourceIntrospection
$result = $client->startDataSourceIntrospection
([/* ... */]); $promise = $client->startDataSourceIntrospectionAsync
([/* ... */]);
Creates a new introspection. Returns the introspectionId
of the new introspection after its creation.
Parameter Syntax
$result = $client->startDataSourceIntrospection([ 'rdsDataApiConfig' => [ 'databaseName' => '<string>', // REQUIRED 'resourceArn' => '<string>', // REQUIRED 'secretArn' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- rdsDataApiConfig
-
- Type: RdsDataApiConfig structure
The
rdsDataApiConfig
object data.
Result Syntax
[ 'introspectionId' => '<string>', 'introspectionStatus' => 'PROCESSING|FAILED|SUCCESS', 'introspectionStatusDetail' => '<string>', ]
Result Details
Members
- introspectionId
-
- Type: string
The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.
- introspectionStatus
-
- Type: 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 toSUCCESS
orFAILED
depending on how the data was parsed. AFAILED
operation will return an error and its details as anintrospectionStatusDetail
. - introspectionStatusDetail
-
- Type: string
The error detail field. When a
FAILED
introspectionStatus
is returned, theintrospectionStatusDetail
will also return the exact error that was generated during the operation.
Errors
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- BadRequestException:
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.
StartSchemaCreation
$result = $client->startSchemaCreation
([/* ... */]); $promise = $client->startSchemaCreationAsync
([/* ... */]);
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
Parameter Syntax
$result = $client->startSchemaCreation([ 'apiId' => '<string>', // REQUIRED 'definition' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- definition
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The schema definition, in GraphQL schema language format.
Result Syntax
[ 'status' => 'PROCESSING|ACTIVE|DELETING|FAILED|SUCCESS|NOT_APPLICABLE', ]
Result Details
Members
- status
-
- Type: 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.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
StartSchemaMerge
$result = $client->startSchemaMerge
([/* ... */]); $promise = $client->startSchemaMergeAsync
([/* ... */]);
Initiates a merge operation. Returns a status that shows the result of the merge operation.
Parameter Syntax
$result = $client->startSchemaMerge([ 'associationId' => '<string>', // REQUIRED 'mergedApiIdentifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- associationId
-
- Required: Yes
- Type: string
The ID generated by the AppSync service for the source API association.
- mergedApiIdentifier
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED', ]
Result Details
Members
- sourceApiAssociationStatus
-
- Type: string
The state of the source API association.
Errors
- UnauthorizedException:
You aren't authorized to perform this operation.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Tags a resource with user-supplied tags.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The
GraphqlApi
Amazon Resource Name (ARN). - tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
A
TagMap
object.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- LimitExceededException:
The request exceeded a limit. Try your request again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Untags a resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The
GraphqlApi
Amazon Resource Name (ARN). - tagKeys
-
- Required: Yes
- Type: Array of strings
A list of
TagKey
objects.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- LimitExceededException:
The request exceeded a limit. Try your request again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
UpdateApi
$result = $client->updateApi
([/* ... */]); $promise = $client->updateApiAsync
([/* ... */]);
Updates an Api
.
Parameter Syntax
$result = $client->updateApi([ 'apiId' => '<string>', // REQUIRED 'eventConfig' => [ 'authProviders' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED 'cognitoConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', // REQUIRED 'userPoolId' => '<string>', // REQUIRED ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', // REQUIRED 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', // REQUIRED ], ], // ... ], 'connectionAuthModes' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], 'defaultPublishAuthModes' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], 'defaultSubscribeAuthModes' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', // REQUIRED 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED ], ], 'name' => '<string>', // REQUIRED 'ownerContact' => '<string>', ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The
Api
ID. - eventConfig
-
- Type: EventConfig structure
The new event configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.
- name
-
- Required: Yes
- Type: string
The name of the Api.
- ownerContact
-
- Type: string
The owner contact information for the
Api
.
Result Syntax
[ 'api' => [ 'apiArn' => '<string>', 'apiId' => '<string>', 'created' => <DateTime>, 'dns' => ['<string>', ...], 'eventConfig' => [ 'authProviders' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'cognitoConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'userPoolId' => '<string>', ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], ], // ... ], 'connectionAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'defaultPublishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'defaultSubscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], ], 'name' => '<string>', 'ownerContact' => '<string>', 'tags' => ['<string>', ...], 'wafWebAclArn' => '<string>', 'xrayEnabled' => true || false, ], ]
Result Details
Members
- api
-
- Type: Api structure
The
Api
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
UpdateApiCache
$result = $client->updateApiCache
([/* ... */]); $promise = $client->updateApiCacheAsync
([/* ... */]);
Updates the cache for the GraphQL API.
Parameter Syntax
$result = $client->updateApiCache([ 'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING', // REQUIRED 'apiId' => '<string>', // REQUIRED 'healthMetricsConfig' => 'ENABLED|DISABLED', 'ttl' => <integer>, // REQUIRED 'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X', // REQUIRED ]);
Parameter Details
Members
- apiCachingBehavior
-
- Required: Yes
- Type: string
Caching behavior.
-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
- apiId
-
- Required: Yes
- Type: string
The GraphQL API ID.
- healthMetricsConfig
-
- Type: string
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
orDISABLED
. - ttl
-
- Required: Yes
- Type: long (int|float)
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
- type
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'apiCache' => [ 'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING', 'atRestEncryptionEnabled' => true || false, 'healthMetricsConfig' => 'ENABLED|DISABLED', 'status' => 'AVAILABLE|CREATING|DELETING|MODIFYING|FAILED', 'transitEncryptionEnabled' => true || false, 'ttl' => <integer>, 'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X', ], ]
Result Details
Members
- apiCache
-
- Type: ApiCache structure
The
ApiCache
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
UpdateApiKey
$result = $client->updateApiKey
([/* ... */]); $promise = $client->updateApiKeyAsync
([/* ... */]);
Updates an API key. You can update the key as long as it's not deleted.
Parameter Syntax
$result = $client->updateApiKey([ 'apiId' => '<string>', // REQUIRED 'description' => '<string>', 'expires' => <integer>, 'id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The ID for the GraphQL API.
- description
-
- Type: string
A description of the purpose of the API key.
- expires
-
- Type: long (int|float)
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 .
- id
-
- Required: Yes
- Type: string
The API key ID.
Result Syntax
[ 'apiKey' => [ 'deletes' => <integer>, 'description' => '<string>', 'expires' => <integer>, 'id' => '<string>', ], ]
Result Details
Members
- apiKey
-
- Type: ApiKey structure
The API key.
Errors
- BadRequestException:
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.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- LimitExceededException:
The request exceeded a limit. Try your request again.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- ApiKeyValidityOutOfBoundsException:
The API key expiration must be set to a value between 1 and 365 days from creation (for
CreateApiKey
) or from update (forUpdateApiKey
).
UpdateChannelNamespace
$result = $client->updateChannelNamespace
([/* ... */]); $promise = $client->updateChannelNamespaceAsync
([/* ... */]);
Updates a ChannelNamespace
associated with an Api
.
Parameter Syntax
$result = $client->updateChannelNamespace([ 'apiId' => '<string>', // REQUIRED 'codeHandlers' => '<string>', 'name' => '<string>', // REQUIRED 'publishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], 'subscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The
Api
ID. - codeHandlers
-
- Type: string
The event handler functions that run custom business logic to process published events and subscribe requests.
- name
-
- Required: Yes
- Type: string
The name of the
ChannelNamespace
. - publishAuthModes
-
- Type: Array of AuthMode structures
The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default
Api
authorization configuration. - subscribeAuthModes
-
- Type: Array of AuthMode structures
The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default
Api
authorization configuration.
Result Syntax
[ 'channelNamespace' => [ 'apiId' => '<string>', 'channelNamespaceArn' => '<string>', 'codeHandlers' => '<string>', 'created' => <DateTime>, 'lastModified' => <DateTime>, 'name' => '<string>', 'publishAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'subscribeAuthModes' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', ], // ... ], 'tags' => ['<string>', ...], ], ]
Result Details
Members
- channelNamespace
-
- Type: ChannelNamespace structure
The
ChannelNamespace
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
UpdateDataSource
$result = $client->updateDataSource
([/* ... */]); $promise = $client->updateDataSourceAsync
([/* ... */]);
Updates a DataSource
object.
Parameter Syntax
$result = $client->updateDataSource([ 'apiId' => '<string>', // REQUIRED 'description' => '<string>', 'dynamodbConfig' => [ 'awsRegion' => '<string>', // REQUIRED 'deltaSyncConfig' => [ 'baseTableTTL' => <integer>, 'deltaSyncTableName' => '<string>', 'deltaSyncTableTTL' => <integer>, ], 'tableName' => '<string>', // REQUIRED 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '<string>', // REQUIRED 'endpoint' => '<string>', // REQUIRED ], 'eventBridgeConfig' => [ 'eventBusArn' => '<string>', // REQUIRED ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', // REQUIRED 'awsIamConfig' => [ 'signingRegion' => '<string>', 'signingServiceName' => '<string>', ], ], 'endpoint' => '<string>', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '<string>', // REQUIRED ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '<string>', // REQUIRED 'openSearchServiceConfig' => [ 'awsRegion' => '<string>', // REQUIRED 'endpoint' => '<string>', // REQUIRED ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '<string>', 'awsSecretStoreArn' => '<string>', 'databaseName' => '<string>', 'dbClusterIdentifier' => '<string>', 'schema' => '<string>', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '<string>', 'type' => 'AWS_LAMBDA|AMAZON_DYNAMODB|AMAZON_ELASTICSEARCH|NONE|HTTP|RELATIONAL_DATABASE|AMAZON_OPENSEARCH_SERVICE|AMAZON_EVENTBRIDGE|AMAZON_BEDROCK_RUNTIME', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- description
-
- Type: string
The new description for the data source.
- dynamodbConfig
-
- Type: DynamodbDataSourceConfig structure
The new Amazon DynamoDB configuration.
- elasticsearchConfig
-
- Type: ElasticsearchDataSourceConfig structure
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.
- eventBridgeConfig
-
- Type: EventBridgeDataSourceConfig structure
The new Amazon EventBridge settings.
- httpConfig
-
- Type: HttpDataSourceConfig structure
The new HTTP endpoint configuration.
- lambdaConfig
-
- Type: LambdaDataSourceConfig structure
The new Lambda configuration.
- metricsConfig
-
- Type: string
Enables or disables enhanced data source metrics for specified data sources. Note that
metricsConfig
won't be used unless thedataSourceLevelMetricsBehavior
value is set toPER_DATA_SOURCE_METRICS
. If thedataSourceLevelMetricsBehavior
is set toFULL_REQUEST_DATA_SOURCE_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
. - name
-
- Required: Yes
- Type: string
The new name for the data source.
- openSearchServiceConfig
-
- Type: OpenSearchServiceDataSourceConfig structure
The new OpenSearch configuration.
- relationalDatabaseConfig
-
- Type: RelationalDatabaseDataSourceConfig structure
The new relational database configuration.
- serviceRoleArn
-
- Type: string
The new service role Amazon Resource Name (ARN) for the data source.
- type
-
- Required: Yes
- Type: string
The new data source type.
Result Syntax
[ 'dataSource' => [ 'dataSourceArn' => '<string>', 'description' => '<string>', 'dynamodbConfig' => [ 'awsRegion' => '<string>', 'deltaSyncConfig' => [ 'baseTableTTL' => <integer>, 'deltaSyncTableName' => '<string>', 'deltaSyncTableTTL' => <integer>, ], 'tableName' => '<string>', 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '<string>', 'endpoint' => '<string>', ], 'eventBridgeConfig' => [ 'eventBusArn' => '<string>', ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', 'awsIamConfig' => [ 'signingRegion' => '<string>', 'signingServiceName' => '<string>', ], ], 'endpoint' => '<string>', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '<string>', ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '<string>', 'openSearchServiceConfig' => [ 'awsRegion' => '<string>', 'endpoint' => '<string>', ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '<string>', 'awsSecretStoreArn' => '<string>', 'databaseName' => '<string>', 'dbClusterIdentifier' => '<string>', 'schema' => '<string>', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '<string>', 'type' => 'AWS_LAMBDA|AMAZON_DYNAMODB|AMAZON_ELASTICSEARCH|NONE|HTTP|RELATIONAL_DATABASE|AMAZON_OPENSEARCH_SERVICE|AMAZON_EVENTBRIDGE|AMAZON_BEDROCK_RUNTIME', ], ]
Result Details
Members
- dataSource
-
- Type: DataSource structure
The updated
DataSource
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
UpdateDomainName
$result = $client->updateDomainName
([/* ... */]); $promise = $client->updateDomainNameAsync
([/* ... */]);
Updates a custom DomainName
object.
Parameter Syntax
$result = $client->updateDomainName([ 'description' => '<string>', 'domainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- description
-
- Type: string
A description of the
DomainName
. - domainName
-
- Required: Yes
- Type: string
The domain name.
Result Syntax
[ 'domainNameConfig' => [ 'appsyncDomainName' => '<string>', 'certificateArn' => '<string>', 'description' => '<string>', 'domainName' => '<string>', 'hostedZoneId' => '<string>', ], ]
Result Details
Members
- domainNameConfig
-
- Type: DomainNameConfig structure
The configuration for the
DomainName
.
Errors
- AccessDeniedException:
You don't have access to perform this operation on this resource.
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
UpdateFunction
$result = $client->updateFunction
([/* ... */]); $promise = $client->updateFunctionAsync
([/* ... */]);
Updates a Function
object.
Parameter Syntax
$result = $client->updateFunction([ 'apiId' => '<string>', // REQUIRED 'code' => '<string>', 'dataSourceName' => '<string>', // REQUIRED 'description' => '<string>', 'functionId' => '<string>', // REQUIRED 'functionVersion' => '<string>', 'maxBatchSize' => <integer>, 'name' => '<string>', // REQUIRED 'requestMappingTemplate' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '<string>', // REQUIRED ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The GraphQL API ID.
- code
-
- Type: string
The
function
code that contains the request and response functions. When code is used, theruntime
is required. Theruntime
value must beAPPSYNC_JS
. - dataSourceName
-
- Required: Yes
- Type: string
The
Function
DataSource
name. - description
-
- Type: string
The
Function
description. - functionId
-
- Required: Yes
- Type: string
The function ID.
- functionVersion
-
- Type: string
The
version
of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, thefunctionVersion
is required. - maxBatchSize
-
- Type: int
The maximum batching size for a resolver.
- name
-
- Required: Yes
- Type: string
The
Function
name. - requestMappingTemplate
-
- Type: string
The
Function
request mapping template. Functions support only the 2018-05-29 version of the request mapping template. - responseMappingTemplate
-
- Type: string
The
Function
request mapping template. - runtime
-
- Type: AppSyncRuntime structure
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.
- syncConfig
-
- Type: SyncConfig structure
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
Result Syntax
[ 'functionConfiguration' => [ 'code' => '<string>', 'dataSourceName' => '<string>', 'description' => '<string>', 'functionArn' => '<string>', 'functionId' => '<string>', 'functionVersion' => '<string>', 'maxBatchSize' => <integer>, 'name' => '<string>', 'requestMappingTemplate' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '<string>', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], ], ]
Result Details
Members
- functionConfiguration
-
- Type: FunctionConfiguration structure
The
Function
object.
Errors
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- BadRequestException:
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.
UpdateGraphqlApi
$result = $client->updateGraphqlApi
([/* ... */]); $promise = $client->updateGraphqlApiAsync
([/* ... */]);
Updates a GraphqlApi
object.
Parameter Syntax
$result = $client->updateGraphqlApi([ 'additionalAuthenticationProviders' => [ [ 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', // REQUIRED 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', // REQUIRED ], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', // REQUIRED 'userPoolId' => '<string>', // REQUIRED ], ], // ... ], 'apiId' => '<string>', // REQUIRED 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'enhancedMetricsConfig' => [ 'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS', // REQUIRED 'operationLevelMetricsConfig' => 'ENABLED|DISABLED', // REQUIRED 'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS', // REQUIRED ], 'introspectionConfig' => 'ENABLED|DISABLED', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', // REQUIRED 'identityValidationExpression' => '<string>', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', // REQUIRED 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED ], 'mergedApiExecutionRoleArn' => '<string>', 'name' => '<string>', // REQUIRED 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', // REQUIRED ], 'ownerContact' => '<string>', 'queryDepthLimit' => <integer>, 'resolverCountLimit' => <integer>, 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', // REQUIRED 'defaultAction' => 'ALLOW|DENY', // REQUIRED 'userPoolId' => '<string>', // REQUIRED ], 'xrayEnabled' => true || false, ]);
Parameter Details
Members
- additionalAuthenticationProviders
-
- Type: Array of AdditionalAuthenticationProvider structures
A list of additional authentication providers for the
GraphqlApi
API. - apiId
-
- Required: Yes
- Type: string
The API ID.
- authenticationType
-
- Type: string
The new authentication type for the
GraphqlApi
object. - enhancedMetricsConfig
-
- Type: EnhancedMetricsConfig structure
The
enhancedMetricsConfig
object. - introspectionConfig
-
- Type: string
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 toENABLED
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.
- lambdaAuthorizerConfig
-
- Type: LambdaAuthorizerConfig structure
Configuration for Lambda function authorization.
- logConfig
-
- Type: LogConfig structure
The Amazon CloudWatch Logs configuration for the
GraphqlApi
object. - mergedApiExecutionRoleArn
-
- Type: string
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. - name
-
- Required: Yes
- Type: string
The new name for the
GraphqlApi
object. - openIDConnectConfig
-
- Type: OpenIDConnectConfig structure
The OpenID Connect configuration for the
GraphqlApi
object. - ownerContact
-
- Type: string
The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
- queryDepthLimit
-
- Type: int
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 between1
and75
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.
- resolverCountLimit
-
- Type: int
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 to10000
. When specified, the limit value can be between1
and10000
. This field will produce a limit error if the operation falls out of bounds. - userPoolConfig
-
- Type: UserPoolConfig structure
The new Amazon Cognito user pool configuration for the
~GraphqlApi
object. - xrayEnabled
-
- Type: boolean
A flag indicating whether to use X-Ray tracing for the
GraphqlApi
.
Result Syntax
[ 'graphqlApi' => [ 'additionalAuthenticationProviders' => [ [ 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'userPoolId' => '<string>', ], ], // ... ], 'apiId' => '<string>', 'apiType' => 'GRAPHQL|MERGED', 'arn' => '<string>', 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'dns' => ['<string>', ...], 'enhancedMetricsConfig' => [ 'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS', 'operationLevelMetricsConfig' => 'ENABLED|DISABLED', 'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS', ], 'introspectionConfig' => 'ENABLED|DISABLED', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identityValidationExpression' => '<string>', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '<string>', 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], 'mergedApiExecutionRoleArn' => '<string>', 'name' => '<string>', 'openIDConnectConfig' => [ 'authTTL' => <integer>, 'clientId' => '<string>', 'iatTTL' => <integer>, 'issuer' => '<string>', ], 'owner' => '<string>', 'ownerContact' => '<string>', 'queryDepthLimit' => <integer>, 'resolverCountLimit' => <integer>, 'tags' => ['<string>', ...], 'uris' => ['<string>', ...], 'userPoolConfig' => [ 'appIdClientRegex' => '<string>', 'awsRegion' => '<string>', 'defaultAction' => 'ALLOW|DENY', 'userPoolId' => '<string>', ], 'visibility' => 'GLOBAL|PRIVATE', 'wafWebAclArn' => '<string>', 'xrayEnabled' => true || false, ], ]
Result Details
Members
- graphqlApi
-
- Type: GraphqlApi structure
The updated
GraphqlApi
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- AccessDeniedException:
You don't have access to perform this operation on this resource.
UpdateResolver
$result = $client->updateResolver
([/* ... */]); $promise = $client->updateResolverAsync
([/* ... */]);
Updates a Resolver
object.
Parameter Syntax
$result = $client->updateResolver([ 'apiId' => '<string>', // REQUIRED 'cachingConfig' => [ 'cachingKeys' => ['<string>', ...], 'ttl' => <integer>, // REQUIRED ], 'code' => '<string>', 'dataSourceName' => '<string>', 'fieldName' => '<string>', // REQUIRED 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => <integer>, 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['<string>', ...], ], 'requestMappingTemplate' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '<string>', // REQUIRED ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- cachingConfig
-
- Type: CachingConfig structure
The caching configuration for the resolver.
- code
-
- Type: string
The
resolver
code that contains the request and response functions. When code is used, theruntime
is required. Theruntime
value must beAPPSYNC_JS
. - dataSourceName
-
- Type: string
The new data source name.
- fieldName
-
- Required: Yes
- Type: string
The new field name.
- kind
-
- Type: 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.
- maxBatchSize
-
- Type: int
The maximum batching size for a resolver.
- metricsConfig
-
- Type: string
Enables or disables enhanced resolver metrics for specified resolvers. Note that
metricsConfig
won't be used unless theresolverLevelMetricsBehavior
value is set toPER_RESOLVER_METRICS
. If theresolverLevelMetricsBehavior
is set toFULL_REQUEST_RESOLVER_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
. - pipelineConfig
-
- Type: PipelineConfig structure
The
PipelineConfig
. - requestMappingTemplate
-
- Type: string
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.
- responseMappingTemplate
-
- Type: string
The new response mapping template.
- runtime
-
- Type: AppSyncRuntime structure
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.
- syncConfig
-
- Type: SyncConfig structure
The
SyncConfig
for a resolver attached to a versioned data source. - typeName
-
- Required: Yes
- Type: string
The new type name.
Result Syntax
[ 'resolver' => [ 'cachingConfig' => [ 'cachingKeys' => ['<string>', ...], 'ttl' => <integer>, ], 'code' => '<string>', 'dataSourceName' => '<string>', 'fieldName' => '<string>', 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => <integer>, 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['<string>', ...], ], 'requestMappingTemplate' => '<string>', 'resolverArn' => '<string>', 'responseMappingTemplate' => '<string>', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '<string>', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '<string>', ], ], 'typeName' => '<string>', ], ]
Result Details
Members
- resolver
-
- Type: Resolver structure
The updated
Resolver
object.
Errors
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- BadRequestException:
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.
UpdateSourceApiAssociation
$result = $client->updateSourceApiAssociation
([/* ... */]); $promise = $client->updateSourceApiAssociationAsync
([/* ... */]);
Updates some of the configuration choices of a particular source API association.
Parameter Syntax
$result = $client->updateSourceApiAssociation([ 'associationId' => '<string>', // REQUIRED 'description' => '<string>', 'mergedApiIdentifier' => '<string>', // REQUIRED 'sourceApiAssociationConfig' => [ 'mergeType' => 'MANUAL_MERGE|AUTO_MERGE', ], ]);
Parameter Details
Members
- associationId
-
- Required: Yes
- Type: string
The ID generated by the AppSync service for the source API association.
- description
-
- Type: string
The description field.
- mergedApiIdentifier
-
- Required: Yes
- Type: 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.
- sourceApiAssociationConfig
-
- Type: SourceApiAssociationConfig structure
The
SourceApiAssociationConfig
object data.
Result Syntax
[ 'sourceApiAssociation' => [ 'associationArn' => '<string>', 'associationId' => '<string>', 'description' => '<string>', 'lastSuccessfulMergeDate' => <DateTime>, 'mergedApiArn' => '<string>', 'mergedApiId' => '<string>', 'sourceApiArn' => '<string>', 'sourceApiAssociationConfig' => [ 'mergeType' => 'MANUAL_MERGE|AUTO_MERGE', ], 'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED', 'sourceApiAssociationStatusDetail' => '<string>', 'sourceApiId' => '<string>', ], ]
Result Details
Members
- sourceApiAssociation
-
- Type: SourceApiAssociation structure
The
SourceApiAssociation
object data.
Errors
- UnauthorizedException:
You aren't authorized to perform this operation.
- BadRequestException:
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.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
UpdateType
$result = $client->updateType
([/* ... */]); $promise = $client->updateTypeAsync
([/* ... */]);
Updates a Type
object.
Parameter Syntax
$result = $client->updateType([ 'apiId' => '<string>', // REQUIRED 'definition' => '<string>', 'format' => 'SDL|JSON', // REQUIRED 'typeName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiId
-
- Required: Yes
- Type: string
The API ID.
- definition
-
- Type: string
The new definition.
- format
-
- Required: Yes
- Type: string
The new type format: SDL or JSON.
- typeName
-
- Required: Yes
- Type: string
The new type name.
Result Syntax
[ 'type' => [ 'arn' => '<string>', 'definition' => '<string>', 'description' => '<string>', 'format' => 'SDL|JSON', 'name' => '<string>', ], ]
Result Details
Members
- type
-
- Type: Type structure
The updated
Type
object.
Errors
- BadRequestException:
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.
- ConcurrentModificationException:
Another modification is in progress at this time and it must complete before you can make your change.
- NotFoundException:
The resource specified in the request was not found. Check the resource, and then try again.
- UnauthorizedException:
You aren't authorized to perform this operation.
- InternalFailureException:
An internal AppSync error occurred. Try your request again.
Shapes
AccessDeniedException
Description
You don't have access to perform this operation on this resource.
Members
- message
-
- Type: string
AdditionalAuthenticationProvider
Description
Describes an additional authentication provider.
Members
- authenticationType
-
- Type: string
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
- lambdaAuthorizerConfig
-
- Type: LambdaAuthorizerConfig structure
Configuration for Lambda function authorization.
- openIDConnectConfig
-
- Type: OpenIDConnectConfig structure
The OIDC configuration.
- userPoolConfig
-
- Type: CognitoUserPoolConfig structure
The Amazon Cognito user pool configuration.
Api
Description
Describes an AppSync API. You can use Api
for an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
Members
- apiArn
-
- Type: string
The Amazon Resource Name (ARN) for the
Api
. - apiId
-
- Type: string
The
Api
ID. - created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the
Api
was created. - dns
-
- Type: Associative array of custom strings keys (String) to strings
The DNS records for the API. This will include an HTTP and a real-time endpoint.
- eventConfig
-
- Type: EventConfig structure
The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.
- name
-
- Type: string
The name of the
Api
. - ownerContact
-
- Type: string
The owner contact information for the
Api
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A map with keys of
TagKey
objects and values ofTagValue
objects. - wafWebAclArn
-
- Type: string
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this
Api
, if one exists. - xrayEnabled
-
- Type: boolean
A flag indicating whether to use X-Ray tracing for this
Api
.
ApiAssociation
Description
Describes an ApiAssociation
object.
Members
- apiId
-
- Type: string
The API ID.
- associationStatus
-
- Type: string
Identifies the status of an association.
-
PROCESSING: The API association is being created. You cannot modify association requests during processing.
-
SUCCESS: The API association was successful. You can modify associations after success.
-
FAILED: The API association has failed. You can modify associations after failure.
- deploymentDetail
-
- Type: string
Details about the last deployment status.
- domainName
-
- Type: string
The domain name.
ApiCache
Description
The ApiCache
object.
Members
- apiCachingBehavior
-
- Type: string
Caching behavior.
-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
- atRestEncryptionEnabled
-
- Type: boolean
At-rest encryption flag for cache. You cannot update this setting after creation.
- healthMetricsConfig
-
- Type: string
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
orDISABLED
. - status
-
- Type: string
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.
- transitEncryptionEnabled
-
- Type: boolean
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
- ttl
-
- Type: long (int|float)
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
- type
-
- Type: string
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.
ApiKey
Description
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.
Members
- deletes
-
- Type: long (int|float)
The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.
- description
-
- Type: string
A description of the purpose of the API key.
- expires
-
- Type: long (int|float)
The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
- id
-
- Type: string
The API key ID.
ApiKeyLimitExceededException
Description
The API key exceeded a limit. Try your request again.
Members
- message
-
- Type: string
ApiKeyValidityOutOfBoundsException
Description
The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey
) or from update (for UpdateApiKey
).
Members
- message
-
- Type: string
ApiLimitExceededException
Description
The GraphQL API exceeded a limit. Try your request again.
Members
- message
-
- Type: string
AppSyncRuntime
Description
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.
Members
- name
-
- Required: Yes
- Type: string
The
name
of the runtime to use. Currently, the only allowed value isAPPSYNC_JS
. - runtimeVersion
-
- Required: Yes
- Type: string
The
version
of the runtime to use. Currently, the only allowed version is1.0.0
.
AuthMode
Description
Describes an authorization configuration. Use AuthMode
to specify the publishing and subscription authorization configuration for an Event API.
Members
- authType
-
- Required: Yes
- Type: string
The authorization type.
AuthProvider
Description
Describes an authorization provider.
Members
- authType
-
- Required: Yes
- Type: string
The authorization type.
- cognitoConfig
-
- Type: CognitoConfig structure
Describes an Amazon Cognito user pool configuration.
- lambdaAuthorizerConfig
-
- Type: LambdaAuthorizerConfig structure
A
LambdaAuthorizerConfig
specifies how to authorize AppSync API access when using theAWS_LAMBDA
authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a time. - openIDConnectConfig
-
- Type: OpenIDConnectConfig structure
Describes an OpenID Connect (OIDC) configuration.
AuthorizationConfig
Description
The authorization configuration in case the HTTP endpoint requires authorization.
Members
- authorizationType
-
- Required: Yes
- Type: string
The authorization type that the HTTP endpoint requires.
-
AWS_IAM: The authorization type is Signature Version 4 (SigV4).
- awsIamConfig
-
- Type: AwsIamConfig structure
The Identity and Access Management (IAM) settings.
AwsIamConfig
Description
The Identity and Access Management (IAM) configuration.
Members
- signingRegion
-
- Type: string
The signing Amazon Web Services Region for IAM authorization.
- signingServiceName
-
- Type: string
The signing service name for IAM authorization.
BadRequestDetail
Description
Provides further details for the reason behind the bad request. For reason type CODE_ERROR
, the detail will contain a list of code errors.
Members
- codeErrors
-
- Type: Array of CodeError structures
Contains the list of errors in the request.
BadRequestException
Description
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.
Members
- detail
-
- Type: BadRequestDetail structure
Provides further details for the reason behind the bad request. For reason type
CODE_ERROR
, the detail will contain a list of code errors. - message
-
- Type: string
- reason
-
- Type: string
Provides context for the cause of the bad request. The only supported value is
CODE_ERROR
.
CachingConfig
Description
The caching configuration for a resolver that has caching activated.
Members
- cachingKeys
-
- Type: Array of strings
The caching keys for a resolver that has caching activated.
Valid values are entries from the
$context.arguments
,$context.source
, and$context.identity
maps. - ttl
-
- Required: Yes
- Type: long (int|float)
The TTL in seconds for a resolver that has caching activated.
Valid values are 1–3,600 seconds.
ChannelNamespace
Description
Describes a channel namespace associated with an Api
. The ChannelNamespace
contains the definitions for code handlers for the Api
.
Members
- apiId
-
- Type: string
The
Api
ID. - channelNamespaceArn
-
- Type: string
The Amazon Resource Name (ARN) for the
ChannelNamespace
. - codeHandlers
-
- Type: string
The event handler functions that run custom business logic to process published events and subscribe requests.
- created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the
ChannelNamespace
was created. - lastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the
ChannelNamespace
was last changed. - name
-
- Type: string
The name of the channel namespace. This name must be unique within the
Api
. - publishAuthModes
-
- Type: Array of AuthMode structures
The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default
Api
authorization configuration. - subscribeAuthModes
-
- Type: Array of AuthMode structures
The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default
Api
authorization configuration. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A map with keys of
TagKey
objects and values ofTagValue
objects.
CodeError
Description
Describes an AppSync error.
Members
- errorType
-
- Type: string
The type of code error.
Examples include, but aren't limited to:
LINT_ERROR
,PARSER_ERROR
. - location
-
- Type: CodeErrorLocation structure
The line, column, and span location of the error in the code.
- value
-
- Type: string
A user presentable error.
Examples include, but aren't limited to:
Parsing error: Unterminated string literal
.
CodeErrorLocation
Description
Describes the location of the error in a code sample.
Members
- column
-
- Type: int
The column number in the code. Defaults to
0
if unknown. - line
-
- Type: int
The line number in the code. Defaults to
0
if unknown. - span
-
- Type: int
The span/length of the error. Defaults to
-1
if unknown.
CognitoConfig
Description
Describes an Amazon Cognito configuration.
Members
- appIdClientRegex
-
- Type: string
A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.
- awsRegion
-
- Required: Yes
- Type: string
The Amazon Web Services Region in which the user pool was created.
- userPoolId
-
- Required: Yes
- Type: string
The user pool ID.
CognitoUserPoolConfig
Description
Describes an Amazon Cognito user pool configuration.
Members
- appIdClientRegex
-
- Type: string
A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.
- awsRegion
-
- Required: Yes
- Type: string
The Amazon Web Services Region in which the user pool was created.
- userPoolId
-
- Required: Yes
- Type: string
The user pool ID.
ConcurrentModificationException
Description
Another modification is in progress at this time and it must complete before you can make your change.
Members
- message
-
- Type: string
ConflictException
Description
A conflict with a previous successful update is detected. This typically occurs when the previous update did not have time to propagate before the next update was made. A retry (with appropriate backoff logic) is the recommended response to this exception.
Members
- message
-
- Type: string
DataSource
Description
Describes a data source.
Members
- dataSourceArn
-
- Type: string
The data source Amazon Resource Name (ARN).
- description
-
- Type: string
The description of the data source.
- dynamodbConfig
-
- Type: DynamodbDataSourceConfig structure
DynamoDB settings.
- elasticsearchConfig
-
- Type: ElasticsearchDataSourceConfig structure
Amazon OpenSearch Service settings.
- eventBridgeConfig
-
- Type: EventBridgeDataSourceConfig structure
Amazon EventBridge settings.
- httpConfig
-
- Type: HttpDataSourceConfig structure
HTTP endpoint settings.
- lambdaConfig
-
- Type: LambdaDataSourceConfig structure
Lambda settings.
- metricsConfig
-
- Type: string
Enables or disables enhanced data source metrics for specified data sources. Note that
metricsConfig
won't be used unless thedataSourceLevelMetricsBehavior
value is set toPER_DATA_SOURCE_METRICS
. If thedataSourceLevelMetricsBehavior
is set toFULL_REQUEST_DATA_SOURCE_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
. - name
-
- Type: string
The name of the data source.
- openSearchServiceConfig
-
- Type: OpenSearchServiceDataSourceConfig structure
Amazon OpenSearch Service settings.
- relationalDatabaseConfig
-
- Type: RelationalDatabaseDataSourceConfig structure
Relational database settings.
- serviceRoleArn
-
- Type: string
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.
- type
-
- Type: string
The type of the data source.
-
AWS_LAMBDA: The data source is an Lambda function.
-
AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
-
AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
-
NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
-
HTTP: The data source is an HTTP endpoint.
-
RELATIONAL_DATABASE: The data source is a relational database.
DataSourceIntrospectionModel
Description
Contains the introspected data that was retrieved from the data source.
Members
- fields
-
- Type: Array of DataSourceIntrospectionModelField structures
The
DataSourceIntrospectionModelField
object data. - indexes
-
- Type: Array of DataSourceIntrospectionModelIndex structures
The array of
DataSourceIntrospectionModelIndex
objects. - name
-
- Type: string
The name of the model. For example, this could be the name of a single table in a database.
- primaryKey
-
- Type: DataSourceIntrospectionModelIndex structure
The primary key stored as a
DataSourceIntrospectionModelIndex
object. - sdl
-
- Type: string
Contains the output of the SDL that was generated from the introspected types. This is controlled by the
includeModelsSDL
parameter of theGetDataSourceIntrospection
operation.
DataSourceIntrospectionModelField
Description
Represents the fields that were retrieved from the introspected data.
Members
- length
-
- Type: long (int|float)
The length value of the introspected field.
- name
-
- Type: string
The name of the field that was retrieved from the introspected data.
- type
-
- Type: DataSourceIntrospectionModelFieldType structure
The
DataSourceIntrospectionModelFieldType
object data.
DataSourceIntrospectionModelFieldType
Description
Represents the type data for each field retrieved from the introspection.
Members
- kind
-
- Type: string
Specifies the classification of data. For example, this could be set to values like
Scalar
orNonNull
to indicate a fundamental property of the field.Valid values include:
-
Scalar
: Indicates the value is a primitive type (scalar). -
NonNull
: Indicates the field cannot benull
. -
List
: Indicates the field contains a list.
- name
-
- Type: string
The name of the data type that represents the field. For example,
String
is a validname
value. - type
-
- Type: DataSourceIntrospectionModelFieldType structure
The
DataSourceIntrospectionModelFieldType
object data. Thetype
is only present ifDataSourceIntrospectionModelFieldType.kind
is set toNonNull
orList
.The
type
typically contains its ownkind
andname
fields to represent the actual type data. For instance,type
could contain akind
value ofScalar
with aname
value ofString
. The valuesScalar
andString
will be collectively stored in thevalues
field. - values
-
- Type: Array of strings
The values of the
type
field. This field represents the AppSync data type equivalent of the introspected field.
DataSourceIntrospectionModelIndex
Description
The index that was retrieved from the introspected data.
Members
- fields
-
- Type: Array of strings
The fields of the index.
- name
-
- Type: string
The name of the index.
DataSourceIntrospectionResult
Description
Represents the output of a DataSourceIntrospectionResult
. This is the populated result of a GetDataSourceIntrospection
operation.
Members
- models
-
- Type: Array of DataSourceIntrospectionModel structures
The array of
DataSourceIntrospectionModel
objects. - nextToken
-
- Type: string
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.
DeltaSyncConfig
Description
Describes a Delta Sync configuration.
Members
- baseTableTTL
-
- Type: long (int|float)
The number of minutes that an Item is stored in the data source.
- deltaSyncTableName
-
- Type: string
The Delta Sync table name.
- deltaSyncTableTTL
-
- Type: long (int|float)
The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
DomainNameConfig
Description
Describes a configuration for a custom domain.
Members
- appsyncDomainName
-
- Type: string
The domain name that AppSync provides.
- certificateArn
-
- Type: string
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
- description
-
- Type: string
A description of the
DomainName
configuration. - domainName
-
- Type: string
The domain name.
- hostedZoneId
-
- Type: string
The ID of your Amazon Route 53 hosted zone.
DynamodbDataSourceConfig
Description
Describes an Amazon DynamoDB data source configuration.
Members
- awsRegion
-
- Required: Yes
- Type: string
The Amazon Web Services Region.
- deltaSyncConfig
-
- Type: DeltaSyncConfig structure
The
DeltaSyncConfig
for a versioned data source. - tableName
-
- Required: Yes
- Type: string
The table name.
- useCallerCredentials
-
- Type: boolean
Set to TRUE to use Amazon Cognito credentials with this data source.
- versioned
-
- Type: boolean
Set to TRUE to use Conflict Detection and Resolution with this data source.
ElasticsearchDataSourceConfig
Description
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.
Members
- awsRegion
-
- Required: Yes
- Type: string
The Amazon Web Services Region.
- endpoint
-
- Required: Yes
- Type: string
The endpoint.
EnhancedMetricsConfig
Description
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
Enhanced metrics can be configured at the resolver, data source, and operation levels. EnhancedMetricsConfig
contains three required parameters, each controlling one of these categories:
-
resolverLevelMetricsBehavior
: Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:-
GraphQL errors: The number of GraphQL errors that occurred.
-
Requests: The number of invocations that occurred during a request.
-
Latency: The time to complete a resolver invocation.
-
Cache hits: The number of cache hits during a request.
-
Cache misses: The number of cache misses during a request.
These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name.
resolverLevelMetricsBehavior
accepts one of these values at a time:-
FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers in the request. -
PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have themetricsConfig
value set toENABLED
.
-
-
dataSourceLevelMetricsBehavior
: Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:-
Requests: The number of invocations that occured during a request.
-
Latency: The time to complete a data source invocation.
-
Errors: The number of errors that occurred during a data source invocation.
These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name.
dataSourceLevelMetricsBehavior
accepts one of these values at a time:-
FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data sources in the request. -
PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that have themetricsConfig
value set toENABLED
.
-
-
operationLevelMetricsConfig
: Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:-
Requests: The number of times a specified GraphQL operation was called.
-
GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.
Metrics will be recorded by API ID and operation name. You can set the value to
ENABLED
orDISABLED
. -
Members
- dataSourceLevelMetricsBehavior
-
- Required: Yes
- Type: string
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
-
Requests: The number of invocations that occured during a request.
-
Latency: The time to complete a data source invocation.
-
Errors: The number of errors that occurred during a data source invocation.
These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name.
dataSourceLevelMetricsBehavior
accepts one of these values at a time:-
FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data sources in the request. -
PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that have themetricsConfig
value set toENABLED
.
- operationLevelMetricsConfig
-
- Required: Yes
- Type: string
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
-
Requests: The number of times a specified GraphQL operation was called.
-
GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.
Metrics will be recorded by API ID and operation name. You can set the value to
ENABLED
orDISABLED
. - resolverLevelMetricsBehavior
-
- Required: Yes
- Type: string
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
-
GraphQL errors: The number of GraphQL errors that occurred.
-
Requests: The number of invocations that occurred during a request.
-
Latency: The time to complete a resolver invocation.
-
Cache hits: The number of cache hits during a request.
-
Cache misses: The number of cache misses during a request.
These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name.
resolverLevelMetricsBehavior
accepts one of these values at a time:-
FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers in the request. -
PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have themetricsConfig
value set toENABLED
.
ErrorDetail
Description
Contains the list of errors generated. When using JavaScript, this will apply to the request or response function evaluation.
Members
- message
-
- Type: string
The error payload.
EvaluateCodeErrorDetail
Description
Contains the list of errors from a code evaluation response.
Members
- codeErrors
-
- Type: Array of CodeError structures
Contains the list of
CodeError
objects. - message
-
- Type: string
The error payload.
EventBridgeDataSourceConfig
Description
Describes an Amazon EventBridge bus data source configuration.
Members
- eventBusArn
-
- Required: Yes
- Type: string
The ARN of the event bus. For more information about event buses, see Amazon EventBridge event buses.
EventConfig
Description
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
Members
- authProviders
-
- Required: Yes
- Type: Array of AuthProvider structures
A list of authorization providers.
- connectionAuthModes
-
- Required: Yes
- Type: Array of AuthMode structures
A list of valid authorization modes for the Event API connections.
- defaultPublishAuthModes
-
- Required: Yes
- Type: Array of AuthMode structures
A list of valid authorization modes for the Event API publishing.
- defaultSubscribeAuthModes
-
- Required: Yes
- Type: Array of AuthMode structures
A list of valid authorization modes for the Event API subscriptions.
- logConfig
-
- Type: EventLogConfig structure
The CloudWatch Logs configuration for the Event API.
EventLogConfig
Description
Describes the CloudWatch Logs configuration for the Event API.
Members
- cloudWatchLogsRoleArn
-
- Required: Yes
- Type: string
The IAM service role that AppSync assumes to publish CloudWatch Logs in your account.
- logLevel
-
- Required: Yes
- Type: string
The type of information to log for the Event API.
FunctionConfiguration
Description
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
Members
- code
-
- Type: string
The
function
code that contains the request and response functions. When code is used, theruntime
is required. Theruntime
value must beAPPSYNC_JS
. - dataSourceName
-
- Type: string
The name of the
DataSource
. - description
-
- Type: string
The
Function
description. - functionArn
-
- Type: string
The Amazon Resource Name (ARN) of the
Function
object. - functionId
-
- Type: string
A unique ID representing the
Function
object. - functionVersion
-
- Type: string
The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
- maxBatchSize
-
- Type: int
The maximum batching size for a resolver.
- name
-
- Type: string
The name of the
Function
object. - requestMappingTemplate
-
- Type: string
The
Function
request mapping template. Functions support only the 2018-05-29 version of the request mapping template. - responseMappingTemplate
-
- Type: string
The
Function
response mapping template. - runtime
-
- Type: AppSyncRuntime structure
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.
- syncConfig
-
- Type: SyncConfig structure
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
GraphQLSchemaException
Description
The GraphQL schema is not valid.
Members
- message
-
- Type: string
GraphqlApi
Description
Describes a GraphQL API.
Members
- additionalAuthenticationProviders
-
- Type: Array of AdditionalAuthenticationProvider structures
A list of additional authentication providers for the
GraphqlApi
API. - apiId
-
- Type: string
The API ID.
- apiType
-
- Type: string
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL
) or merged API (MERGED
). - arn
-
- Type: string
The Amazon Resource Name (ARN).
- authenticationType
-
- Type: string
The authentication type.
- dns
-
- Type: Associative array of custom strings keys (String) to strings
The DNS records for the API.
- enhancedMetricsConfig
-
- Type: EnhancedMetricsConfig structure
The
enhancedMetricsConfig
object. - introspectionConfig
-
- Type: string
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 toENABLED
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.
- lambdaAuthorizerConfig
-
- Type: LambdaAuthorizerConfig structure
Configuration for Lambda function authorization.
- logConfig
-
- Type: LogConfig structure
The Amazon CloudWatch Logs configuration.
- mergedApiExecutionRoleArn
-
- Type: string
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. - name
-
- Type: string
The API name.
- openIDConnectConfig
-
- Type: OpenIDConnectConfig structure
The OpenID Connect configuration.
- owner
-
- Type: string
The account owner of the GraphQL API.
- ownerContact
-
- Type: string
The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
- queryDepthLimit
-
- Type: int
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 between1
and75
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.
- resolverCountLimit
-
- Type: int
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 to10000
. When specified, the limit value can be between1
and10000
. This field will produce a limit error if the operation falls out of bounds. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags.
- uris
-
- Type: Associative array of custom strings keys (String) to strings
The URIs.
- userPoolConfig
-
- Type: UserPoolConfig structure
The Amazon Cognito user pool configuration.
- visibility
-
- Type: string
Sets the value of the GraphQL API to public (
GLOBAL
) or private (PRIVATE
). If no value is provided, the visibility will be set toGLOBAL
by default. This value cannot be changed once the API has been created. - wafWebAclArn
-
- Type: string
The ARN of the WAF access control list (ACL) associated with this
GraphqlApi
, if one exists. - xrayEnabled
-
- Type: boolean
A flag indicating whether to use X-Ray tracing for this
GraphqlApi
.
HttpDataSourceConfig
Description
Describes an HTTP data source configuration.
Members
- authorizationConfig
-
- Type: AuthorizationConfig structure
The authorization configuration in case the HTTP endpoint requires authorization.
- endpoint
-
- Type: string
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
Description
An internal AppSync error occurred. Try your request again.
Members
- message
-
- Type: string
LambdaAuthorizerConfig
Description
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.
Members
- authorizerResultTtlInSeconds
-
- Type: int
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 attlOverride
key in its response. - authorizerUri
-
- Required: Yes
- Type: string
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
- identityValidationExpression
-
- Type: string
A regular expression for validation of tokens before the Lambda function is called.
LambdaConflictHandlerConfig
Description
The LambdaConflictHandlerConfig
object when configuring LAMBDA
as the Conflict Handler.
Members
- lambdaConflictHandlerArn
-
- Type: string
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
LambdaDataSourceConfig
Description
Describes an Lambda data source configuration.
Members
- lambdaFunctionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the Lambda function.
LimitExceededException
Description
The request exceeded a limit. Try your request again.
Members
- message
-
- Type: string
LogConfig
Description
The Amazon CloudWatch Logs configuration.
Members
- cloudWatchLogsRoleArn
-
- Required: Yes
- Type: string
The service role that AppSync assumes to publish to CloudWatch logs in your account.
- excludeVerboseContent
-
- Type: boolean
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
- fieldLogLevel
-
- Required: Yes
- Type: string
The field logging level. Values can be NONE, ERROR, or ALL.
-
NONE: No field-level logs are captured.
-
ERROR: Logs the following information only for the fields that are in error:
-
The error section in the server response.
-
Field-level errors.
-
The generated request/response functions that got resolved for error fields.
-
-
ALL: The following information is logged for all fields in the query:
-
Field-level tracing information.
-
The generated request/response functions that got resolved for each field.
-
NotFoundException
Description
The resource specified in the request was not found. Check the resource, and then try again.
Members
- message
-
- Type: string
OpenIDConnectConfig
Description
Describes an OpenID Connect (OIDC) configuration.
Members
- authTTL
-
- Type: long (int|float)
The number of milliseconds that a token is valid after being authenticated.
- clientId
-
- Type: string
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.
- iatTTL
-
- Type: long (int|float)
The number of milliseconds that a token is valid after it's issued to a user.
- issuer
-
- Required: Yes
- Type: string
The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of
iss
in the ID token.
OpenSearchServiceDataSourceConfig
Description
Describes an OpenSearch data source configuration.
Members
- awsRegion
-
- Required: Yes
- Type: string
The Amazon Web Services Region.
- endpoint
-
- Required: Yes
- Type: string
The endpoint.
PipelineConfig
Description
The pipeline configuration for a resolver of kind PIPELINE
.
Members
- functions
-
- Type: Array of strings
A list of
Function
objects.
RdsDataApiConfig
Description
Contains the metadata required to introspect the RDS cluster.
Members
- databaseName
-
- Required: Yes
- Type: string
The name of the database in the cluster.
- resourceArn
-
- Required: Yes
- Type: string
The resource ARN of the RDS cluster.
- secretArn
-
- Required: Yes
- Type: string
The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN, secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation data.
RdsHttpEndpointConfig
Description
The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.
Members
- awsRegion
-
- Type: string
Amazon Web Services Region for Amazon RDS HTTP endpoint.
- awsSecretStoreArn
-
- Type: string
Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.
- databaseName
-
- Type: string
Logical database name.
- dbClusterIdentifier
-
- Type: string
Amazon RDS cluster Amazon Resource Name (ARN).
- schema
-
- Type: string
Logical schema name.
RelationalDatabaseDataSourceConfig
Description
Describes a relational database data source configuration.
Members
- rdsHttpEndpointConfig
-
- Type: RdsHttpEndpointConfig structure
Amazon RDS HTTP endpoint settings.
- relationalDatabaseSourceType
-
- Type: string
Source type for the relational database.
-
RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
Resolver
Description
Describes a resolver.
Members
- cachingConfig
-
- Type: CachingConfig structure
The caching configuration for the resolver.
- code
-
- Type: string
The
resolver
code that contains the request and response functions. When code is used, theruntime
is required. Theruntime
value must beAPPSYNC_JS
. - dataSourceName
-
- Type: string
The resolver data source name.
- fieldName
-
- Type: string
The resolver field name.
- kind
-
- Type: 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.
- maxBatchSize
-
- Type: int
The maximum batching size for a resolver.
- metricsConfig
-
- Type: string
Enables or disables enhanced resolver metrics for specified resolvers. Note that
metricsConfig
won't be used unless theresolverLevelMetricsBehavior
value is set toPER_RESOLVER_METRICS
. If theresolverLevelMetricsBehavior
is set toFULL_REQUEST_RESOLVER_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
. - pipelineConfig
-
- Type: PipelineConfig structure
The
PipelineConfig
. - requestMappingTemplate
-
- Type: string
The request mapping template.
- resolverArn
-
- Type: string
The resolver Amazon Resource Name (ARN).
- responseMappingTemplate
-
- Type: string
The response mapping template.
- runtime
-
- Type: AppSyncRuntime structure
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.
- syncConfig
-
- Type: SyncConfig structure
The
SyncConfig
for a resolver attached to a versioned data source. - typeName
-
- Type: string
The resolver type name.
ServiceQuotaExceededException
Description
The operation exceeded the service quota for this resource.
Members
- message
-
- Type: string
SourceApiAssociation
Description
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.
Members
- associationArn
-
- Type: string
The Amazon Resource Name (ARN) of the source API association.
- associationId
-
- Type: string
The ID generated by the AppSync service for the source API association.
- description
-
- Type: string
The description field.
- lastSuccessfulMergeDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- mergedApiArn
-
- Type: string
The Amazon Resource Name (ARN) of the AppSync Merged API.
- mergedApiId
-
- Type: string
The ID of the AppSync Merged API.
- sourceApiArn
-
- Type: string
The Amazon Resource Name (ARN) of the AppSync source API.
- sourceApiAssociationConfig
-
- Type: SourceApiAssociationConfig structure
The
SourceApiAssociationConfig
object data. - sourceApiAssociationStatus
-
- Type: string
The state of the source API association.
- sourceApiAssociationStatusDetail
-
- Type: string
The detailed message related to the current state of the source API association.
- sourceApiId
-
- Type: string
The ID of the AppSync source API.
SourceApiAssociationConfig
Description
Describes properties used to specify configurations related to a source API.
Members
- mergeType
-
- Type: string
The property that indicates which merging option is enabled in the source API association.
Valid merge types are
MANUAL_MERGE
(default) andAUTO_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 useMergedApiExecutionRoleArn
to perform merge operations.
SourceApiAssociationSummary
Description
Describes the ARNs and IDs of associations, Merged APIs, and source APIs.
Members
- associationArn
-
- Type: string
The Amazon Resource Name (ARN) of the source API association.
- associationId
-
- Type: string
The ID generated by the AppSync service for the source API association.
- description
-
- Type: string
The description field.
- mergedApiArn
-
- Type: string
The Amazon Resource Name (ARN) of the AppSync Merged API.
- mergedApiId
-
- Type: string
The ID of the AppSync Merged API.
- sourceApiArn
-
- Type: string
The Amazon Resource Name (ARN) of the AppSync Source API.
- sourceApiId
-
- Type: string
The ID of the AppSync source API.
SyncConfig
Description
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
Members
- conflictDetection
-
- Type: string
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.
- conflictHandler
-
- Type: string
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
.
- lambdaConflictHandlerConfig
-
- Type: LambdaConflictHandlerConfig structure
The
LambdaConflictHandlerConfig
when configuringLAMBDA
as the Conflict Handler.
Type
Description
Describes a type.
Members
- arn
-
- Type: string
The type Amazon Resource Name (ARN).
- definition
-
- Type: string
The type definition.
- description
-
- Type: string
The type description.
- format
-
- Type: string
The type format: SDL or JSON.
- name
-
- Type: string
The type name.
UnauthorizedException
Description
You aren't authorized to perform this operation.
Members
- message
-
- Type: string
UserPoolConfig
Description
Describes an Amazon Cognito user pool configuration.
Members
- appIdClientRegex
-
- Type: string
A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.
- awsRegion
-
- Required: Yes
- Type: string
The Amazon Web Services Region in which the user pool was created.
- defaultAction
-
- Required: Yes
- Type: string
The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.
- userPoolId
-
- Required: Yes
- Type: string
The user pool ID.