AWS AppSync 2017-07-25

AssociateApi

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

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.

CreateApiCache

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

Parameter Syntax

$result = $client->createApiCache([
    'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING', // REQUIRED
    'apiId' => '<string>', // REQUIRED
    'atRestEncryptionEnabled' => true || false,
    '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',
        'atRestEncryptionEnabled' => true || false,
        '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([/* ... */]);

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).

CreateDataSource

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

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
    ],
    'httpConfig' => [
        'authorizationConfig' => [
            'authorizationType' => 'AWS_IAM', // REQUIRED
            'awsIamConfig' => [
                'signingRegion' => '<string>',
                'signingServiceName' => '<string>',
            ],
        ],
        'endpoint' => '<string>',
    ],
    'lambdaConfig' => [
        'lambdaFunctionArn' => '<string>', // REQUIRED
    ],
    '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', // 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>',
        ],
        'httpConfig' => [
            'authorizationConfig' => [
                'authorizationType' => 'AWS_IAM',
                'awsIamConfig' => [
                    'signingRegion' => '<string>',
                    'signingServiceName' => '<string>',
                ],
            ],
            'endpoint' => '<string>',
        ],
        'lambdaConfig' => [
            'lambdaFunctionArn' => '<string>',
        ],
        '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',
    ],
]

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'domainNameConfig' => [
        'appsyncDomainName' => '<string>',
        'certificateArn' => '<string>',
        'description' => '<string>',
        'domainName' => '<string>',
        'hostedZoneId' => '<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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'functionConfiguration' => [
        'dataSourceName' => '<string>',
        'description' => '<string>',
        'functionArn' => '<string>',
        'functionId' => '<string>',
        'functionVersion' => '<string>',
        'maxBatchSize' => <integer>,
        'name' => '<string>',
        'requestMappingTemplate' => '<string>',
        'responseMappingTemplate' => '<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.

CreateGraphqlApi

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

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
            ],
        ],
        // ...
    ],
    'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA', // REQUIRED
    'lambdaAuthorizerConfig' => [
        'authorizerResultTtlInSeconds' => <integer>,
        'authorizerUri' => '<string>', // REQUIRED
        'identityValidationExpression' => '<string>',
    ],
    'logConfig' => [
        'cloudWatchLogsRoleArn' => '<string>', // REQUIRED
        'excludeVerboseContent' => true || false,
        'fieldLogLevel' => 'NONE|ERROR|ALL', // REQUIRED
    ],
    'name' => '<string>', // REQUIRED
    'openIDConnectConfig' => [
        'authTTL' => <integer>,
        'clientId' => '<string>',
        'iatTTL' => <integer>,
        'issuer' => '<string>', // REQUIRED
    ],
    'tags' => ['<string>', ...],
    'userPoolConfig' => [
        'appIdClientRegex' => '<string>',
        'awsRegion' => '<string>', // REQUIRED
        'defaultAction' => 'ALLOW|DENY', // REQUIRED
        'userPoolId' => '<string>', // REQUIRED
    ],
    '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>',
        'arn' => '<string>',
        'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
        'lambdaAuthorizerConfig' => [
            'authorizerResultTtlInSeconds' => <integer>,
            'authorizerUri' => '<string>',
            'identityValidationExpression' => '<string>',
        ],
        'logConfig' => [
            'cloudWatchLogsRoleArn' => '<string>',
            'excludeVerboseContent' => true || false,
            'fieldLogLevel' => 'NONE|ERROR|ALL',
        ],
        'name' => '<string>',
        'openIDConnectConfig' => [
            'authTTL' => <integer>,
            'clientId' => '<string>',
            'iatTTL' => <integer>,
            'issuer' => '<string>',
        ],
        'tags' => ['<string>', ...],
        'uris' => ['<string>', ...],
        'userPoolConfig' => [
            'appIdClientRegex' => '<string>',
            'awsRegion' => '<string>',
            'defaultAction' => 'ALLOW|DENY',
            'userPoolId' => '<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.

• 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([/* ... */]);

Parameter Syntax

$result = $client->createResolver([
    'apiId' => '<string>', // REQUIRED
    'cachingConfig' => [
        'cachingKeys' => ['<string>', ...],
        'ttl' => <integer>,
    ],
    'dataSourceName' => '<string>',
    'fieldName' => '<string>', // REQUIRED
    'kind' => 'UNIT|PIPELINE',
    'maxBatchSize' => <integer>,
    'pipelineConfig' => [
        'functions' => ['<string>', ...],
    ],
    'requestMappingTemplate' => '<string>',
    'responseMappingTemplate' => '<string>',
    '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>,
        ],
        'dataSourceName' => '<string>',
        'fieldName' => '<string>',
        'kind' => 'UNIT|PIPELINE',
        'maxBatchSize' => <integer>,
        'pipelineConfig' => [
            'functions' => ['<string>', ...],
        ],
        'requestMappingTemplate' => '<string>',
        'resolverArn' => '<string>',
        'responseMappingTemplate' => '<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.

CreateType

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

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.

DeleteApiCache

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

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([/* ... */]);

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.

DeleteDataSource

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

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([/* ... */]);

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([/* ... */]);

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.

DeleteGraphqlApi

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

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([/* ... */]);

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.

DeleteType

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

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([/* ... */]);

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.

FlushApiCache

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

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([/* ... */]);

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'apiCache' => [
        'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING',
        'atRestEncryptionEnabled' => true || false,
        '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.

GetDataSource

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

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>',
        ],
        'httpConfig' => [
            'authorizationConfig' => [
                'authorizationType' => 'AWS_IAM',
                'awsIamConfig' => [
                    'signingRegion' => '<string>',
                    'signingServiceName' => '<string>',
                ],
            ],
            'endpoint' => '<string>',
        ],
        'lambdaConfig' => [
            'lambdaFunctionArn' => '<string>',
        ],
        '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',
    ],
]

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.

GetDomainName

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'domainNameConfig' => [
        'appsyncDomainName' => '<string>',
        'certificateArn' => '<string>',
        'description' => '<string>',
        'domainName' => '<string>',
        'hostedZoneId' => '<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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'functionConfiguration' => [
        'dataSourceName' => '<string>',
        'description' => '<string>',
        'functionArn' => '<string>',
        'functionId' => '<string>',
        'functionVersion' => '<string>',
        'maxBatchSize' => <integer>,
        'name' => '<string>',
        'requestMappingTemplate' => '<string>',
        'responseMappingTemplate' => '<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([/* ... */]);

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>',
        'arn' => '<string>',
        'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
        'lambdaAuthorizerConfig' => [
            'authorizerResultTtlInSeconds' => <integer>,
            'authorizerUri' => '<string>',
            'identityValidationExpression' => '<string>',
        ],
        'logConfig' => [
            'cloudWatchLogsRoleArn' => '<string>',
            'excludeVerboseContent' => true || false,
            'fieldLogLevel' => 'NONE|ERROR|ALL',
        ],
        'name' => '<string>',
        'openIDConnectConfig' => [
            'authTTL' => <integer>,
            'clientId' => '<string>',
            'iatTTL' => <integer>,
            'issuer' => '<string>',
        ],
        'tags' => ['<string>', ...],
        'uris' => ['<string>', ...],
        'userPoolConfig' => [
            'appIdClientRegex' => '<string>',
            'awsRegion' => '<string>',
            'defaultAction' => 'ALLOW|DENY',
            'userPoolId' => '<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.

GetIntrospectionSchema

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

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'resolver' => [
        'cachingConfig' => [
            'cachingKeys' => ['<string>', ...],
            'ttl' => <integer>,
        ],
        'dataSourceName' => '<string>',
        'fieldName' => '<string>',
        'kind' => 'UNIT|PIPELINE',
        'maxBatchSize' => <integer>,
        'pipelineConfig' => [
            'functions' => ['<string>', ...],
        ],
        'requestMappingTemplate' => '<string>',
        'resolverArn' => '<string>',
        'responseMappingTemplate' => '<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([/* ... */]);

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.

GetType

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

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([/* ... */]);

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.

ListDataSources

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

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>',
            ],
            'httpConfig' => [
                'authorizationConfig' => [
                    'authorizationType' => 'AWS_IAM',
                    'awsIamConfig' => [
                        'signingRegion' => '<string>',
                        'signingServiceName' => '<string>',
                    ],
                ],
                'endpoint' => '<string>',
            ],
            'lambdaConfig' => [
                'lambdaFunctionArn' => '<string>',
            ],
            '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',
        ],
        // ...
    ],
    '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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'domainNameConfigs' => [
        [
            'appsyncDomainName' => '<string>',
            'certificateArn' => '<string>',
            'description' => '<string>',
            'domainName' => '<string>',
            'hostedZoneId' => '<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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'functions' => [
        [
            'dataSourceName' => '<string>',
            'description' => '<string>',
            'functionArn' => '<string>',
            'functionId' => '<string>',
            'functionVersion' => '<string>',
            'maxBatchSize' => <integer>,
            'name' => '<string>',
            'requestMappingTemplate' => '<string>',
            'responseMappingTemplate' => '<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([/* ... */]);

Parameter Syntax

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

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>',
            'arn' => '<string>',
            'authenticationType' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT|AWS_LAMBDA',
            'lambdaAuthorizerConfig' => [
                'authorizerResultTtlInSeconds' => <integer>,
                'authorizerUri' => '<string>',
                'identityValidationExpression' => '<string>',
            ],
            'logConfig' => [
                'cloudWatchLogsRoleArn' => '<string>',
                'excludeVerboseContent' => true || false,
                'fieldLogLevel' => 'NONE|ERROR|ALL',
            ],
            'name' => '<string>',
            'openIDConnectConfig' => [
                'authTTL' => <integer>,
                'clientId' => '<string>',
                'iatTTL' => <integer>,
                'issuer' => '<string>',
            ],
            'tags' => ['<string>', ...],
            'uris' => ['<string>', ...],
            'userPoolConfig' => [
                'appIdClientRegex' => '<string>',
                'awsRegion' => '<string>',
                'defaultAction' => 'ALLOW|DENY',
                'userPoolId' => '<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.

ListResolvers

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

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>,
            ],
            'dataSourceName' => '<string>',
            'fieldName' => '<string>',
            'kind' => 'UNIT|PIPELINE',
            'maxBatchSize' => <integer>,
            'pipelineConfig' => [
                'functions' => ['<string>', ...],
            ],
            'requestMappingTemplate' => '<string>',
            'resolverArn' => '<string>',
            'responseMappingTemplate' => '<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([/* ... */]);

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>,
            ],
            'dataSourceName' => '<string>',
            'fieldName' => '<string>',
            'kind' => 'UNIT|PIPELINE',
            'maxBatchSize' => <integer>,
            'pipelineConfig' => [
                'functions' => ['<string>', ...],
            ],
            'requestMappingTemplate' => '<string>',
            'resolverArn' => '<string>',
            'responseMappingTemplate' => '<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.

ListTagsForResource

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

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([/* ... */]);

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.

StartSchemaCreation

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

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.

TagResource

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

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([/* ... */]);

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.

UpdateApiCache

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

Parameter Syntax

$result = $client->updateApiCache([
    'apiCachingBehavior' => 'FULL_REQUEST_CACHING|PER_RESOLVER_CACHING', // REQUIRED
    'apiId' => '<string>', // REQUIRED
    '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