AssociateApi

$result = $client->associateApi([/* ... */]);
$promise = $client->associateApiAsync([/* ... */]);

Maps an endpoint to your custom domain.

Parameter Syntax

$result = $client->associateApi([
    'apiId' => '<string>', // REQUIRED
    'domainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

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

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

AssociateMergedGraphqlApi

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'sourceApiAssociation' => [
        'associationArn' => '<string>',
        'associationId' => '<string>',
        'description' => '<string>',
        'lastSuccessfulMergeDate' => <DateTime>,
        'mergedApiArn' => '<string>',
        'mergedApiId' => '<string>',
        'sourceApiArn' => '<string>',
        'sourceApiAssociationConfig' => [
            'mergeType' => 'MANUAL_MERGE|AUTO_MERGE',
        ],
        'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED',
        'sourceApiAssociationStatusDetail' => '<string>',
        'sourceApiId' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedException:

You aren't authorized to perform this operation.

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

LimitExceededException:

The request exceeded a limit. Try your request again.

ConcurrentModificationException:

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

AssociateSourceGraphqlApi

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'sourceApiAssociation' => [
        'associationArn' => '<string>',
        'associationId' => '<string>',
        'description' => '<string>',
        'lastSuccessfulMergeDate' => <DateTime>,
        'mergedApiArn' => '<string>',
        'mergedApiId' => '<string>',
        'sourceApiArn' => '<string>',
        'sourceApiAssociationConfig' => [
            'mergeType' => 'MANUAL_MERGE|AUTO_MERGE',
        ],
        'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED',
        'sourceApiAssociationStatusDetail' => '<string>',
        'sourceApiId' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedException:

You aren't authorized to perform this operation.

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

LimitExceededException:

The request exceeded a limit. Try your request again.

ConcurrentModificationException:

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

CreateApi

$result = $client->createApi([/* ... */]);
$promise = $client->createApiAsync([/* ... */]);

Creates an Api object. Use this operation to create an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

Parameter Syntax

$result = $client->createApi([
    'eventConfig' => [
        'authProviders' => [ // REQUIRED
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
                'cognitoConfig' => [
                    'appIdClientRegex' => '<string>',
                    'awsRegion' => '<string>', // REQUIRED
                    'userPoolId' => '<string>', // REQUIRED
                ],
                'lambdaAuthorizerConfig' => [
                    'authorizerResultTtlInSeconds' => <integer>,
                    'authorizerUri' => '<string>', // REQUIRED
                    'identityValidationExpression' => '<string>',
                ],
                'openIDConnectConfig' => [
                    'authTTL' => <integer>,
                    'clientId' => '<string>',
                    'iatTTL' => <integer>,
                    'issuer' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
        'connectionAuthModes' => [ // REQUIRED
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
            ],
            // ...
        ],
        'defaultPublishAuthModes' => [ // REQUIRED
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
            ],
            // ...
        ],
        'defaultSubscribeAuthModes' => [ // REQUIRED
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
            ],
            // ...
        ],
        'logConfig' => [
            'cloudWatchLogsRoleArn' => '<string>', // REQUIRED
            'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED
        ],
    ],
    'name' => '<string>', // REQUIRED
    'ownerContact' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'api' => [
        'apiArn' => '<string>',
        'apiId' => '<string>',
        'created' => <DateTime>,
        'dns' => ['<string>', ...],
        'eventConfig' => [
            'authProviders' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                    'cognitoConfig' => [
                        'appIdClientRegex' => '<string>',
                        'awsRegion' => '<string>',
                        'userPoolId' => '<string>',
                    ],
                    'lambdaAuthorizerConfig' => [
                        'authorizerResultTtlInSeconds' => <integer>,
                        'authorizerUri' => '<string>',
                        'identityValidationExpression' => '<string>',
                    ],
                    'openIDConnectConfig' => [
                        'authTTL' => <integer>,
                        'clientId' => '<string>',
                        'iatTTL' => <integer>,
                        'issuer' => '<string>',
                    ],
                ],
                // ...
            ],
            'connectionAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'defaultPublishAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'defaultSubscribeAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'logConfig' => [
                'cloudWatchLogsRoleArn' => '<string>',
                'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG',
            ],
        ],
        'name' => '<string>',
        'ownerContact' => '<string>',
        'tags' => ['<string>', ...],
        'wafWebAclArn' => '<string>',
        'xrayEnabled' => true || false,
    ],
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ServiceQuotaExceededException:

The operation exceeded the service quota for this resource.

CreateApiCache

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

Creates a cache for the GraphQL API.

Parameter Syntax

$result = $client->createApiCache([
    'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING|OPERATION_LEVEL_CACHING', // REQUIRED
    'apiId' => '<string>', // REQUIRED
    'atRestEncryptionEnabled' => true || false,
    'healthMetricsConfig' => 'ENABLED|DISABLED',
    'transitEncryptionEnabled' => true || false,
    'ttl' => <integer>, // REQUIRED
    'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X', // REQUIRED
]);

Parameter Details

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' => <integer>,
        'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X',
    ],
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

CreateApiKey

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'apiKey' => [
        'deletes' => <integer>,
        'description' => '<string>',
        'expires' => <integer>,
        'id' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

LimitExceededException:

The request exceeded a limit. Try your request again.

UnauthorizedException:

You aren't authorized to perform this operation.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ApiKeyLimitExceededException:

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

ApiKeyValidityOutOfBoundsException:

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

CreateChannelNamespace

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

Creates a ChannelNamespace for an Api.

Parameter Syntax

$result = $client->createChannelNamespace([
    'apiId' => '<string>', // REQUIRED
    'codeHandlers' => '<string>',
    'handlerConfigs' => [
        'onPublish' => [
            'behavior' => 'CODE|DIRECT', // REQUIRED
            'integration' => [ // REQUIRED
                'dataSourceName' => '<string>', // REQUIRED
                'lambdaConfig' => [
                    'invokeType' => 'REQUEST_RESPONSE|EVENT',
                ],
            ],
        ],
        'onSubscribe' => [
            'behavior' => 'CODE|DIRECT', // REQUIRED
            'integration' => [ // REQUIRED
                'dataSourceName' => '<string>', // REQUIRED
                'lambdaConfig' => [
                    'invokeType' => 'REQUEST_RESPONSE|EVENT',
                ],
            ],
        ],
    ],
    'name' => '<string>', // REQUIRED
    'publishAuthModes' => [
        [
            'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
        ],
        // ...
    ],
    'subscribeAuthModes' => [
        [
            'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'channelNamespace' => [
        'apiId' => '<string>',
        'channelNamespaceArn' => '<string>',
        'codeHandlers' => '<string>',
        'created' => <DateTime>,
        'handlerConfigs' => [
            'onPublish' => [
                'behavior' => 'CODE|DIRECT',
                'integration' => [
                    'dataSourceName' => '<string>',
                    'lambdaConfig' => [
                        'invokeType' => 'REQUEST_RESPONSE|EVENT',
                    ],
                ],
            ],
            'onSubscribe' => [
                'behavior' => 'CODE|DIRECT',
                'integration' => [
                    'dataSourceName' => '<string>',
                    'lambdaConfig' => [
                        'invokeType' => 'REQUEST_RESPONSE|EVENT',
                    ],
                ],
            ],
        ],
        'lastModified' => <DateTime>,
        'name' => '<string>',
        'publishAuthModes' => [
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
            ],
            // ...
        ],
        'subscribeAuthModes' => [
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

ConflictException:

A conflict with a previous successful update is detected. This typically occurs when the previous update did not have time to propagate before the next update was made. A retry (with appropriate backoff logic) is the recommended response to this exception.

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ServiceQuotaExceededException:

The operation exceeded the service quota for this resource.

CreateDataSource

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

Creates a DataSource object.

Parameter Syntax

$result = $client->createDataSource([
    'apiId' => '<string>', // REQUIRED
    'description' => '<string>',
    'dynamodbConfig' => [
        'awsRegion' => '<string>', // REQUIRED
        'deltaSyncConfig' => [
            'baseTableTTL' => <integer>,
            'deltaSyncTableName' => '<string>',
            'deltaSyncTableTTL' => <integer>,
        ],
        'tableName' => '<string>', // REQUIRED
        'useCallerCredentials' => true || false,
        'versioned' => true || false,
    ],
    'elasticsearchConfig' => [
        'awsRegion' => '<string>', // REQUIRED
        'endpoint' => '<string>', // REQUIRED
    ],
    'eventBridgeConfig' => [
        'eventBusArn' => '<string>', // REQUIRED
    ],
    'httpConfig' => [
        'authorizationConfig' => [
            'authorizationType' => 'AWS_IAM', // REQUIRED
            'awsIamConfig' => [
                'signingRegion' => '<string>',
                'signingServiceName' => '<string>',
            ],
        ],
        'endpoint' => '<string>',
    ],
    'lambdaConfig' => [
        'lambdaFunctionArn' => '<string>', // REQUIRED
    ],
    'metricsConfig' => 'ENABLED|DISABLED',
    'name' => '<string>', // REQUIRED
    'openSearchServiceConfig' => [
        'awsRegion' => '<string>', // REQUIRED
        'endpoint' => '<string>', // REQUIRED
    ],
    'relationalDatabaseConfig' => [
        'rdsHttpEndpointConfig' => [
            'awsRegion' => '<string>',
            'awsSecretStoreArn' => '<string>',
            'databaseName' => '<string>',
            'dbClusterIdentifier' => '<string>',
            'schema' => '<string>',
        ],
        'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT',
    ],
    'serviceRoleArn' => '<string>',
    'type' => 'AWS_LAMBDA|AMAZON_DYNAMODB|AMAZON_ELASTICSEARCH|NONE|HTTP|RELATIONAL_DATABASE|AMAZON_OPENSEARCH_SERVICE|AMAZON_EVENTBRIDGE|AMAZON_BEDROCK_RUNTIME', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

CreateDomainName

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

Creates a custom DomainName object.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

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

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

CreateFunction

$result = $client->createFunction([/* ... */]);
$promise = $client->createFunctionAsync([/* ... */]);

Creates a Function object.

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'functionConfiguration' => [
        'code' => '<string>',
        'dataSourceName' => '<string>',
        'description' => '<string>',
        'functionArn' => '<string>',
        'functionId' => '<string>',
        'functionVersion' => '<string>',
        'maxBatchSize' => <integer>,
        'name' => '<string>',
        'requestMappingTemplate' => '<string>',
        'responseMappingTemplate' => '<string>',
        'runtime' => [
            'name' => 'APPSYNC_JS',
            'runtimeVersion' => '<string>',
        ],
        'syncConfig' => [
            'conflictDetection' => 'VERSION|NONE',
            'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE',
            'lambdaConflictHandlerConfig' => [
                'lambdaConflictHandlerArn' => '<string>',
            ],
        ],
    ],
]

Result Details

Errors

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

BadRequestException:

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

CreateGraphqlApi

$result = $client->createGraphqlApi([/* ... */]);
$promise = $client->createGraphqlApiAsync([/* ... */]);

Creates a GraphqlApi object.

Parameter Syntax

$result = $client->createGraphqlApi([
    'additionalAuthenticationProviders' => [
        [
            'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
            'lambdaAuthorizerConfig' => [
                'authorizerResultTtlInSeconds' => <integer>,
                'authorizerUri' => '<string>', // REQUIRED
                'identityValidationExpression' => '<string>',
            ],
            'openIDConnectConfig' => [
                'authTTL' => <integer>,
                'clientId' => '<string>',
                'iatTTL' => <integer>,
                'issuer' => '<string>', // REQUIRED
            ],
            'userPoolConfig' => [
                'appIdClientRegex' => '<string>',
                'awsRegion' => '<string>', // REQUIRED
                'userPoolId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'apiType' => 'GRAPHQL|MERGED',
    'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
    'enhancedMetricsConfig' => [
        'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS', // REQUIRED
        'operationLevelMetricsConfig' => 'ENABLED|DISABLED', // REQUIRED
        'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS', // REQUIRED
    ],
    'introspectionConfig' => 'ENABLED|DISABLED',
    'lambdaAuthorizerConfig' => [
        'authorizerResultTtlInSeconds' => <integer>,
        'authorizerUri' => '<string>', // REQUIRED
        'identityValidationExpression' => '<string>',
    ],
    'logConfig' => [
        'cloudWatchLogsRoleArn' => '<string>', // REQUIRED
        'excludeVerboseContent' => true || false,
        'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED
    ],
    'mergedApiExecutionRoleArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'openIDConnectConfig' => [
        'authTTL' => <integer>,
        'clientId' => '<string>',
        'iatTTL' => <integer>,
        'issuer' => '<string>', // REQUIRED
    ],
    'ownerContact' => '<string>',
    'queryDepthLimit' => <integer>,
    'resolverCountLimit' => <integer>,
    'tags' => ['<string>', ...],
    'userPoolConfig' => [
        'appIdClientRegex' => '<string>',
        'awsRegion' => '<string>', // REQUIRED
        'defaultAction' => 'ALLOW|DENY', // REQUIRED
        'userPoolId' => '<string>', // REQUIRED
    ],
    'visibility' => 'GLOBAL|PRIVATE',
    'xrayEnabled' => true || false,
]);

Parameter Details

Result Syntax

[
    'graphqlApi' => [
        'additionalAuthenticationProviders' => [
            [
                'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                'lambdaAuthorizerConfig' => [
                    'authorizerResultTtlInSeconds' => <integer>,
                    'authorizerUri' => '<string>',
                    'identityValidationExpression' => '<string>',
                ],
                'openIDConnectConfig' => [
                    'authTTL' => <integer>,
                    'clientId' => '<string>',
                    'iatTTL' => <integer>,
                    'issuer' => '<string>',
                ],
                'userPoolConfig' => [
                    'appIdClientRegex' => '<string>',
                    'awsRegion' => '<string>',
                    'userPoolId' => '<string>',
                ],
            ],
            // ...
        ],
        'apiId' => '<string>',
        'apiType' => 'GRAPHQL|MERGED',
        'arn' => '<string>',
        'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
        'dns' => ['<string>', ...],
        'enhancedMetricsConfig' => [
            'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS',
            'operationLevelMetricsConfig' => 'ENABLED|DISABLED',
            'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS',
        ],
        'introspectionConfig' => 'ENABLED|DISABLED',
        'lambdaAuthorizerConfig' => [
            'authorizerResultTtlInSeconds' => <integer>,
            'authorizerUri' => '<string>',
            'identityValidationExpression' => '<string>',
        ],
        'logConfig' => [
            'cloudWatchLogsRoleArn' => '<string>',
            'excludeVerboseContent' => true || false,
            'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG',
        ],
        'mergedApiExecutionRoleArn' => '<string>',
        'name' => '<string>',
        'openIDConnectConfig' => [
            'authTTL' => <integer>,
            'clientId' => '<string>',
            'iatTTL' => <integer>,
            'issuer' => '<string>',
        ],
        'owner' => '<string>',
        'ownerContact' => '<string>',
        'queryDepthLimit' => <integer>,
        'resolverCountLimit' => <integer>,
        'tags' => ['<string>', ...],
        'uris' => ['<string>', ...],
        'userPoolConfig' => [
            'appIdClientRegex' => '<string>',
            'awsRegion' => '<string>',
            'defaultAction' => 'ALLOW|DENY',
            'userPoolId' => '<string>',
        ],
        'visibility' => 'GLOBAL|PRIVATE',
        'wafWebAclArn' => '<string>',
        'xrayEnabled' => true || false,
    ],
]

Result Details

Errors

BadRequestException:

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

LimitExceededException:

The request exceeded a limit. Try your request again.

ConcurrentModificationException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ApiLimitExceededException:

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

CreateResolver

$result = $client->createResolver([/* ... */]);
$promise = $client->createResolverAsync([/* ... */]);

Creates a Resolver object.

A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

BadRequestException:

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

CreateType

$result = $client->createType([/* ... */]);
$promise = $client->createTypeAsync([/* ... */]);

Creates a Type object.

Parameter Syntax

$result = $client->createType([
    'apiId' => '<string>', // REQUIRED
    'definition' => '<string>', // REQUIRED
    'format' => 'SDL|JSON', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'type' => [
        'arn' => '<string>',
        'definition' => '<string>',
        'description' => '<string>',
        'format' => 'SDL|JSON',
        'name' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

DeleteApi

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

Deletes an Api object

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

DeleteApiCache

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

Deletes an ApiCache object.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

DeleteApiKey

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

Deletes an API key.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

DeleteChannelNamespace

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

Deletes a ChannelNamespace.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

DeleteDataSource

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

Deletes a DataSource object.

Parameter Syntax

$result = $client->deleteDataSource([
    'apiId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

DeleteDomainName

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

Deletes a custom DomainName object.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

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

BadRequestException:

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

ConcurrentModificationException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

DeleteFunction

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

Deletes a Function.

Parameter Syntax

$result = $client->deleteFunction([
    'apiId' => '<string>', // REQUIRED
    'functionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

BadRequestException:

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

DeleteGraphqlApi

$result = $client->deleteGraphqlApi([/* ... */]);
$promise = $client->deleteGraphqlApiAsync([/* ... */]);

Deletes a GraphqlApi object.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

DeleteResolver

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

Deletes a Resolver object.

Parameter Syntax

$result = $client->deleteResolver([
    'apiId' => '<string>', // REQUIRED
    'fieldName' => '<string>', // REQUIRED
    'typeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

BadRequestException:

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

DeleteType

$result = $client->deleteType([/* ... */]);
$promise = $client->deleteTypeAsync([/* ... */]);

Deletes a Type object.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

DisassociateApi

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

Removes an ApiAssociation object from a custom domain.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

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

BadRequestException:

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

ConcurrentModificationException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

DisassociateMergedGraphqlApi

$result = $client->disassociateMergedGraphqlApi([/* ... */]);
$promise = $client->disassociateMergedGraphqlApiAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateMergedGraphqlApi([
    'associationId' => '<string>', // REQUIRED
    'sourceApiIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED',
]

Result Details

Errors

UnauthorizedException:

You aren't authorized to perform this operation.

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

ConcurrentModificationException:

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

DisassociateSourceGraphqlApi

$result = $client->disassociateSourceGraphqlApi([/* ... */]);
$promise = $client->disassociateSourceGraphqlApiAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateSourceGraphqlApi([
    'associationId' => '<string>', // REQUIRED
    'mergedApiIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED',
]

Result Details

Errors

UnauthorizedException:

You aren't authorized to perform this operation.

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

ConcurrentModificationException:

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

EvaluateCode

$result = $client->evaluateCode([/* ... */]);
$promise = $client->evaluateCodeAsync([/* ... */]);

Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.

Parameter Syntax

$result = $client->evaluateCode([
    'code' => '<string>', // REQUIRED
    'context' => '<string>', // REQUIRED
    'function' => '<string>',
    'runtime' => [ // REQUIRED
        'name' => 'APPSYNC_JS', // REQUIRED
        'runtimeVersion' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'error' => [
        'codeErrors' => [
            [
                'errorType' => '<string>',
                'location' => [
                    'column' => <integer>,
                    'line' => <integer>,
                    'span' => <integer>,
                ],
                'value' => '<string>',
            ],
            // ...
        ],
        'message' => '<string>',
    ],
    'evaluationResult' => '<string>',
    'logs' => ['<string>', ...],
    'outErrors' => '<string>',
    'stash' => '<string>',
]

Result Details

Errors

AccessDeniedException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

BadRequestException:

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

EvaluateMappingTemplate

$result = $client->evaluateMappingTemplate([/* ... */]);
$promise = $client->evaluateMappingTemplateAsync([/* ... */]);

Evaluates a given template and returns the response. The mapping template can be a request or response template.

Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.

Mapping templates are written in the Apache Velocity Template Language (VTL).

Parameter Syntax

$result = $client->evaluateMappingTemplate([
    'context' => '<string>', // REQUIRED
    'template' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'error' => [
        'message' => '<string>',
    ],
    'evaluationResult' => '<string>',
    'logs' => ['<string>', ...],
    'outErrors' => '<string>',
    'stash' => '<string>',
]

Result Details

Errors

AccessDeniedException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

BadRequestException:

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

FlushApiCache

$result = $client->flushApiCache([/* ... */]);
$promise = $client->flushApiCacheAsync([/* ... */]);

Flushes an ApiCache object.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

GetApiAssociation

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

Retrieves an ApiAssociation object.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

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

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

GetApiCache

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

Retrieves an ApiCache object.

Parameter Syntax

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

Parameter Details

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' => <integer>,
        'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X',
    ],
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

GetApiResource

$result = $client->getApiResource([/* ... */]);
$promise = $client->getApiResourceAsync([/* ... */]);

Retrieves an Api object.

Parameter Syntax

$result = $client->getApiResource([
    'apiId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'api' => [
        'apiArn' => '<string>',
        'apiId' => '<string>',
        'created' => <DateTime>,
        'dns' => ['<string>', ...],
        'eventConfig' => [
            'authProviders' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                    'cognitoConfig' => [
                        'appIdClientRegex' => '<string>',
                        'awsRegion' => '<string>',
                        'userPoolId' => '<string>',
                    ],
                    'lambdaAuthorizerConfig' => [
                        'authorizerResultTtlInSeconds' => <integer>,
                        'authorizerUri' => '<string>',
                        'identityValidationExpression' => '<string>',
                    ],
                    'openIDConnectConfig' => [
                        'authTTL' => <integer>,
                        'clientId' => '<string>',
                        'iatTTL' => <integer>,
                        'issuer' => '<string>',
                    ],
                ],
                // ...
            ],
            'connectionAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'defaultPublishAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'defaultSubscribeAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'logConfig' => [
                'cloudWatchLogsRoleArn' => '<string>',
                'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG',
            ],
        ],
        'name' => '<string>',
        'ownerContact' => '<string>',
        'tags' => ['<string>', ...],
        'wafWebAclArn' => '<string>',
        'xrayEnabled' => true || false,
    ],
]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

GetChannelNamespace

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

Retrieves the channel namespace for a specified Api.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'channelNamespace' => [
        'apiId' => '<string>',
        'channelNamespaceArn' => '<string>',
        'codeHandlers' => '<string>',
        'created' => <DateTime>,
        'handlerConfigs' => [
            'onPublish' => [
                'behavior' => 'CODE|DIRECT',
                'integration' => [
                    'dataSourceName' => '<string>',
                    'lambdaConfig' => [
                        'invokeType' => 'REQUEST_RESPONSE|EVENT',
                    ],
                ],
            ],
            'onSubscribe' => [
                'behavior' => 'CODE|DIRECT',
                'integration' => [
                    'dataSourceName' => '<string>',
                    'lambdaConfig' => [
                        'invokeType' => 'REQUEST_RESPONSE|EVENT',
                    ],
                ],
            ],
        ],
        'lastModified' => <DateTime>,
        'name' => '<string>',
        'publishAuthModes' => [
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
            ],
            // ...
        ],
        'subscribeAuthModes' => [
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

GetDataSource

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

Retrieves a DataSource object.

Parameter Syntax

$result = $client->getDataSource([
    'apiId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

GetDataSourceIntrospection

$result = $client->getDataSourceIntrospection([/* ... */]);
$promise = $client->getDataSourceIntrospectionAsync([/* ... */]);

Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.

Parameter Syntax

$result = $client->getDataSourceIntrospection([
    'includeModelsSDL' => true || false,
    'introspectionId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'introspectionId' => '<string>',
    'introspectionResult' => [
        'models' => [
            [
                'fields' => [
                    [
                        'length' => <integer>,
                        'name' => '<string>',
                        'type' => [
                            'kind' => '<string>',
                            'name' => '<string>',
                            'type' => [...], // RECURSIVE
                            'values' => ['<string>', ...],
                        ],
                    ],
                    // ...
                ],
                'indexes' => [
                    [
                        'fields' => ['<string>', ...],
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'primaryKey' => [
                    'fields' => ['<string>', ...],
                    'name' => '<string>',
                ],
                'sdl' => '<string>',
            ],
            // ...
        ],
        'nextToken' => '<string>',
    ],
    'introspectionStatus' => 'PROCESSING|FAILED|SUCCESS',
    'introspectionStatusDetail' => '<string>',
]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

GetDomainName

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

Retrieves a custom DomainName object.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

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

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

GetFunction

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

Get a Function.

Parameter Syntax

$result = $client->getFunction([
    'apiId' => '<string>', // REQUIRED
    'functionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'functionConfiguration' => [
        'code' => '<string>',
        'dataSourceName' => '<string>',
        'description' => '<string>',
        'functionArn' => '<string>',
        'functionId' => '<string>',
        'functionVersion' => '<string>',
        'maxBatchSize' => <integer>,
        'name' => '<string>',
        'requestMappingTemplate' => '<string>',
        'responseMappingTemplate' => '<string>',
        'runtime' => [
            'name' => 'APPSYNC_JS',
            'runtimeVersion' => '<string>',
        ],
        'syncConfig' => [
            'conflictDetection' => 'VERSION|NONE',
            'conflictHandler' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE',
            'lambdaConflictHandlerConfig' => [
                'lambdaConflictHandlerArn' => '<string>',
            ],
        ],
    ],
]

Result Details

Errors

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

GetGraphqlApi

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

Retrieves a GraphqlApi object.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'graphqlApi' => [
        'additionalAuthenticationProviders' => [
            [
                'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                'lambdaAuthorizerConfig' => [
                    'authorizerResultTtlInSeconds' => <integer>,
                    'authorizerUri' => '<string>',
                    'identityValidationExpression' => '<string>',
                ],
                'openIDConnectConfig' => [
                    'authTTL' => <integer>,
                    'clientId' => '<string>',
                    'iatTTL' => <integer>,
                    'issuer' => '<string>',
                ],
                'userPoolConfig' => [
                    'appIdClientRegex' => '<string>',
                    'awsRegion' => '<string>',
                    'userPoolId' => '<string>',
                ],
            ],
            // ...
        ],
        'apiId' => '<string>',
        'apiType' => 'GRAPHQL|MERGED',
        'arn' => '<string>',
        'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
        'dns' => ['<string>', ...],
        'enhancedMetricsConfig' => [
            'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS',
            'operationLevelMetricsConfig' => 'ENABLED|DISABLED',
            'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS',
        ],
        'introspectionConfig' => 'ENABLED|DISABLED',
        'lambdaAuthorizerConfig' => [
            'authorizerResultTtlInSeconds' => <integer>,
            'authorizerUri' => '<string>',
            'identityValidationExpression' => '<string>',
        ],
        'logConfig' => [
            'cloudWatchLogsRoleArn' => '<string>',
            'excludeVerboseContent' => true || false,
            'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG',
        ],
        'mergedApiExecutionRoleArn' => '<string>',
        'name' => '<string>',
        'openIDConnectConfig' => [
            'authTTL' => <integer>,
            'clientId' => '<string>',
            'iatTTL' => <integer>,
            'issuer' => '<string>',
        ],
        'owner' => '<string>',
        'ownerContact' => '<string>',
        'queryDepthLimit' => <integer>,
        'resolverCountLimit' => <integer>,
        'tags' => ['<string>', ...],
        'uris' => ['<string>', ...],
        'userPoolConfig' => [
            'appIdClientRegex' => '<string>',
            'awsRegion' => '<string>',
            'defaultAction' => 'ALLOW|DENY',
            'userPoolId' => '<string>',
        ],
        'visibility' => 'GLOBAL|PRIVATE',
        'wafWebAclArn' => '<string>',
        'xrayEnabled' => true || false,
    ],
]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

GetGraphqlApiEnvironmentVariables

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

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

Parameter Syntax

$result = $client->getGraphqlApiEnvironmentVariables([
    'apiId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

GetIntrospectionSchema

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

Retrieves the introspection schema for a GraphQL API.

Parameter Syntax

$result = $client->getIntrospectionSchema([
    'apiId' => '<string>', // REQUIRED
    'format' => 'SDL|JSON', // REQUIRED
    'includeDirectives' => true || false,
]);

Parameter Details

Result Syntax

[
    'schema' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

GraphQLSchemaException:

The GraphQL schema is not valid.

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

GetResolver

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

Retrieves a Resolver object.

Parameter Syntax

$result = $client->getResolver([
    'apiId' => '<string>', // REQUIRED
    'fieldName' => '<string>', // REQUIRED
    'typeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

GetSchemaCreationStatus

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

Retrieves the current status of a schema creation operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'details' => '<string>',
    'status' => 'PROCESSING|ACTIVE|DELETING|FAILED|SUCCESS|NOT_APPLICABLE',
]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

GetSourceApiAssociation

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

Retrieves a SourceApiAssociation object.

Parameter Syntax

$result = $client->getSourceApiAssociation([
    'associationId' => '<string>', // REQUIRED
    'mergedApiIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'sourceApiAssociation' => [
        'associationArn' => '<string>',
        'associationId' => '<string>',
        'description' => '<string>',
        'lastSuccessfulMergeDate' => <DateTime>,
        'mergedApiArn' => '<string>',
        'mergedApiId' => '<string>',
        'sourceApiArn' => '<string>',
        'sourceApiAssociationConfig' => [
            'mergeType' => 'MANUAL_MERGE|AUTO_MERGE',
        ],
        'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED',
        'sourceApiAssociationStatusDetail' => '<string>',
        'sourceApiId' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedException:

You aren't authorized to perform this operation.

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

GetType

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

Retrieves a Type object.

Parameter Syntax

$result = $client->getType([
    'apiId' => '<string>', // REQUIRED
    'format' => 'SDL|JSON', // REQUIRED
    'typeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'type' => [
        'arn' => '<string>',
        'definition' => '<string>',
        'description' => '<string>',
        'format' => 'SDL|JSON',
        'name' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListApiKeys

$result = $client->listApiKeys([/* ... */]);
$promise = $client->listApiKeysAsync([/* ... */]);

Lists the API keys for a given API.

Parameter Syntax

$result = $client->listApiKeys([
    'apiId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListApis

$result = $client->listApis([/* ... */]);
$promise = $client->listApisAsync([/* ... */]);

Lists the APIs in your AppSync account.

ListApis returns only the high level API details. For more detailed information about an API, use GetApi.

Parameter Syntax

$result = $client->listApis([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'apis' => [
        [
            'apiArn' => '<string>',
            'apiId' => '<string>',
            'created' => <DateTime>,
            'dns' => ['<string>', ...],
            'eventConfig' => [
                'authProviders' => [
                    [
                        'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                        'cognitoConfig' => [
                            'appIdClientRegex' => '<string>',
                            'awsRegion' => '<string>',
                            'userPoolId' => '<string>',
                        ],
                        'lambdaAuthorizerConfig' => [
                            'authorizerResultTtlInSeconds' => <integer>,
                            'authorizerUri' => '<string>',
                            'identityValidationExpression' => '<string>',
                        ],
                        'openIDConnectConfig' => [
                            'authTTL' => <integer>,
                            'clientId' => '<string>',
                            'iatTTL' => <integer>,
                            'issuer' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'connectionAuthModes' => [
                    [
                        'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                    ],
                    // ...
                ],
                'defaultPublishAuthModes' => [
                    [
                        'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                    ],
                    // ...
                ],
                'defaultSubscribeAuthModes' => [
                    [
                        'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                    ],
                    // ...
                ],
                'logConfig' => [
                    'cloudWatchLogsRoleArn' => '<string>',
                    'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG',
                ],
            ],
            'name' => '<string>',
            'ownerContact' => '<string>',
            'tags' => ['<string>', ...],
            'wafWebAclArn' => '<string>',
            'xrayEnabled' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListChannelNamespaces

$result = $client->listChannelNamespaces([/* ... */]);
$promise = $client->listChannelNamespacesAsync([/* ... */]);

Lists the channel namespaces for a specified Api.

ListChannelNamespaces returns only high level details for the channel namespace. To retrieve code handlers, use GetChannelNamespace.

Parameter Syntax

$result = $client->listChannelNamespaces([
    'apiId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'channelNamespaces' => [
        [
            'apiId' => '<string>',
            'channelNamespaceArn' => '<string>',
            'codeHandlers' => '<string>',
            'created' => <DateTime>,
            'handlerConfigs' => [
                'onPublish' => [
                    'behavior' => 'CODE|DIRECT',
                    'integration' => [
                        'dataSourceName' => '<string>',
                        'lambdaConfig' => [
                            'invokeType' => 'REQUEST_RESPONSE|EVENT',
                        ],
                    ],
                ],
                'onSubscribe' => [
                    'behavior' => 'CODE|DIRECT',
                    'integration' => [
                        'dataSourceName' => '<string>',
                        'lambdaConfig' => [
                            'invokeType' => 'REQUEST_RESPONSE|EVENT',
                        ],
                    ],
                ],
            ],
            'lastModified' => <DateTime>,
            'name' => '<string>',
            'publishAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'subscribeAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListDataSources

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

Lists the data sources for a given API.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListDomainNames

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

Lists multiple custom domain names.

Parameter Syntax

$result = $client->listDomainNames([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

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

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListFunctions

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

List multiple functions.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListGraphqlApis

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

Lists your GraphQL APIs.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'graphqlApis' => [
        [
            'additionalAuthenticationProviders' => [
                [
                    'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                    'lambdaAuthorizerConfig' => [
                        'authorizerResultTtlInSeconds' => <integer>,
                        'authorizerUri' => '<string>',
                        'identityValidationExpression' => '<string>',
                    ],
                    'openIDConnectConfig' => [
                        'authTTL' => <integer>,
                        'clientId' => '<string>',
                        'iatTTL' => <integer>,
                        'issuer' => '<string>',
                    ],
                    'userPoolConfig' => [
                        'appIdClientRegex' => '<string>',
                        'awsRegion' => '<string>',
                        'userPoolId' => '<string>',
                    ],
                ],
                // ...
            ],
            'apiId' => '<string>',
            'apiType' => 'GRAPHQL|MERGED',
            'arn' => '<string>',
            'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
            'dns' => ['<string>', ...],
            'enhancedMetricsConfig' => [
                'dataSourceLevelMetricsBehavior' => 'FULL_REQUEST_DATA_SOURCE_METRICS|PER_DATA_SOURCE_METRICS',
                'operationLevelMetricsConfig' => 'ENABLED|DISABLED',
                'resolverLevelMetricsBehavior' => 'FULL_REQUEST_RESOLVER_METRICS|PER_RESOLVER_METRICS',
            ],
            'introspectionConfig' => 'ENABLED|DISABLED',
            'lambdaAuthorizerConfig' => [
                'authorizerResultTtlInSeconds' => <integer>,
                'authorizerUri' => '<string>',
                'identityValidationExpression' => '<string>',
            ],
            'logConfig' => [
                'cloudWatchLogsRoleArn' => '<string>',
                'excludeVerboseContent' => true || false,
                'fieldLogLevel' => 'NONE|ERROR|ALL|INFO|DEBUG',
            ],
            'mergedApiExecutionRoleArn' => '<string>',
            'name' => '<string>',
            'openIDConnectConfig' => [
                'authTTL' => <integer>,
                'clientId' => '<string>',
                'iatTTL' => <integer>,
                'issuer' => '<string>',
            ],
            'owner' => '<string>',
            'ownerContact' => '<string>',
            'queryDepthLimit' => <integer>,
            'resolverCountLimit' => <integer>,
            'tags' => ['<string>', ...],
            'uris' => ['<string>', ...],
            'userPoolConfig' => [
                'appIdClientRegex' => '<string>',
                'awsRegion' => '<string>',
                'defaultAction' => 'ALLOW|DENY',
                'userPoolId' => '<string>',
            ],
            'visibility' => 'GLOBAL|PRIVATE',
            'wafWebAclArn' => '<string>',
            'xrayEnabled' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListResolvers

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

Lists the resolvers for a given API and type.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListResolversByFunction

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

List the resolvers that are associated with a specific function.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListSourceApiAssociations

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

Lists the SourceApiAssociationSummary data.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

UnauthorizedException:

You aren't authorized to perform this operation.

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

ListTagsForResource

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

Lists the tags for a resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

LimitExceededException:

The request exceeded a limit. Try your request again.

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

ListTypes

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

Lists the types for a given API.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ListTypesByAssociation

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

Lists Type objects by the source API association ID.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

PutGraphqlApiEnvironmentVariables

$result = $client->putGraphqlApiEnvironmentVariables([/* ... */]);
$promise = $client->putGraphqlApiEnvironmentVariablesAsync([/* ... */]);

Creates a list of environmental variables in an API by its ID value.

When creating an environmental variable, it must follow the constraints below:

• Both JavaScript and VTL templates support environmental variables.

• Environmental variables are not evaluated before function invocation.

• Environmental variables only support string values.

• Any defined value in an environmental variable is considered a string literal and not expanded.

• Variable evaluations should ideally be performed in the function code.

When creating an environmental variable key-value pair, it must follow the additional constraints below:

• Keys must begin with a letter.

• Keys must be at least two characters long.

• Keys can only contain letters, numbers, and the underscore character (_).

• Values can be up to 512 characters long.

• You can configure up to 50 key-value pairs in a GraphQL API.

You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.

Parameter Syntax

$result = $client->putGraphqlApiEnvironmentVariables([
    'apiId' => '<string>', // REQUIRED
    'environmentVariables' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

StartDataSourceIntrospection

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

BadRequestException:

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

StartSchemaCreation

$result = $client->startSchemaCreation([/* ... */]);
$promise = $client->startSchemaCreationAsync([/* ... */]);

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

Parameter Syntax

$result = $client->startSchemaCreation([
    'apiId' => '<string>', // REQUIRED
    'definition' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'PROCESSING|ACTIVE|DELETING|FAILED|SUCCESS|NOT_APPLICABLE',
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

StartSchemaMerge

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

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

Parameter Syntax

$result = $client->startSchemaMerge([
    'associationId' => '<string>', // REQUIRED
    'mergedApiIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'sourceApiAssociationStatus' => 'MERGE_SCHEDULED|MERGE_FAILED|MERGE_SUCCESS|MERGE_IN_PROGRESS|AUTO_MERGE_SCHEDULE_FAILED|DELETION_SCHEDULED|DELETION_IN_PROGRESS|DELETION_FAILED',
]

Result Details

Errors

UnauthorizedException:

You aren't authorized to perform this operation.

BadRequestException:

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

InternalFailureException:

An internal AppSync error occurred. Try your request again.

NotFoundException:

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

ConcurrentModificationException:

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

TagResource

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

Tags a resource with user-supplied tags.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

LimitExceededException:

The request exceeded a limit. Try your request again.

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

UntagResource

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

Untags a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

LimitExceededException:

The request exceeded a limit. Try your request again.

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

UpdateApi

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

Updates an Api.

Parameter Syntax

$result = $client->updateApi([
    'apiId' => '<string>', // REQUIRED
    'eventConfig' => [
        'authProviders' => [ // REQUIRED
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
                'cognitoConfig' => [
                    'appIdClientRegex' => '<string>',
                    'awsRegion' => '<string>', // REQUIRED
                    'userPoolId' => '<string>', // REQUIRED
                ],
                'lambdaAuthorizerConfig' => [
                    'authorizerResultTtlInSeconds' => <integer>,
                    'authorizerUri' => '<string>', // REQUIRED
                    'identityValidationExpression' => '<string>',
                ],
                'openIDConnectConfig' => [
                    'authTTL' => <integer>,
                    'clientId' => '<string>',
                    'iatTTL' => <integer>,
                    'issuer' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
        'connectionAuthModes' => [ // REQUIRED
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
            ],
            // ...
        ],
        'defaultPublishAuthModes' => [ // REQUIRED
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
            ],
            // ...
        ],
        'defaultSubscribeAuthModes' => [ // REQUIRED
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
            ],
            // ...
        ],
        'logConfig' => [
            'cloudWatchLogsRoleArn' => '<string>', // REQUIRED
            'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG', // REQUIRED
        ],
    ],
    'name' => '<string>', // REQUIRED
    'ownerContact' => '<string>',
]);

Parameter Details

Result Syntax

[
    'api' => [
        'apiArn' => '<string>',
        'apiId' => '<string>',
        'created' => <DateTime>,
        'dns' => ['<string>', ...],
        'eventConfig' => [
            'authProviders' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                    'cognitoConfig' => [
                        'appIdClientRegex' => '<string>',
                        'awsRegion' => '<string>',
                        'userPoolId' => '<string>',
                    ],
                    'lambdaAuthorizerConfig' => [
                        'authorizerResultTtlInSeconds' => <integer>,
                        'authorizerUri' => '<string>',
                        'identityValidationExpression' => '<string>',
                    ],
                    'openIDConnectConfig' => [
                        'authTTL' => <integer>,
                        'clientId' => '<string>',
                        'iatTTL' => <integer>,
                        'issuer' => '<string>',
                    ],
                ],
                // ...
            ],
            'connectionAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'defaultPublishAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'defaultSubscribeAuthModes' => [
                [
                    'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
                ],
                // ...
            ],
            'logConfig' => [
                'cloudWatchLogsRoleArn' => '<string>',
                'logLevel' => 'NONE|ERROR|ALL|INFO|DEBUG',
            ],
        ],
        'name' => '<string>',
        'ownerContact' => '<string>',
        'tags' => ['<string>', ...],
        'wafWebAclArn' => '<string>',
        'xrayEnabled' => true || false,
    ],
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

UpdateApiCache

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

Updates the cache for the GraphQL API.

Parameter Syntax

$result = $client->updateApiCache([
    'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING|OPERATION_LEVEL_CACHING', // REQUIRED
    'apiId' => '<string>', // REQUIRED
    'healthMetricsConfig' => 'ENABLED|DISABLED',
    'ttl' => <integer>, // REQUIRED
    'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X', // REQUIRED
]);

Parameter Details

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' => <integer>,
        'type' => 'T2_SMALL|T2_MEDIUM|R4_LARGE|R4_XLARGE|R4_2XLARGE|R4_4XLARGE|R4_8XLARGE|SMALL|MEDIUM|LARGE|XLARGE|LARGE_2X|LARGE_4X|LARGE_8X|LARGE_12X',
    ],
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

UpdateApiKey

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'apiKey' => [
        'deletes' => <integer>,
        'description' => '<string>',
        'expires' => <integer>,
        'id' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

ApiKeyValidityOutOfBoundsException:

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

UpdateChannelNamespace

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

Updates a ChannelNamespace associated with an Api.

Parameter Syntax

$result = $client->updateChannelNamespace([
    'apiId' => '<string>', // REQUIRED
    'codeHandlers' => '<string>',
    'handlerConfigs' => [
        'onPublish' => [
            'behavior' => 'CODE|DIRECT', // REQUIRED
            'integration' => [ // REQUIRED
                'dataSourceName' => '<string>', // REQUIRED
                'lambdaConfig' => [
                    'invokeType' => 'REQUEST_RESPONSE|EVENT',
                ],
            ],
        ],
        'onSubscribe' => [
            'behavior' => 'CODE|DIRECT', // REQUIRED
            'integration' => [ // REQUIRED
                'dataSourceName' => '<string>', // REQUIRED
                'lambdaConfig' => [
                    'invokeType' => 'REQUEST_RESPONSE|EVENT',
                ],
            ],
        ],
    ],
    'name' => '<string>', // REQUIRED
    'publishAuthModes' => [
        [
            'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
        ],
        // ...
    ],
    'subscribeAuthModes' => [
        [
            'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'channelNamespace' => [
        'apiId' => '<string>',
        'channelNamespaceArn' => '<string>',
        'codeHandlers' => '<string>',
        'created' => <DateTime>,
        'handlerConfigs' => [
            'onPublish' => [
                'behavior' => 'CODE|DIRECT',
                'integration' => [
                    'dataSourceName' => '<string>',
                    'lambdaConfig' => [
                        'invokeType' => 'REQUEST_RESPONSE|EVENT',
                    ],
                ],
            ],
            'onSubscribe' => [
                'behavior' => 'CODE|DIRECT',
                'integration' => [
                    'dataSourceName' => '<string>',
                    'lambdaConfig' => [
                        'invokeType' => 'REQUEST_RESPONSE|EVENT',
                    ],
                ],
            ],
        ],
        'lastModified' => <DateTime>,
        'name' => '<string>',
        'publishAuthModes' => [
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
            ],
            // ...
        ],
        'subscribeAuthModes' => [
            [
                'authType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

BadRequestException:

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

ConcurrentModificationException:

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

NotFoundException:

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

UnauthorizedException:

You aren't authorized to perform this operation.

InternalFailureException:

An internal AppSync error occurred. Try your request again.

AccessDeniedException:

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

UpdateDataSource

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

Updates a DataSource object.

Parameter Syntax

$result = $client->updateDataSource([
    'apiId' => '<string>', // REQUIRED
    'description' => '<string>',
    'dynamodbConfig' => [
        'awsRegion' => '<string>', // REQUIRED
        'deltaSyncConfig' => [
            'baseTableTTL' => <integer>,
            'deltaSyncTableName' => '<string>',
            'deltaSyncTableTTL' => <integer>,
        ],
        'tableName' => '<string>', // REQUIRED
        'useCallerCredentials' => true || false,
        'versioned' => true || false,
    ],
    'elasticsearchConfig' => [
        'awsRegion' => '<string>', // REQUIRED
        'endpoint' => '<string>', // REQUIRED
    ],
    'eventBridgeConfig' => [
        'eventBusArn' => '<string>', // REQUIRED
    ],
    'httpConfig' => [
        'authorizationConfig' => [
            'authorizationType' => 'AWS_IAM', // REQUIRED
            'awsIamConfig' => [
                'signingRegion' => '<string>',
                'signingServiceName' => '<string>',
            ],
        ],
        'endpoint' => '<string>',
    ],
    'lambdaConfig' => [
        'lambdaFunctionArn' => '<string>', // REQUIRED
    ],
    'metricsConfig' => 'ENABLED|DISABLED',
    'name' => '<string>', // REQUIRED
    'openSearchServiceConfig' => [
        'awsRegion' => '<string>', // REQUIRED
        'endpoint' => '<string>', // REQUIRED
    ],
    'relationalDatabaseConfig' => [
        'rdsHttpEndpointConfig' => [
            'awsRegion' => '<string>',
            'awsSecretStoreArn' => '<string>',
            'databaseName' => '<string>',
            'dbClusterIdentifier' => '<string>',
            'schema' => '<string>',
        ],
        'relationalDatabaseSourceType' => 'RDS_HTTP_ENDPOINT',
    ],
    'serviceRoleArn' => '<string>',
    'type' => 'AWS_LAMBDA|AMAZON_DYNAMODB|AMAZON_ELASTICSEARCH|NONE|HTTP|RELATIONAL_DATABASE|AMAZON_OPENSEARCH_SERVICE|AMAZON_EVENTBRIDGE|AMAZON_BEDROCK_RUNTIME', // REQUIRED
]);

Parameter Details