Skip to content
AWS for Query.Farm

aws.appsync.get_function

Example SQL Queries

SELECT * FROM
aws.appsync.get_function
WHERE
"api_id" = 'VALUE'
AND "function_id" = 'VALUE';

Description

Get a Function.

Table Definition

Column NameColumn Data Type
api_id Required Input Column

The GraphQL API ID.

VARCHAR
function_id Required Input Column

The Function ID.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
function_configuration

The Function object.

STRUCT(
    "function_id" VARCHAR,
    "function_arn" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "data_source_name" VARCHAR,
    "request_mapping_template" VARCHAR,
    "response_mapping_template" VARCHAR,
    "function_version" VARCHAR,
    "sync_config" STRUCT(
        "conflict_handler" VARCHAR,
        "conflict_detection" VARCHAR,
        "lambda_conflict_handler_config" STRUCT(
            "lambda_conflict_handler_arn" VARCHAR
        )
    ),
    "max_batch_size" BIGINT,
    "runtime" STRUCT(
        "name" VARCHAR,
        "runtime_version" VARCHAR
    ),
    "code" VARCHAR
)
Show child fields
function_configuration.code

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

function_configuration.data_source_name

The name of the DataSource.

function_configuration.description

The Function description.

function_configuration.function_arn

The Amazon Resource Name (ARN) of the Function object.

function_configuration.function_id

A unique ID representing the Function object.

function_configuration.function_version

The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.

function_configuration.max_batch_size

The maximum batching size for a resolver.

function_configuration.name

The name of the Function object.

function_configuration.request_mapping_template

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

function_configuration.response_mapping_template

The Function response mapping template.

function_configuration.runtime

Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

Show child fields
function_configuration.runtime.name

The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.

function_configuration.runtime.runtime_version

The version of the runtime to use. Currently, the only allowed version is 1.0.0.

function_configuration.sync_config

Describes a Sync configuration for a resolver.

Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

Show child fields
function_configuration.sync_config.conflict_detection

The Conflict Detection strategy to use.

  • VERSION: Detect conflicts based on object versions for this resolver.

  • NONE: Do not detect conflicts when invoking this resolver.

function_configuration.sync_config.conflict_handler

The Conflict Resolution strategy to perform in the event of a conflict.

  • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.

  • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.

  • LAMBDA: Resolve conflicts with an Lambda function supplied in the LambdaConflictHandlerConfig.

function_configuration.sync_config.lambda_conflict_handler_config

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

Show child fields
function_configuration.sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn

The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.