Skip to content
AWS for Query.Farm

aws.transfer.describe_agreement

Example SQL Queries

SELECT * FROM
aws.transfer.describe_agreement
WHERE
"agreement_id" = 'VALUE'
AND "server_id" = 'VALUE';

Description

Describes the agreement that's identified by the AgreementId.

Table Definition

Column NameColumn Data Type
agreement_id Required Input Column

A unique identifier for the agreement. This identifier is returned when you create an agreement.

VARCHAR
server_id Required Input Column

The server identifier that's associated with the agreement.

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
agreement

The details for the specified agreement, returned as a DescribedAgreement object.

STRUCT(
    "arn" VARCHAR,
    "agreement_id" VARCHAR,
    "description" VARCHAR,
    "status" VARCHAR,
    "server_id" VARCHAR,
    "local_profile_id" VARCHAR,
    "partner_profile_id" VARCHAR,
    "base_directory" VARCHAR,
    "access_role" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[]
)
Show child fields
agreement.access_role

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

agreement.agreement_id

A unique identifier for the agreement. This identifier is returned when you create an agreement.

agreement.arn

The unique Amazon Resource Name (ARN) for the agreement.

agreement.base_directory

The landing directory (folder) for files that are transferred by using the AS2 protocol.

agreement.description

The name or short description that's used to identify the agreement.

agreement.local_profile_id

A unique identifier for the AS2 local profile.

agreement.partner_profile_id

A unique identifier for the partner profile used in the agreement.

agreement.server_id

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

agreement.status

The current status of the agreement, either ACTIVE or INACTIVE.

agreement.tags[]
Show child fields
agreement.tags[].key

The name assigned to the tag that you create.

agreement.tags[].value

Contains one or more values that you assigned to the key name you create.