AWS SDK for PHP 3.x (original) (raw)

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

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.

An internal AppSync error occurred. Try your request again.

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

AssociateMergedGraphqlApi

result=result = result=client->associateMergedGraphqlApi([/* ... /]); promise=promise = promise=client->associateMergedGraphqlApiAsync([/ ... */]);

Creates an association between a Merged API and source API using the source API's identifier.

Parameter Syntax

result=result = result=client->associateMergedGraphqlApi([ 'description' => '', 'mergedApiIdentifier' => '', // REQUIRED 'sourceApiAssociationConfig' => [ 'mergeType' => 'MANUAL_MERGE|AUTO_MERGE', ], 'sourceApiIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

description

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' => '', 'associationId' => '', 'description' => '', 'lastSuccessfulMergeDate' => , 'mergedApiArn' => '', 'mergedApiId' => '', 'sourceApiArn' => '', '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' => '', 'sourceApiId' => '', ], ]

Result Details

Members

sourceApiAssociation

Type: SourceApiAssociation structure

The SourceApiAssociation object data.

Errors

You aren't authorized to perform this operation.

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.

An internal AppSync error occurred. Try your request again.

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

The request exceeded a limit. Try your request again.

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

AssociateSourceGraphqlApi

result=result = result=client->associateSourceGraphqlApi([/* ... /]); promise=promise = promise=client->associateSourceGraphqlApiAsync([/ ... */]);

Creates an association between a Merged API and source API using the Merged API's identifier.

Parameter Syntax

result=result = result=client->associateSourceGraphqlApi([ 'description' => '', 'mergedApiIdentifier' => '', // REQUIRED 'sourceApiAssociationConfig' => [ 'mergeType' => 'MANUAL_MERGE|AUTO_MERGE', ], 'sourceApiIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

description

The description field.

mergedApiIdentifier

Required: Yes

Type: string

sourceApiAssociationConfig

Type: SourceApiAssociationConfig structure

The SourceApiAssociationConfig object data.

sourceApiIdentifier

Required: Yes

Type: string

Result Syntax

Result Details

Members

sourceApiAssociation

Type: SourceApiAssociation structure

The SourceApiAssociation object data.

Errors

You aren't authorized to perform this operation.

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.

An internal AppSync error occurred. Try your request again.

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

The request exceeded a limit. Try your request again.

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

CreateApi

result=result = result=client->createApi([/* ... /]); promise=promise = 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=result = result=client->createApi([ 'eventConfig' => [ 'authProviders' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED 'cognitoConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', // REQUIRED 'userPoolId' => '', // REQUIRED ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => , 'authorizerUri' => '', // REQUIRED 'identityValidationExpression' => '', ], 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', // 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' => '', // REQUIRED 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED ], ], 'name' => '', // REQUIRED 'ownerContact' => '', 'tags' => ['', ...], ]);

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

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 of TagValue objects.

Result Syntax

[ 'api' => [ 'apiArn' => '', 'apiId' => '', 'created' => , 'dns' => ['', ...], 'eventConfig' => [ 'authProviders' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'cognitoConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', 'userPoolId' => '', ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => , 'authorizerUri' => '', 'identityValidationExpression' => '', ], 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', ], ], // ... ], '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' => '', 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], ], 'name' => '', 'ownerContact' => '', 'tags' => ['', ...], 'wafWebAclArn' => '', 'xrayEnabled' => true || false, ], ]

Result Details

Members

api

The Api object.

Errors

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

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

You aren't authorized to perform this operation.

ServiceQuotaExceededException:

An internal AppSync error occurred. Try your request again.

The operation exceeded the service quota for this resource.

CreateApiCache

result=result = result=client->createApiCache([/* ... /]); promise=promise = promise=client->createApiCacheAsync([/ ... */]);

Creates a cache for the GraphQL API.

Parameter Syntax

result=result = result=client->createApiCache([ 'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING|OPERATION_LEVEL_CACHING', // REQUIRED 'apiId' => '', // REQUIRED 'atRestEncryptionEnabled' => true || false, 'healthMetricsConfig' => 'ENABLED|DISABLED', 'transitEncryptionEnabled' => true || false, 'ttl' => , // 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 from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.

apiId

Required: Yes

Type: string

The GraphQL API ID.

atRestEncryptionEnabled

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

healthMetricsConfig

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.

transitEncryptionEnabled

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|OPERATION_LEVEL_CACHING', 'atRestEncryptionEnabled' => true || false, 'healthMetricsConfig' => 'ENABLED|DISABLED', 'status' => 'AVAILABLE|CREATING|DELETING|MODIFYING|FAILED', 'transitEncryptionEnabled' => true || false, 'ttl' => , '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

The ApiCache object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

CreateApiKey

result=result = result=client->createApiKey([/* ... /]); promise=promise = promise=client->createApiKeyAsync([/ ... */]);

Creates a unique key that you can distribute to clients who invoke your API.

Parameter Syntax

result=result = result=client->createApiKey([ 'apiId' => '', // REQUIRED 'description' => '', 'expires' => , ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The ID for your GraphQL API.

description

A description of the purpose of the API key.

expires

From the creation time, the time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .

Result Syntax

[ 'apiKey' => [ 'deletes' => , 'description' => '', 'expires' => , 'id' => '', ], ]

Result Details

Members

apiKey

The API key.

Errors

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

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

The request exceeded a limit. Try your request again.

You aren't authorized to perform this operation.

The request exceeded a limit. Try your request again.

ApiKeyLimitExceededException:

An internal AppSync error occurred. Try your request again.

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 (for UpdateApiKey).

CreateChannelNamespace

result=result = result=client->createChannelNamespace([/* ... /]); promise=promise = promise=client->createChannelNamespaceAsync([/ ... */]);

Creates a ChannelNamespace for an Api.

Parameter Syntax

result=result = result=client->createChannelNamespace([ 'apiId' => '', // REQUIRED 'codeHandlers' => '', 'handlerConfigs' => [ 'onPublish' => [ 'behavior' => 'CODE|DIRECT', // REQUIRED 'integration' => [ // REQUIRED 'dataSourceName' => '', // REQUIRED 'lambdaConfig' => [ 'invokeType' => 'REQUEST_RESPONSE|EVENT', ], ], ], 'onSubscribe' => [ 'behavior' => 'CODE|DIRECT', // REQUIRED 'integration' => [ // REQUIRED 'dataSourceName' => '', // REQUIRED 'lambdaConfig' => [ 'invokeType' => 'REQUEST_RESPONSE|EVENT', ], ], ], ], 'name' => '', // 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' => ['', ...], ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The Api ID.

codeHandlers

The event handler functions that run custom business logic to process published events and subscribe requests.

handlerConfigs

Type: HandlerConfigs structure

The configuration for the OnPublish and OnSubscribe handlers.

name

Required: Yes

Type: string

The name of the ChannelNamespace. 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 of TagValue objects.

Result Syntax

[ 'channelNamespace' => [ 'apiId' => '', 'channelNamespaceArn' => '', 'codeHandlers' => '', 'created' => , 'handlerConfigs' => [ 'onPublish' => [ 'behavior' => 'CODE|DIRECT', 'integration' => [ 'dataSourceName' => '', 'lambdaConfig' => [ 'invokeType' => 'REQUEST_RESPONSE|EVENT', ], ], ], 'onSubscribe' => [ 'behavior' => 'CODE|DIRECT', 'integration' => [ 'dataSourceName' => '', 'lambdaConfig' => [ 'invokeType' => 'REQUEST_RESPONSE|EVENT', ], ], ], ], 'lastModified' => , 'name' => '', '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' => ['', ...], ], ]

Result Details

Members

channelNamespace

Type: ChannelNamespace structure

The ChannelNamespace object.

Errors

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

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.

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

You aren't authorized to perform this operation.

ServiceQuotaExceededException:

An internal AppSync error occurred. Try your request again.

The operation exceeded the service quota for this resource.

CreateDataSource

result=result = result=client->createDataSource([/* ... /]); promise=promise = promise=client->createDataSourceAsync([/ ... */]);

Creates a DataSource object.

Parameter Syntax

result=result = result=client->createDataSource([ 'apiId' => '', // REQUIRED 'description' => '', 'dynamodbConfig' => [ 'awsRegion' => '', // REQUIRED 'deltaSyncConfig' => [ 'baseTableTTL' => , 'deltaSyncTableName' => '', 'deltaSyncTableTTL' => , ], 'tableName' => '', // REQUIRED 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '', // REQUIRED 'endpoint' => '', // REQUIRED ], 'eventBridgeConfig' => [ 'eventBusArn' => '', // REQUIRED ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', // REQUIRED 'awsIamConfig' => [ 'signingRegion' => '', 'signingServiceName' => '', ], ], 'endpoint' => '', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '', // REQUIRED ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '', // REQUIRED 'openSearchServiceConfig' => [ 'awsRegion' => '', // REQUIRED 'endpoint' => '', // REQUIRED ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '', 'awsSecretStoreArn' => '', 'databaseName' => '', 'dbClusterIdentifier' => '', 'schema' => '', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '', '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

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

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

metricsConfig can be ENABLED or DISABLED.

name

Required: Yes

Type: string

A user-supplied name for the DataSource.

openSearchServiceConfig

Amazon OpenSearch Service settings.

relationalDatabaseConfig

Relational database settings.

serviceRoleArn

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

type

Required: Yes

Type: string

The type of the DataSource.

Result Syntax

[ 'dataSource' => [ 'dataSourceArn' => '', 'description' => '', 'dynamodbConfig' => [ 'awsRegion' => '', 'deltaSyncConfig' => [ 'baseTableTTL' => , 'deltaSyncTableName' => '', 'deltaSyncTableTTL' => , ], 'tableName' => '', 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '', 'endpoint' => '', ], 'eventBridgeConfig' => [ 'eventBusArn' => '', ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', 'awsIamConfig' => [ 'signingRegion' => '', 'signingServiceName' => '', ], ], 'endpoint' => '', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '', ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '', 'openSearchServiceConfig' => [ 'awsRegion' => '', 'endpoint' => '', ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '', 'awsSecretStoreArn' => '', 'databaseName' => '', 'dbClusterIdentifier' => '', 'schema' => '', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '', '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

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.

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

CreateDomainName

result=result = result=client->createDomainName([/* ... /]); promise=promise = promise=client->createDomainNameAsync([/ ... */]);

Creates a custom DomainName object.

Parameter Syntax

result=result = result=client->createDomainName([ 'certificateArn' => '', // REQUIRED 'description' => '', 'domainName' => '', // REQUIRED 'tags' => ['', ...], ]);

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

A description of the DomainName.

domainName

Required: Yes

Type: string

The domain name.

tags

Type: Associative array of custom strings keys (TagKey) to strings

A map with keys of TagKey objects and values of TagValue objects.

Result Syntax

[ 'domainNameConfig' => [ 'appsyncDomainName' => '', 'certificateArn' => '', 'description' => '', 'domainName' => '', 'domainNameArn' => '', 'hostedZoneId' => '', 'tags' => ['', ...], ], ]

Result Details

Members

domainNameConfig

Type: DomainNameConfig structure

The configuration for the DomainName.

Errors

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

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.

An internal AppSync error occurred. Try your request again.

CreateFunction

result=result = result=client->createFunction([/* ... /]); promise=promise = 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=result = result=client->createFunction([ 'apiId' => '', // REQUIRED 'code' => '', 'dataSourceName' => '', // REQUIRED 'description' => '', 'functionVersion' => '', 'maxBatchSize' => , 'name' => '', // REQUIRED 'requestMappingTemplate' => '', 'responseMappingTemplate' => '', 'runtime' => [ 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '', // REQUIRED ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '', ], ], ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The GraphQL API ID.

code

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

dataSourceName

Required: Yes

Type: string

The Function DataSource name.

description

The Function description.

functionVersion

The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.

maxBatchSize

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

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

responseMappingTemplate

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' => '', 'dataSourceName' => '', 'description' => '', 'functionArn' => '', 'functionId' => '', 'functionVersion' => '', 'maxBatchSize' => , 'name' => '', 'requestMappingTemplate' => '', 'responseMappingTemplate' => '', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '', ], ], ], ]

Result Details

Members

functionConfiguration

Type: FunctionConfiguration structure

The Function object.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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=result = result=client->createGraphqlApi([/* ... /]); promise=promise = promise=client->createGraphqlApiAsync([/ ... */]);

Creates a GraphqlApi object.

Parameter Syntax

result=result = result=client->createGraphqlApi([ 'additionalAuthenticationProviders' => [ [ 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => , 'authorizerUri' => '', // REQUIRED 'identityValidationExpression' => '', ], 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', // REQUIRED ], 'userPoolConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', // REQUIRED 'userPoolId' => '', // 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' => , 'authorizerUri' => '', // REQUIRED 'identityValidationExpression' => '', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '', // REQUIRED 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED ], 'mergedApiExecutionRoleArn' => '', 'name' => '', // REQUIRED 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', // REQUIRED ], 'ownerContact' => '', 'queryDepthLimit' => , 'resolverCountLimit' => , 'tags' => ['', ...], 'userPoolConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', // REQUIRED 'defaultAction' => 'ALLOW|DENY', // REQUIRED 'userPoolId' => '', // 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

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

Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection.

lambdaAuthorizerConfig

Type: LambdaAuthorizerConfig structure

Configuration for Lambda function authorization.

logConfig

Type: LogConfig structure

The Amazon CloudWatch Logs configuration.

mergedApiExecutionRoleArn

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

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

queryDepthLimit

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

resolverCountLimit

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

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

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

xrayEnabled

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' => , 'authorizerUri' => '', 'identityValidationExpression' => '', ], 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', ], 'userPoolConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', 'userPoolId' => '', ], ], // ... ], 'apiId' => '', 'apiType' => 'GRAPHQL|MERGED', 'arn' => '', 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'dns' => ['', ...], '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' => , 'authorizerUri' => '', 'identityValidationExpression' => '', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '', 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], 'mergedApiExecutionRoleArn' => '', 'name' => '', 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', ], 'owner' => '', 'ownerContact' => '', 'queryDepthLimit' => , 'resolverCountLimit' => , 'tags' => ['', ...], 'uris' => ['', ...], 'userPoolConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', 'defaultAction' => 'ALLOW|DENY', 'userPoolId' => '', ], 'visibility' => 'GLOBAL|PRIVATE', 'wafWebAclArn' => '', 'xrayEnabled' => true || false, ], ]

Result Details

Members

graphqlApi

Type: GraphqlApi structure

The GraphqlApi.

Errors

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

The request exceeded a limit. Try your request again.

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

You aren't authorized to perform this operation.

ApiLimitExceededException:

An internal AppSync error occurred. Try your request again.

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

CreateResolver

result=result = result=client->createResolver([/* ... /]); promise=promise = 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=result = result=client->createResolver([ 'apiId' => '', // REQUIRED 'cachingConfig' => [ 'cachingKeys' => ['', ...], 'ttl' => , // REQUIRED ], 'code' => '', 'dataSourceName' => '', 'fieldName' => '', // REQUIRED 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => , 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['', ...], ], 'requestMappingTemplate' => '', 'responseMappingTemplate' => '', 'runtime' => [ 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '', // REQUIRED ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '', ], ], 'typeName' => '', // 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

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

dataSourceName

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

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

The maximum batching size for a resolver.

metricsConfig

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

metricsConfig can be ENABLED or DISABLED.

pipelineConfig

Type: PipelineConfig structure

The PipelineConfig.

requestMappingTemplate

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

The mapping template to use for responses from the data source.

runtime

Type: AppSyncRuntime structure

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' => ['', ...], 'ttl' => , ], 'code' => '', 'dataSourceName' => '', 'fieldName' => '', 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => , 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['', ...], ], 'requestMappingTemplate' => '', 'resolverArn' => '', 'responseMappingTemplate' => '', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '', ], ], 'typeName' => '', ], ]

Result Details

Members

resolver

The Resolver object.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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=result = result=client->createType([/* ... /]); promise=promise = promise=client->createTypeAsync([/ ... */]);

Creates a Type object.

Parameter Syntax

result=result = result=client->createType([ 'apiId' => '', // REQUIRED 'definition' => '', // 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' => '', 'definition' => '', 'description' => '', 'format' => 'SDL|JSON', 'name' => '', ], ]

Result Details

Members

type

The Type object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

DeleteApi

result=result = result=client->deleteApi([/* ... /]); promise=promise = promise=client->deleteApiAsync([/ ... */]);

Deletes an Api object

Parameter Syntax

result=result = result=client->deleteApi([ 'apiId' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The Api ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

DeleteApiCache

result=result = result=client->deleteApiCache([/* ... /]); promise=promise = promise=client->deleteApiCacheAsync([/ ... */]);

Deletes an ApiCache object.

Parameter Syntax

result=result = result=client->deleteApiCache([ 'apiId' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

DeleteApiKey

result=result = result=client->deleteApiKey([/* ... /]); promise=promise = promise=client->deleteApiKeyAsync([/ ... */]);

Deletes an API key.

Parameter Syntax

result=result = result=client->deleteApiKey([ 'apiId' => '', // REQUIRED 'id' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

Required: Yes

Type: string

The ID for the API key.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

DeleteChannelNamespace

result=result = result=client->deleteChannelNamespace([/* ... /]); promise=promise = promise=client->deleteChannelNamespaceAsync([/ ... */]);

Deletes a ChannelNamespace.

Parameter Syntax

result=result = result=client->deleteChannelNamespace([ 'apiId' => '', // REQUIRED 'name' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The ID of the Api associated with the ChannelNamespace.

name

Required: Yes

Type: string

The name of the ChannelNamespace.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

DeleteDataSource

result=result = result=client->deleteDataSource([/* ... /]); promise=promise = promise=client->deleteDataSourceAsync([/ ... */]);

Deletes a DataSource object.

Parameter Syntax

result=result = result=client->deleteDataSource([ 'apiId' => '', // REQUIRED 'name' => '', // 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

The results for this operation are always empty.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

DeleteDomainName

result=result = result=client->deleteDomainName([/* ... /]); promise=promise = promise=client->deleteDomainNameAsync([/ ... */]);

Deletes a custom DomainName object.

Parameter Syntax

result=result = result=client->deleteDomainName([ 'domainName' => '', // REQUIRED ]);

Parameter Details

Members

domainName

Required: Yes

Type: string

The domain name.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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.

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

An internal AppSync error occurred. Try your request again.

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

DeleteFunction

result=result = result=client->deleteFunction([/* ... /]); promise=promise = promise=client->deleteFunctionAsync([/ ... */]);

Deletes a Function.

Parameter Syntax

result=result = result=client->deleteFunction([ 'apiId' => '', // REQUIRED 'functionId' => '', // 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

The results for this operation are always empty.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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=result = result=client->deleteGraphqlApi([/* ... /]); promise=promise = promise=client->deleteGraphqlApiAsync([/ ... */]);

Deletes a GraphqlApi object.

Parameter Syntax

result=result = result=client->deleteGraphqlApi([ 'apiId' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

DeleteResolver

result=result = result=client->deleteResolver([/* ... /]); promise=promise = promise=client->deleteResolverAsync([/ ... */]);

Deletes a Resolver object.

Parameter Syntax

result=result = result=client->deleteResolver([ 'apiId' => '', // REQUIRED 'fieldName' => '', // REQUIRED 'typeName' => '', // 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

The results for this operation are always empty.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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=result = result=client->deleteType([/* ... /]); promise=promise = promise=client->deleteTypeAsync([/ ... */]);

Deletes a Type object.

Parameter Syntax

result=result = result=client->deleteType([ 'apiId' => '', // REQUIRED 'typeName' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

typeName

Required: Yes

Type: string

The type name.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

DisassociateApi

result=result = result=client->disassociateApi([/* ... /]); promise=promise = promise=client->disassociateApiAsync([/ ... */]);

Removes an ApiAssociation object from a custom domain.

Parameter Syntax

result=result = result=client->disassociateApi([ 'domainName' => '', // REQUIRED ]);

Parameter Details

Members

domainName

Required: Yes

Type: string

The domain name.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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.

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

An internal AppSync error occurred. Try your request again.

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

DisassociateMergedGraphqlApi

result=result = result=client->disassociateMergedGraphqlApi([/* ... /]); promise=promise = 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=result = result=client->disassociateMergedGraphqlApi([ 'associationId' => '', // REQUIRED 'sourceApiIdentifier' => '', // 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

Result Syntax

Result Details

Members

sourceApiAssociationStatus

The state of the source API association.

Errors

You aren't authorized to perform this operation.

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.

An internal AppSync error occurred. Try your request again.

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

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

DisassociateSourceGraphqlApi

result=result = result=client->disassociateSourceGraphqlApi([/* ... /]); promise=promise = 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=result = result=client->disassociateSourceGraphqlApi([ 'associationId' => '', // REQUIRED 'mergedApiIdentifier' => '', // 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

Result Syntax

Result Details

Members

sourceApiAssociationStatus

The state of the source API association.

Errors

You aren't authorized to perform this operation.

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.

An internal AppSync error occurred. Try your request again.

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

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

EvaluateCode

result=result = result=client->evaluateCode([/* ... /]); promise=promise = 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=result = result=client->evaluateCode([ 'code' => '', // REQUIRED 'context' => '', // REQUIRED 'function' => '', 'runtime' => [ // REQUIRED 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '', // REQUIRED ], ]);

Parameter Details

Members

code

Required: Yes

Type: string

The code definition to be evaluated. Note that code and runtime are both required for this action. The runtime value must be APPSYNC_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

The function within the code to be evaluated. If provided, the valid values are request and response.

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' => '', 'location' => [ 'column' => , 'line' => , 'span' => , ], 'value' => '', ], // ... ], 'message' => '', ], 'evaluationResult' => '', 'logs' => ['', ...], 'outErrors' => '', 'stash' => '', ]

Result Details

Members

error

Type: EvaluateCodeErrorDetail structure

Contains the payload of the response error.

evaluationResult

The result of the evaluation operation.

logs

A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.

outErrors

The list of runtime errors that are added to the GraphQL operation response.

stash

An object available inside each resolver and function handler. A single stash object lives through a single resolver run. Therefore, you can use the stash to pass arbitrary data across request and response handlers and across functions in a pipeline resolver.

Errors

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

An internal AppSync error occurred. Try your request again.

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=result = result=client->evaluateMappingTemplate([/* ... /]); promise=promise = 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=result = result=client->evaluateMappingTemplate([ 'context' => '', // REQUIRED 'template' => '', // 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' => '', ], 'evaluationResult' => '', 'logs' => ['', ...], 'outErrors' => '', 'stash' => '', ]

Result Details

Members

error

Type: ErrorDetail structure

The ErrorDetail object.

evaluationResult

The mapping template; this can be a request or response template.

logs

A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.

outErrors

The list of runtime errors that are added to the GraphQL operation response.

stash

Errors

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

An internal AppSync error occurred. Try your request again.

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=result = result=client->flushApiCache([/* ... /]); promise=promise = promise=client->flushApiCacheAsync([/ ... */]);

Flushes an ApiCache object.

Parameter Syntax

result=result = result=client->flushApiCache([ 'apiId' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

GetApi

result=result = result=client->getApi([/* ... /]); promise=promise = promise=client->getApiAsync([/ ... */]);

Retrieves an Api object.

Parameter Syntax

result=result = result=client->getApi([ 'apiId' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The Api ID.

Result Syntax

Result Details

Members

api

The Api object.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

GetApiAssociation

result=result = result=client->getApiAssociation([/* ... /]); promise=promise = promise=client->getApiAssociationAsync([/ ... */]);

Retrieves an ApiAssociation object.

Parameter Syntax

result=result = result=client->getApiAssociation([ 'domainName' => '', // REQUIRED ]);

Parameter Details

Members

domainName

Required: Yes

Type: string

The domain name.

Result Syntax

[ 'apiAssociation' => [ 'apiId' => '', 'associationStatus' => 'PROCESSING|FAILED|SUCCESS', 'deploymentDetail' => '', 'domainName' => '', ], ]

Result Details

Members

apiAssociation

Type: ApiAssociation structure

The ApiAssociation object.

Errors

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

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.

An internal AppSync error occurred. Try your request again.

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

GetApiCache

result=result = result=client->getApiCache([/* ... /]); promise=promise = promise=client->getApiCacheAsync([/ ... */]);

Retrieves an ApiCache object.

Parameter Syntax

result=result = result=client->getApiCache([ 'apiId' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

Result Syntax

Result Details

Members

apiCache

The ApiCache object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

GetChannelNamespace

result=result = result=client->getChannelNamespace([/* ... /]); promise=promise = promise=client->getChannelNamespaceAsync([/ ... */]);

Retrieves the channel namespace for a specified Api.

Parameter Syntax

result=result = result=client->getChannelNamespace([ 'apiId' => '', // REQUIRED 'name' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The Api ID.

name

Required: Yes

Type: string

The name of the ChannelNamespace.

Result Syntax

Result Details

Members

channelNamespace

Type: ChannelNamespace structure

The ChannelNamespace object.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

GetDataSource

result=result = result=client->getDataSource([/* ... /]); promise=promise = promise=client->getDataSourceAsync([/ ... */]);

Retrieves a DataSource object.

Parameter Syntax

result=result = result=client->getDataSource([ 'apiId' => '', // REQUIRED 'name' => '', // 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

Members

dataSource

Type: DataSource structure

The DataSource object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

GetDataSourceIntrospection

result=result = result=client->getDataSourceIntrospection([/* ... /]); promise=promise = 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=result = result=client->getDataSourceIntrospection([ 'includeModelsSDL' => true || false, 'introspectionId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

includeModelsSDL

A boolean flag that determines whether SDL should be generated for introspected types. If set to true, each model will contain an sdl property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives.

introspectionId

Required: Yes

Type: string

The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

maxResults

The maximum number of introspected types that will be returned in a single response.

nextToken

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' => '', 'introspectionResult' => [ 'models' => [ [ 'fields' => [ [ 'length' => , 'name' => '', 'type' => [ 'kind' => '', 'name' => '', 'type' => [...], // RECURSIVE 'values' => ['', ...], ], ], // ... ], 'indexes' => [ [ 'fields' => ['', ...], 'name' => '', ], // ... ], 'name' => '', 'primaryKey' => [ 'fields' => ['', ...], 'name' => '', ], 'sdl' => '', ], // ... ], 'nextToken' => '', ], 'introspectionStatus' => 'PROCESSING|FAILED|SUCCESS', 'introspectionStatusDetail' => '', ]

Result Details

Members

introspectionId

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

The status of the introspection during retrieval. By default, when a new instrospection is being retrieved, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail.

introspectionStatusDetail

The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.

Errors

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

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

An internal AppSync error occurred. Try your request again.

GetDomainName

result=result = result=client->getDomainName([/* ... /]); promise=promise = promise=client->getDomainNameAsync([/ ... */]);

Retrieves a custom DomainName object.

Parameter Syntax

result=result = result=client->getDomainName([ 'domainName' => '', // REQUIRED ]);

Parameter Details

Members

domainName

Required: Yes

Type: string

The domain name.

Result Syntax

[ 'domainNameConfig' => [ 'appsyncDomainName' => '', 'certificateArn' => '', 'description' => '', 'domainName' => '', 'domainNameArn' => '', 'hostedZoneId' => '', 'tags' => ['', ...], ], ]

Result Details

Members

domainNameConfig

Type: DomainNameConfig structure

The configuration for the DomainName.

Errors

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

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.

An internal AppSync error occurred. Try your request again.

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

GetFunction

result=result = result=client->getFunction([/* ... /]); promise=promise = promise=client->getFunctionAsync([/ ... */]);

Get a Function.

Parameter Syntax

result=result = result=client->getFunction([ 'apiId' => '', // REQUIRED 'functionId' => '', // 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

Members

functionConfiguration

Type: FunctionConfiguration structure

The Function object.

Errors

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

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

You aren't authorized to perform this operation.

GetGraphqlApi

result=result = result=client->getGraphqlApi([/* ... /]); promise=promise = promise=client->getGraphqlApiAsync([/ ... */]);

Retrieves a GraphqlApi object.

Parameter Syntax

result=result = result=client->getGraphqlApi([ 'apiId' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID for the GraphQL API.

Result Syntax

Result Details

Members

graphqlApi

Type: GraphqlApi structure

The GraphqlApi object.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

GetGraphqlApiEnvironmentVariables

result=result = result=client->getGraphqlApiEnvironmentVariables([/* ... /]); promise=promise = promise=client->getGraphqlApiEnvironmentVariablesAsync([/ ... */]);

Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.

Parameter Syntax

result=result = result=client->getGraphqlApiEnvironmentVariables([ 'apiId' => '', // 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' => ['', ...], ]

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

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.

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

GraphQLSchemaException:

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

GetIntrospectionSchema

result=result = result=client->getIntrospectionSchema([/* ... /]); promise=promise = promise=client->getIntrospectionSchemaAsync([/ ... */]);

Retrieves the introspection schema for a GraphQL API.

Parameter Syntax

result=result = result=client->getIntrospectionSchema([ 'apiId' => '', // 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

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)

Errors

The GraphQL schema is not valid.

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

GetResolver

result=result = result=client->getResolver([/* ... /]); promise=promise = promise=client->getResolverAsync([/ ... */]);

Retrieves a Resolver object.

Parameter Syntax

result=result = result=client->getResolver([ 'apiId' => '', // REQUIRED 'fieldName' => '', // REQUIRED 'typeName' => '', // 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

Result Details

Members

resolver

The Resolver object.

Errors

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

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

You aren't authorized to perform this operation.

GetSchemaCreationStatus

result=result = result=client->getSchemaCreationStatus([/* ... /]); promise=promise = promise=client->getSchemaCreationStatusAsync([/ ... */]);

Retrieves the current status of a schema creation operation.

Parameter Syntax

result=result = result=client->getSchemaCreationStatus([ 'apiId' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

Result Syntax

Result Details

Members

details

Detailed information about the status of the schema creation operation.

status

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

GetSourceApiAssociation

result=result = result=client->getSourceApiAssociation([/* ... /]); promise=promise = promise=client->getSourceApiAssociationAsync([/ ... */]);

Retrieves a SourceApiAssociation object.

Parameter Syntax

result=result = result=client->getSourceApiAssociation([ 'associationId' => '', // REQUIRED 'mergedApiIdentifier' => '', // 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

Result Syntax

Result Details

Members

sourceApiAssociation

Type: SourceApiAssociation structure

The SourceApiAssociation object data.

Errors

You aren't authorized to perform this operation.

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.

An internal AppSync error occurred. Try your request again.

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

GetType

result=result = result=client->getType([/* ... /]); promise=promise = promise=client->getTypeAsync([/ ... */]);

Retrieves a Type object.

Parameter Syntax

result=result = result=client->getType([ 'apiId' => '', // REQUIRED 'format' => 'SDL|JSON', // REQUIRED 'typeName' => '', // 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' => '', 'definition' => '', 'description' => '', 'format' => 'SDL|JSON', 'name' => '', ], ]

Result Details

Members

type

The Type object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListApiKeys

result=result = result=client->listApiKeys([/* ... /]); promise=promise = 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=result = result=client->listApiKeys([ 'apiId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

[ 'apiKeys' => [ [ 'deletes' => , 'description' => '', 'expires' => , 'id' => '', ], // ... ], 'nextToken' => '', ]

Result Details

Members

apiKeys

Type: Array of ApiKey structures

The ApiKey objects.

nextToken

An identifier to pass in the next request to this operation to return the next set of items in the list.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListApis

result=result = result=client->listApis([/* ... /]); promise=promise = 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=result = result=client->listApis([ 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

[ 'apis' => [ [ 'apiArn' => '', 'apiId' => '', 'created' => , 'dns' => ['', ...], 'eventConfig' => [ 'authProviders' => [ [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'cognitoConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', 'userPoolId' => '', ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => , 'authorizerUri' => '', 'identityValidationExpression' => '', ], 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', ], ], // ... ], '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' => '', 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], ], 'name' => '', 'ownerContact' => '', 'tags' => ['', ...], 'wafWebAclArn' => '', 'xrayEnabled' => true || false, ], // ... ], 'nextToken' => '', ]

Result Details

Members

apis

Type: Array of Api structures

The Api objects.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Errors

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListChannelNamespaces

result=result = result=client->listChannelNamespaces([/* ... /]); promise=promise = 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=result = result=client->listChannelNamespaces([ 'apiId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The Api ID.

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

[ 'channelNamespaces' => [ [ 'apiId' => '', 'channelNamespaceArn' => '', 'codeHandlers' => '', 'created' => , 'handlerConfigs' => [ 'onPublish' => [ 'behavior' => 'CODE|DIRECT', 'integration' => [ 'dataSourceName' => '', 'lambdaConfig' => [ 'invokeType' => 'REQUEST_RESPONSE|EVENT', ], ], ], 'onSubscribe' => [ 'behavior' => 'CODE|DIRECT', 'integration' => [ 'dataSourceName' => '', 'lambdaConfig' => [ 'invokeType' => 'REQUEST_RESPONSE|EVENT', ], ], ], ], 'lastModified' => , 'name' => '', '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' => ['', ...], ], // ... ], 'nextToken' => '', ]

Result Details

Members

channelNamespaces

Type: Array of ChannelNamespace structures

The ChannelNamespace objects.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListDataSources

result=result = result=client->listDataSources([/* ... /]); promise=promise = promise=client->listDataSourcesAsync([/ ... */]);

Lists the data sources for a given API.

Parameter Syntax

result=result = result=client->listDataSources([ 'apiId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

[ 'dataSources' => [ [ 'dataSourceArn' => '', 'description' => '', 'dynamodbConfig' => [ 'awsRegion' => '', 'deltaSyncConfig' => [ 'baseTableTTL' => , 'deltaSyncTableName' => '', 'deltaSyncTableTTL' => , ], 'tableName' => '', 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '', 'endpoint' => '', ], 'eventBridgeConfig' => [ 'eventBusArn' => '', ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', 'awsIamConfig' => [ 'signingRegion' => '', 'signingServiceName' => '', ], ], 'endpoint' => '', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '', ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '', 'openSearchServiceConfig' => [ 'awsRegion' => '', 'endpoint' => '', ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '', 'awsSecretStoreArn' => '', 'databaseName' => '', 'dbClusterIdentifier' => '', 'schema' => '', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '', 'type' => 'AWS_LAMBDA|AMAZON_DYNAMODB|AMAZON_ELASTICSEARCH|NONE|HTTP|RELATIONAL_DATABASE|AMAZON_OPENSEARCH_SERVICE|AMAZON_EVENTBRIDGE|AMAZON_BEDROCK_RUNTIME', ], // ... ], 'nextToken' => '', ]

Result Details

Members

dataSources

Type: Array of DataSource structures

The DataSource objects.

nextToken

An identifier to pass in the next request to this operation to return the next set of items in the list.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListDomainNames

result=result = result=client->listDomainNames([/* ... /]); promise=promise = promise=client->listDomainNamesAsync([/ ... */]);

Lists multiple custom domain names.

Parameter Syntax

result=result = result=client->listDomainNames([ 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

[ 'domainNameConfigs' => [ [ 'appsyncDomainName' => '', 'certificateArn' => '', 'description' => '', 'domainName' => '', 'domainNameArn' => '', 'hostedZoneId' => '', 'tags' => ['', ...], ], // ... ], 'nextToken' => '', ]

Result Details

Members

domainNameConfigs

Type: Array of DomainNameConfig structures

Lists configurations for multiple domain names.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Errors

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

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.

An internal AppSync error occurred. Try your request again.

ListFunctions

result=result = result=client->listFunctions([/* ... /]); promise=promise = promise=client->listFunctionsAsync([/ ... */]);

List multiple functions.

Parameter Syntax

result=result = result=client->listFunctions([ 'apiId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The GraphQL API ID.

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

[ 'functions' => [ [ 'code' => '', 'dataSourceName' => '', 'description' => '', 'functionArn' => '', 'functionId' => '', 'functionVersion' => '', 'maxBatchSize' => , 'name' => '', 'requestMappingTemplate' => '', 'responseMappingTemplate' => '', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '', ], ], ], // ... ], 'nextToken' => '', ]

Result Details

Members

functions

Type: Array of FunctionConfiguration structures

A list of Function objects.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListGraphqlApis

result=result = result=client->listGraphqlApis([/* ... /]); promise=promise = promise=client->listGraphqlApisAsync([/ ... */]);

Lists your GraphQL APIs.

Parameter Syntax

result=result = result=client->listGraphqlApis([ 'apiType' => 'GRAPHQL|MERGED', 'maxResults' => , 'nextToken' => '', 'owner' => 'CURRENT_ACCOUNT|OTHER_ACCOUNTS', ]);

Parameter Details

Members

apiType

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

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

owner

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' => , 'authorizerUri' => '', 'identityValidationExpression' => '', ], 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', ], 'userPoolConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', 'userPoolId' => '', ], ], // ... ], 'apiId' => '', 'apiType' => 'GRAPHQL|MERGED', 'arn' => '', 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'dns' => ['', ...], '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' => , 'authorizerUri' => '', 'identityValidationExpression' => '', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '', 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', ], 'mergedApiExecutionRoleArn' => '', 'name' => '', 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', ], 'owner' => '', 'ownerContact' => '', 'queryDepthLimit' => , 'resolverCountLimit' => , 'tags' => ['', ...], 'uris' => ['', ...], 'userPoolConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', 'defaultAction' => 'ALLOW|DENY', 'userPoolId' => '', ], 'visibility' => 'GLOBAL|PRIVATE', 'wafWebAclArn' => '', 'xrayEnabled' => true || false, ], // ... ], 'nextToken' => '', ]

Result Details

Members

graphqlApis

Type: Array of GraphqlApi structures

The GraphqlApi objects.

nextToken

An identifier to pass in the next request to this operation to return the next set of items in the list.

Errors

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListResolvers

result=result = result=client->listResolvers([/* ... /]); promise=promise = promise=client->listResolversAsync([/ ... */]);

Lists the resolvers for a given API and type.

Parameter Syntax

result=result = result=client->listResolvers([ 'apiId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', 'typeName' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

typeName

Required: Yes

Type: string

The type name.

Result Syntax

[ 'nextToken' => '', 'resolvers' => [ [ 'cachingConfig' => [ 'cachingKeys' => ['', ...], 'ttl' => , ], 'code' => '', 'dataSourceName' => '', 'fieldName' => '', 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => , 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['', ...], ], 'requestMappingTemplate' => '', 'resolverArn' => '', 'responseMappingTemplate' => '', 'runtime' => [ 'name' => 'APPSYNC_JS', 'runtimeVersion' => '', ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '', ], ], 'typeName' => '', ], // ... ], ]

Result Details

Members

nextToken

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

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.

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListResolversByFunction

result=result = result=client->listResolversByFunction([/* ... /]); promise=promise = promise=client->listResolversByFunctionAsync([/ ... */]);

List the resolvers that are associated with a specific function.

Parameter Syntax

result=result = result=client->listResolversByFunction([ 'apiId' => '', // REQUIRED 'functionId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

functionId

Required: Yes

Type: string

The function ID.

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

Result Details

Members

nextToken

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

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.

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListSourceApiAssociations

result=result = result=client->listSourceApiAssociations([/* ... /]); promise=promise = promise=client->listSourceApiAssociationsAsync([/ ... */]);

Lists the SourceApiAssociationSummary data.

Parameter Syntax

result=result = result=client->listSourceApiAssociations([ 'apiId' => '', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

[ 'nextToken' => '', 'sourceApiAssociationSummaries' => [ [ 'associationArn' => '', 'associationId' => '', 'description' => '', 'mergedApiArn' => '', 'mergedApiId' => '', 'sourceApiArn' => '', 'sourceApiId' => '', ], // ... ], ]

Result Details

Members

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

sourceApiAssociationSummaries

Type: Array of SourceApiAssociationSummary structures

The SourceApiAssociationSummary object data.

Errors

You aren't authorized to perform this operation.

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.

An internal AppSync error occurred. Try your request again.

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

ListTagsForResource

result=result = result=client->listTagsForResource([/* ... /]); promise=promise = promise=client->listTagsForResourceAsync([/ ... */]);

Lists the tags for a resource.

Parameter Syntax

result=result = result=client->listTagsForResource([ 'resourceArn' => '', // REQUIRED ]);

Parameter Details

Members

resourceArn

Required: Yes

Type: string

The GraphqlApi Amazon Resource Name (ARN).

Result Syntax

[ 'tags' => ['', ...], ]

Result Details

Members

tags

Type: Associative array of custom strings keys (TagKey) to strings

A TagMap object.

Errors

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

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

The request exceeded a limit. Try your request again.

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

ListTypes

result=result = result=client->listTypes([/* ... /]); promise=promise = promise=client->listTypesAsync([/ ... */]);

Lists the types for a given API.

Parameter Syntax

result=result = result=client->listTypes([ 'apiId' => '', // REQUIRED 'format' => 'SDL|JSON', // REQUIRED 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

format

Required: Yes

Type: string

The type format: SDL or JSON.

maxResults

The maximum number of results that you want the request to return.

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

[ 'nextToken' => '', 'types' => [ [ 'arn' => '', 'definition' => '', 'description' => '', 'format' => 'SDL|JSON', 'name' => '', ], // ... ], ]

Result Details

Members

nextToken

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

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.

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

ListTypesByAssociation

result=result = result=client->listTypesByAssociation([/* ... /]); promise=promise = promise=client->listTypesByAssociationAsync([/ ... */]);

Lists Type objects by the source API association ID.

Parameter Syntax

result=result = result=client->listTypesByAssociation([ 'associationId' => '', // REQUIRED 'format' => 'SDL|JSON', // REQUIRED 'maxResults' => , 'mergedApiIdentifier' => '', // REQUIRED 'nextToken' => '', ]);

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

The maximum number of results that you want the request to return.

mergedApiIdentifier

Required: Yes

Type: string

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Result Syntax

[ 'nextToken' => '', 'types' => [ [ 'arn' => '', 'definition' => '', 'description' => '', 'format' => 'SDL|JSON', 'name' => '', ], // ... ], ]

Result Details

Members

nextToken

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

types

Type: Array of Type structures

The Type objects.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

PutGraphqlApiEnvironmentVariables

result=result = result=client->putGraphqlApiEnvironmentVariables([/* ... /]); promise=promise = 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=result = result=client->putGraphqlApiEnvironmentVariables([ 'apiId' => '', // REQUIRED 'environmentVariables' => ['', ...], // 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.

Result Syntax

[ 'environmentVariables' => ['', ...], ]

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

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.

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

StartDataSourceIntrospection

result=result = result=client->startDataSourceIntrospection([/* ... /]); promise=promise = promise=client->startDataSourceIntrospectionAsync([/ ... */]);

Creates a new introspection. Returns the introspectionId of the new introspection after its creation.

Parameter Syntax

result=result = result=client->startDataSourceIntrospection([ 'rdsDataApiConfig' => [ 'databaseName' => '', // REQUIRED 'resourceArn' => '', // REQUIRED 'secretArn' => '', // REQUIRED ], ]);

Parameter Details

Members

rdsDataApiConfig

Type: RdsDataApiConfig structure

The rdsDataApiConfig object data.

Result Syntax

[ 'introspectionId' => '', 'introspectionStatus' => 'PROCESSING|FAILED|SUCCESS', 'introspectionStatusDetail' => '', ]

Result Details

Members

introspectionId

The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

introspectionStatus

The status of the introspection during creation. By default, when a new instrospection has been created, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail.

introspectionStatusDetail

The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.

Errors

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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=result = result=client->startSchemaCreation([/* ... /]); promise=promise = 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=result = result=client->startSchemaCreation([ 'apiId' => '', // 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

Result Details

Members

status

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

StartSchemaMerge

result=result = result=client->startSchemaMerge([/* ... /]); promise=promise = promise=client->startSchemaMergeAsync([/ ... */]);

Initiates a merge operation. Returns a status that shows the result of the merge operation.

Parameter Syntax

result=result = result=client->startSchemaMerge([ 'associationId' => '', // REQUIRED 'mergedApiIdentifier' => '', // 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

Result Syntax

Result Details

Members

sourceApiAssociationStatus

The state of the source API association.

Errors

You aren't authorized to perform this operation.

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.

An internal AppSync error occurred. Try your request again.

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

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

TagResource

result=result = result=client->tagResource([/* ... /]); promise=promise = promise=client->tagResourceAsync([/ ... */]);

Tags a resource with user-supplied tags.

Parameter Syntax

result=result = result=client->tagResource([ 'resourceArn' => '', // REQUIRED 'tags' => ['', ...], // 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

The results for this operation are always empty.

Errors

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

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

The request exceeded a limit. Try your request again.

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

UntagResource

result=result = result=client->untagResource([/* ... /]); promise=promise = promise=client->untagResourceAsync([/ ... */]);

Untags a resource.

Parameter Syntax

result=result = result=client->untagResource([ 'resourceArn' => '', // REQUIRED 'tagKeys' => ['', ...], // 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

The results for this operation are always empty.

Errors

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

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

The request exceeded a limit. Try your request again.

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

UpdateApi

result=result = result=client->updateApi([/* ... /]); promise=promise = promise=client->updateApiAsync([/ ... */]);

Updates an Api.

Parameter Syntax

result=result = result=client->updateApi([ 'apiId' => '', // REQUIRED 'eventConfig' => [ 'authProviders' => [ // REQUIRED [ 'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED 'cognitoConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', // REQUIRED 'userPoolId' => '', // REQUIRED ], 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => , 'authorizerUri' => '', // REQUIRED 'identityValidationExpression' => '', ], 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', // 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' => '', // REQUIRED 'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED ], ], 'name' => '', // REQUIRED 'ownerContact' => '', ]);

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

The owner contact information for the Api.

Result Syntax

Result Details

Members

api

The Api object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

UpdateApiCache

result=result = result=client->updateApiCache([/* ... /]); promise=promise = promise=client->updateApiCacheAsync([/ ... */]);

Updates the cache for the GraphQL API.

Parameter Syntax

Parameter Details

Members

apiCachingBehavior

Required: Yes

Type: string

Caching behavior.

FULL_REQUEST_CACHING: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.

apiId

Required: Yes

Type: string

The GraphQL API ID.

healthMetricsConfig

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.

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

Result Details

Members

apiCache

The ApiCache object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

UpdateApiKey

result=result = result=client->updateApiKey([/* ... /]); promise=promise = promise=client->updateApiKeyAsync([/ ... */]);

Updates an API key. You can update the key as long as it's not deleted.

Parameter Syntax

result=result = result=client->updateApiKey([ 'apiId' => '', // REQUIRED 'description' => '', 'expires' => , 'id' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The ID for the GraphQL API.

description

A description of the purpose of the API key.

expires

From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

Required: Yes

Type: string

The API key ID.

Result Syntax

[ 'apiKey' => [ 'deletes' => , 'description' => '', 'expires' => , 'id' => '', ], ]

Result Details

Members

apiKey

The API key.

Errors

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

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

You aren't authorized to perform this operation.

The request exceeded a limit. Try your request again.

ApiKeyValidityOutOfBoundsException:

An internal AppSync error occurred. Try your request again.

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

UpdateChannelNamespace

result=result = result=client->updateChannelNamespace([/* ... /]); promise=promise = promise=client->updateChannelNamespaceAsync([/ ... */]);

Updates a ChannelNamespace associated with an Api.

Parameter Syntax

result=result = result=client->updateChannelNamespace([ 'apiId' => '', // REQUIRED 'codeHandlers' => '', 'handlerConfigs' => [ 'onPublish' => [ 'behavior' => 'CODE|DIRECT', // REQUIRED 'integration' => [ // REQUIRED 'dataSourceName' => '', // REQUIRED 'lambdaConfig' => [ 'invokeType' => 'REQUEST_RESPONSE|EVENT', ], ], ], 'onSubscribe' => [ 'behavior' => 'CODE|DIRECT', // REQUIRED 'integration' => [ // REQUIRED 'dataSourceName' => '', // REQUIRED 'lambdaConfig' => [ 'invokeType' => 'REQUEST_RESPONSE|EVENT', ], ], ], ], 'name' => '', // 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

The event handler functions that run custom business logic to process published events and subscribe requests.

handlerConfigs

Type: HandlerConfigs structure

The configuration for the OnPublish and OnSubscribe handlers.

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

Result Details

Members

channelNamespace

Type: ChannelNamespace structure

The ChannelNamespace object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

UpdateDataSource

result=result = result=client->updateDataSource([/* ... /]); promise=promise = promise=client->updateDataSourceAsync([/ ... */]);

Updates a DataSource object.

Parameter Syntax

result=result = result=client->updateDataSource([ 'apiId' => '', // REQUIRED 'description' => '', 'dynamodbConfig' => [ 'awsRegion' => '', // REQUIRED 'deltaSyncConfig' => [ 'baseTableTTL' => , 'deltaSyncTableName' => '', 'deltaSyncTableTTL' => , ], 'tableName' => '', // REQUIRED 'useCallerCredentials' => true || false, 'versioned' => true || false, ], 'elasticsearchConfig' => [ 'awsRegion' => '', // REQUIRED 'endpoint' => '', // REQUIRED ], 'eventBridgeConfig' => [ 'eventBusArn' => '', // REQUIRED ], 'httpConfig' => [ 'authorizationConfig' => [ 'authorizationType' => 'AWS_IAM', // REQUIRED 'awsIamConfig' => [ 'signingRegion' => '', 'signingServiceName' => '', ], ], 'endpoint' => '', ], 'lambdaConfig' => [ 'lambdaFunctionArn' => '', // REQUIRED ], 'metricsConfig' => 'ENABLED|DISABLED', 'name' => '', // REQUIRED 'openSearchServiceConfig' => [ 'awsRegion' => '', // REQUIRED 'endpoint' => '', // REQUIRED ], 'relationalDatabaseConfig' => [ 'rdsHttpEndpointConfig' => [ 'awsRegion' => '', 'awsSecretStoreArn' => '', 'databaseName' => '', 'dbClusterIdentifier' => '', 'schema' => '', ], 'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT', ], 'serviceRoleArn' => '', '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

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

metricsConfig can be ENABLED or DISABLED.

name

Required: Yes

Type: string

The new name for the data source.

openSearchServiceConfig

The new OpenSearch configuration.

relationalDatabaseConfig

The new relational database configuration.

serviceRoleArn

The new service role Amazon Resource Name (ARN) for the data source.

type

Required: Yes

Type: string

The new data source type.

Result Syntax

Result Details

Members

dataSource

Type: DataSource structure

The updated DataSource object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

UpdateDomainName

result=result = result=client->updateDomainName([/* ... /]); promise=promise = promise=client->updateDomainNameAsync([/ ... */]);

Updates a custom DomainName object.

Parameter Syntax

result=result = result=client->updateDomainName([ 'description' => '', 'domainName' => '', // REQUIRED ]);

Parameter Details

Members

description

A description of the DomainName.

domainName

Required: Yes

Type: string

The domain name.

Result Syntax

[ 'domainNameConfig' => [ 'appsyncDomainName' => '', 'certificateArn' => '', 'description' => '', 'domainName' => '', 'domainNameArn' => '', 'hostedZoneId' => '', 'tags' => ['', ...], ], ]

Result Details

Members

domainNameConfig

Type: DomainNameConfig structure

The configuration for the DomainName.

Errors

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

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.

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

An internal AppSync error occurred. Try your request again.

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

UpdateFunction

result=result = result=client->updateFunction([/* ... /]); promise=promise = promise=client->updateFunctionAsync([/ ... */]);

Updates a Function object.

Parameter Syntax

result=result = result=client->updateFunction([ 'apiId' => '', // REQUIRED 'code' => '', 'dataSourceName' => '', // REQUIRED 'description' => '', 'functionId' => '', // REQUIRED 'functionVersion' => '', 'maxBatchSize' => , 'name' => '', // REQUIRED 'requestMappingTemplate' => '', 'responseMappingTemplate' => '', 'runtime' => [ 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '', // REQUIRED ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '', ], ], ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The GraphQL API ID.

code

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

dataSourceName

Required: Yes

Type: string

The Function DataSource name.

description

The Function description.

functionId

Required: Yes

Type: string

The function ID.

functionVersion

The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.

maxBatchSize

The maximum batching size for a resolver.

name

Required: Yes

Type: string

The Function name.

requestMappingTemplate

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

responseMappingTemplate

The Function request mapping template.

runtime

Type: AppSyncRuntime structure

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

Result Details

Members

functionConfiguration

Type: FunctionConfiguration structure

The Function object.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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=result = result=client->updateGraphqlApi([/* ... /]); promise=promise = promise=client->updateGraphqlApiAsync([/ ... */]);

Updates a GraphqlApi object.

Parameter Syntax

result=result = result=client->updateGraphqlApi([ 'additionalAuthenticationProviders' => [ [ 'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', 'lambdaAuthorizerConfig' => [ 'authorizerResultTtlInSeconds' => , 'authorizerUri' => '', // REQUIRED 'identityValidationExpression' => '', ], 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', // REQUIRED ], 'userPoolConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', // REQUIRED 'userPoolId' => '', // REQUIRED ], ], // ... ], 'apiId' => '', // REQUIRED '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' => , 'authorizerUri' => '', // REQUIRED 'identityValidationExpression' => '', ], 'logConfig' => [ 'cloudWatchLogsRoleArn' => '', // REQUIRED 'excludeVerboseContent' => true || false, 'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED ], 'mergedApiExecutionRoleArn' => '', 'name' => '', // REQUIRED 'openIDConnectConfig' => [ 'authTTL' => , 'clientId' => '', 'iatTTL' => , 'issuer' => '', // REQUIRED ], 'ownerContact' => '', 'queryDepthLimit' => , 'resolverCountLimit' => , 'userPoolConfig' => [ 'appIdClientRegex' => '', 'awsRegion' => '', // REQUIRED 'defaultAction' => 'ALLOW|DENY', // REQUIRED 'userPoolId' => '', // 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

Required: Yes

Type: string

The new authentication type for the GraphqlApi object.

enhancedMetricsConfig

Type: EnhancedMetricsConfig structure

The enhancedMetricsConfig object.

introspectionConfig

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

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

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

queryDepthLimit

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

userPoolConfig

Type: UserPoolConfig structure

The new Amazon Cognito user pool configuration for the ~GraphqlApi object.

xrayEnabled

A flag indicating whether to use X-Ray tracing for the GraphqlApi.

Result Syntax

Result Details

Members

graphqlApi

Type: GraphqlApi structure

The updated GraphqlApi object.

Errors

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

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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

UpdateResolver

result=result = result=client->updateResolver([/* ... /]); promise=promise = promise=client->updateResolverAsync([/ ... */]);

Updates a Resolver object.

Parameter Syntax

result=result = result=client->updateResolver([ 'apiId' => '', // REQUIRED 'cachingConfig' => [ 'cachingKeys' => ['', ...], 'ttl' => , // REQUIRED ], 'code' => '', 'dataSourceName' => '', 'fieldName' => '', // REQUIRED 'kind' => 'UNIT|PIPELINE', 'maxBatchSize' => , 'metricsConfig' => 'ENABLED|DISABLED', 'pipelineConfig' => [ 'functions' => ['', ...], ], 'requestMappingTemplate' => '', 'responseMappingTemplate' => '', 'runtime' => [ 'name' => 'APPSYNC_JS', // REQUIRED 'runtimeVersion' => '', // REQUIRED ], 'syncConfig' => [ 'conflictDetection' => 'VERSION|NONE', 'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE', 'lambdaConflictHandlerConfig' => [ 'lambdaConflictHandlerArn' => '', ], ], 'typeName' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

cachingConfig

Type: CachingConfig structure

The caching configuration for the resolver.

code

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

dataSourceName

The new data source name.

fieldName

Required: Yes

Type: string

The new field name.

kind

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

The maximum batching size for a resolver.

metricsConfig

metricsConfig can be ENABLED or DISABLED.

pipelineConfig

Type: PipelineConfig structure

The PipelineConfig.

requestMappingTemplate

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

The new response mapping template.

runtime

Type: AppSyncRuntime structure

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

Result Details

Members

resolver

The updated Resolver object.

Errors

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

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

You aren't authorized to perform this operation.

An internal AppSync error occurred. Try your request again.

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=result = result=client->updateSourceApiAssociation([/* ... /]); promise=promise = promise=client->updateSourceApiAssociationAsync([/ ... */]);

Updates some of the configuration choices of a particular source API association.

Parameter Syntax

result=result = result=client->updateSourceApiAssociation([ 'associationId' => '', // REQUIRED 'description' => '', 'mergedApiIdentifier' => '', // 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

The description field.

mergedApiIdentifier

Required: Yes

Type: string

sourceApiAssociationConfig

Type: SourceApiAssociationConfig structure

The SourceApiAssociationConfig object data.

Result Syntax

Result Details

Members

sourceApiAssociation

Type: SourceApiAssociation structure

The SourceApiAssociation object data.

Errors

You aren't authorized to perform this operation.

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.

An internal AppSync error occurred. Try your request again.

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

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

UpdateType

result=result = result=client->updateType([/* ... /]); promise=promise = promise=client->updateTypeAsync([/ ... */]);

Updates a Type object.

Parameter Syntax

result=result = result=client->updateType([ 'apiId' => '', // REQUIRED 'definition' => '', 'format' => 'SDL|JSON', // REQUIRED 'typeName' => '', // REQUIRED ]);

Parameter Details

Members

apiId

Required: Yes

Type: string

The API ID.

definition

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' => '', 'definition' => '', 'description' => '', 'format' => 'SDL|JSON', 'name' => '', ], ]

Result Details

Members

type

The updated Type object.

Errors

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

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

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

You aren't authorized to perform this operation.