The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.41
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::AppSync

NAME

Paws::AppSync - Perl Interface to AWS AWS AppSync

SYNOPSIS

  use Paws;

  my $obj = Paws->service('AppSync');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25

METHODS

CreateApiKey

ApiId => Str
[Description => Str]
[Expires => Int]

Each argument is described in detail in: Paws::AppSync::CreateApiKey

Returns: a Paws::AppSync::CreateApiKeyResponse instance

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

CreateDataSource

ApiId => Str
Name => Str
Type => Str
[Description => Str]
[DynamodbConfig => Paws::AppSync::DynamodbDataSourceConfig]
[ElasticsearchConfig => Paws::AppSync::ElasticsearchDataSourceConfig]
[HttpConfig => Paws::AppSync::HttpDataSourceConfig]
[LambdaConfig => Paws::AppSync::LambdaDataSourceConfig]
[RelationalDatabaseConfig => Paws::AppSync::RelationalDatabaseDataSourceConfig]
[ServiceRoleArn => Str]

Each argument is described in detail in: Paws::AppSync::CreateDataSource

Returns: a Paws::AppSync::CreateDataSourceResponse instance

Creates a DataSource object.

CreateFunction

ApiId => Str
DataSourceName => Str
FunctionVersion => Str
Name => Str
RequestMappingTemplate => Str
[Description => Str]
[ResponseMappingTemplate => Str]

Each argument is described in detail in: Paws::AppSync::CreateFunction

Returns: a Paws::AppSync::CreateFunctionResponse instance

Creates a Function object.

A function is a reusable entity. Multiple functions can be used to compose the resolver logic.

CreateGraphqlApi

AuthenticationType => Str
Name => Str
[AdditionalAuthenticationProviders => ArrayRef[Paws::AppSync::AdditionalAuthenticationProvider]]
[LogConfig => Paws::AppSync::LogConfig]
[OpenIDConnectConfig => Paws::AppSync::OpenIDConnectConfig]
[Tags => Paws::AppSync::TagMap]
[UserPoolConfig => Paws::AppSync::UserPoolConfig]

Each argument is described in detail in: Paws::AppSync::CreateGraphqlApi

Returns: a Paws::AppSync::CreateGraphqlApiResponse instance

Creates a GraphqlApi object.

CreateResolver

ApiId => Str
FieldName => Str
RequestMappingTemplate => Str
TypeName => Str
[DataSourceName => Str]
[Kind => Str]
[PipelineConfig => Paws::AppSync::PipelineConfig]
[ResponseMappingTemplate => Str]

Each argument is described in detail in: Paws::AppSync::CreateResolver

Returns: a Paws::AppSync::CreateResolverResponse instance

Creates a Resolver object.

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

CreateType

ApiId => Str
Definition => Str
Format => Str

Each argument is described in detail in: Paws::AppSync::CreateType

Returns: a Paws::AppSync::CreateTypeResponse instance

Creates a Type object.

DeleteApiKey

ApiId => Str
Id => Str

Each argument is described in detail in: Paws::AppSync::DeleteApiKey

Returns: a Paws::AppSync::DeleteApiKeyResponse instance

Deletes an API key.

DeleteDataSource

ApiId => Str
Name => Str

Each argument is described in detail in: Paws::AppSync::DeleteDataSource

Returns: a Paws::AppSync::DeleteDataSourceResponse instance

Deletes a DataSource object.

DeleteFunction

ApiId => Str
FunctionId => Str

Each argument is described in detail in: Paws::AppSync::DeleteFunction

Returns: a Paws::AppSync::DeleteFunctionResponse instance

Deletes a Function.

DeleteGraphqlApi

ApiId => Str

Each argument is described in detail in: Paws::AppSync::DeleteGraphqlApi

Returns: a Paws::AppSync::DeleteGraphqlApiResponse instance

Deletes a GraphqlApi object.

DeleteResolver

ApiId => Str
FieldName => Str
TypeName => Str

Each argument is described in detail in: Paws::AppSync::DeleteResolver

Returns: a Paws::AppSync::DeleteResolverResponse instance

Deletes a Resolver object.

DeleteType

ApiId => Str
TypeName => Str

Each argument is described in detail in: Paws::AppSync::DeleteType

Returns: a Paws::AppSync::DeleteTypeResponse instance

Deletes a Type object.

GetDataSource

ApiId => Str
Name => Str

Each argument is described in detail in: Paws::AppSync::GetDataSource

Returns: a Paws::AppSync::GetDataSourceResponse instance

Retrieves a DataSource object.

GetFunction

ApiId => Str
FunctionId => Str

Each argument is described in detail in: Paws::AppSync::GetFunction

Returns: a Paws::AppSync::GetFunctionResponse instance

Get a Function.

GetGraphqlApi

ApiId => Str

Each argument is described in detail in: Paws::AppSync::GetGraphqlApi

Returns: a Paws::AppSync::GetGraphqlApiResponse instance

Retrieves a GraphqlApi object.

GetIntrospectionSchema

ApiId => Str
Format => Str
[IncludeDirectives => Bool]

Each argument is described in detail in: Paws::AppSync::GetIntrospectionSchema

Returns: a Paws::AppSync::GetIntrospectionSchemaResponse instance

Retrieves the introspection schema for a GraphQL API.

GetResolver

ApiId => Str
FieldName => Str
TypeName => Str

Each argument is described in detail in: Paws::AppSync::GetResolver

Returns: a Paws::AppSync::GetResolverResponse instance

Retrieves a Resolver object.

GetSchemaCreationStatus

ApiId => Str

Each argument is described in detail in: Paws::AppSync::GetSchemaCreationStatus

Returns: a Paws::AppSync::GetSchemaCreationStatusResponse instance

Retrieves the current status of a schema creation operation.

GetType

ApiId => Str
Format => Str
TypeName => Str

Each argument is described in detail in: Paws::AppSync::GetType

Returns: a Paws::AppSync::GetTypeResponse instance

Retrieves a Type object.

ListApiKeys

ApiId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppSync::ListApiKeys

Returns: a Paws::AppSync::ListApiKeysResponse instance

Lists the API keys for a given API.

API keys are deleted automatically sometime after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.

ListDataSources

ApiId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppSync::ListDataSources

Returns: a Paws::AppSync::ListDataSourcesResponse instance

Lists the data sources for a given API.

ListFunctions

ApiId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppSync::ListFunctions

Returns: a Paws::AppSync::ListFunctionsResponse instance

List multiple functions.

ListGraphqlApis

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppSync::ListGraphqlApis

Returns: a Paws::AppSync::ListGraphqlApisResponse instance

Lists your GraphQL APIs.

ListResolvers

ApiId => Str
TypeName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppSync::ListResolvers

Returns: a Paws::AppSync::ListResolversResponse instance

Lists the resolvers for a given API and type.

ListResolversByFunction

ApiId => Str
FunctionId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppSync::ListResolversByFunction

Returns: a Paws::AppSync::ListResolversByFunctionResponse instance

List the resolvers that are associated with a specific function.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::AppSync::ListTagsForResource

Returns: a Paws::AppSync::ListTagsForResourceResponse instance

Lists the tags for a resource.

ListTypes

ApiId => Str
Format => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AppSync::ListTypes

Returns: a Paws::AppSync::ListTypesResponse instance

Lists the types for a given API.

StartSchemaCreation

ApiId => Str
Definition => Str

Each argument is described in detail in: Paws::AppSync::StartSchemaCreation

Returns: a Paws::AppSync::StartSchemaCreationResponse instance

Adds a new schema to your GraphQL API.

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

TagResource

ResourceArn => Str
Tags => Paws::AppSync::TagMap

Each argument is described in detail in: Paws::AppSync::TagResource

Returns: a Paws::AppSync::TagResourceResponse instance

Tags a resource with user-supplied tags.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::AppSync::UntagResource

Returns: a Paws::AppSync::UntagResourceResponse instance

Untags a resource.

UpdateApiKey

ApiId => Str
Id => Str
[Description => Str]
[Expires => Int]

Each argument is described in detail in: Paws::AppSync::UpdateApiKey

Returns: a Paws::AppSync::UpdateApiKeyResponse instance

Updates an API key.

UpdateDataSource

ApiId => Str
Name => Str
Type => Str
[Description => Str]
[DynamodbConfig => Paws::AppSync::DynamodbDataSourceConfig]
[ElasticsearchConfig => Paws::AppSync::ElasticsearchDataSourceConfig]
[HttpConfig => Paws::AppSync::HttpDataSourceConfig]
[LambdaConfig => Paws::AppSync::LambdaDataSourceConfig]
[RelationalDatabaseConfig => Paws::AppSync::RelationalDatabaseDataSourceConfig]
[ServiceRoleArn => Str]

Each argument is described in detail in: Paws::AppSync::UpdateDataSource

Returns: a Paws::AppSync::UpdateDataSourceResponse instance

Updates a DataSource object.

UpdateFunction

ApiId => Str
DataSourceName => Str
FunctionId => Str
FunctionVersion => Str
Name => Str
RequestMappingTemplate => Str
[Description => Str]
[ResponseMappingTemplate => Str]

Each argument is described in detail in: Paws::AppSync::UpdateFunction

Returns: a Paws::AppSync::UpdateFunctionResponse instance

Updates a Function object.

UpdateGraphqlApi

ApiId => Str
Name => Str
[AdditionalAuthenticationProviders => ArrayRef[Paws::AppSync::AdditionalAuthenticationProvider]]
[AuthenticationType => Str]
[LogConfig => Paws::AppSync::LogConfig]
[OpenIDConnectConfig => Paws::AppSync::OpenIDConnectConfig]
[UserPoolConfig => Paws::AppSync::UserPoolConfig]

Each argument is described in detail in: Paws::AppSync::UpdateGraphqlApi

Returns: a Paws::AppSync::UpdateGraphqlApiResponse instance

Updates a GraphqlApi object.

UpdateResolver

ApiId => Str
FieldName => Str
RequestMappingTemplate => Str
TypeName => Str
[DataSourceName => Str]
[Kind => Str]
[PipelineConfig => Paws::AppSync::PipelineConfig]
[ResponseMappingTemplate => Str]

Each argument is described in detail in: Paws::AppSync::UpdateResolver

Returns: a Paws::AppSync::UpdateResolverResponse instance

Updates a Resolver object.

UpdateType

ApiId => Str
Format => Str
TypeName => Str
[Definition => Str]

Each argument is described in detail in: Paws::AppSync::UpdateType

Returns: a Paws::AppSync::UpdateTypeResponse instance

Updates a Type object.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllApiKeys(sub { },ApiId => Str, [MaxResults => Int, NextToken => Str])

ListAllApiKeys(ApiId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - apiKeys, passing the object as the first parameter, and the string 'apiKeys' as the second parameter

If not, it will return a a Paws::AppSync::ListApiKeysResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllDataSources(sub { },ApiId => Str, [MaxResults => Int, NextToken => Str])

ListAllDataSources(ApiId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - dataSources, passing the object as the first parameter, and the string 'dataSources' as the second parameter

If not, it will return a a Paws::AppSync::ListDataSourcesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllFunctions(sub { },ApiId => Str, [MaxResults => Int, NextToken => Str])

ListAllFunctions(ApiId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - functions, passing the object as the first parameter, and the string 'functions' as the second parameter

If not, it will return a a Paws::AppSync::ListFunctionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllGraphqlApis(sub { },[MaxResults => Int, NextToken => Str])

ListAllGraphqlApis([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - graphqlApis, passing the object as the first parameter, and the string 'graphqlApis' as the second parameter

If not, it will return a a Paws::AppSync::ListGraphqlApisResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllResolvers(sub { },ApiId => Str, TypeName => Str, [MaxResults => Int, NextToken => Str])

ListAllResolvers(ApiId => Str, TypeName => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - resolvers, passing the object as the first parameter, and the string 'resolvers' as the second parameter

If not, it will return a a Paws::AppSync::ListResolversResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllResolversByFunction(sub { },ApiId => Str, FunctionId => Str, [MaxResults => Int, NextToken => Str])

ListAllResolversByFunction(ApiId => Str, FunctionId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - resolvers, passing the object as the first parameter, and the string 'resolvers' as the second parameter

If not, it will return a a Paws::AppSync::ListResolversByFunctionResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTypes(sub { },ApiId => Str, Format => Str, [MaxResults => Int, NextToken => Str])

ListAllTypes(ApiId => Str, Format => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - types, passing the object as the first parameter, and the string 'types' as the second parameter

If not, it will return a a Paws::AppSync::ListTypesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues