1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. transfer
  5. getAgreement

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.transfer.getAgreement

Get Started
aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Transfer::Agreement

    Using getAgreement

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAgreement(args: GetAgreementArgs, opts?: InvokeOptions): Promise<GetAgreementResult>
function getAgreementOutput(args: GetAgreementOutputArgs, opts?: InvokeOptions): Output<GetAgreementResult>
    def get_agreement(agreement_id: Optional[str] = None,
                  server_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetAgreementResult
def get_agreement_output(agreement_id: Optional[pulumi.Input[str]] = None,
                  server_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetAgreementResult]
    func LookupAgreement(ctx *Context, args *LookupAgreementArgs, opts ...InvokeOption) (*LookupAgreementResult, error)
func LookupAgreementOutput(ctx *Context, args *LookupAgreementOutputArgs, opts ...InvokeOption) LookupAgreementResultOutput

    > Note: This function is named LookupAgreement in the Go SDK.

    public static class GetAgreement 
{
    public static Task<GetAgreementResult> InvokeAsync(GetAgreementArgs args, InvokeOptions? opts = null)
    public static Output<GetAgreementResult> Invoke(GetAgreementInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgreementResult> getAgreement(GetAgreementArgs args, InvokeOptions options)
public static Output<GetAgreementResult> getAgreement(GetAgreementArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:transfer:getAgreement
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AgreementId string
    A unique identifier for the agreement.
    ServerId string
    A unique identifier for the server.
    AgreementId string
    A unique identifier for the agreement.
    ServerId string
    A unique identifier for the server.
    agreementId String
    A unique identifier for the agreement.
    serverId String
    A unique identifier for the server.
    agreementId string
    A unique identifier for the agreement.
    serverId string
    A unique identifier for the server.
    agreement_id str
    A unique identifier for the agreement.
    server_id str
    A unique identifier for the server.
    agreementId String
    A unique identifier for the agreement.
    serverId String
    A unique identifier for the server.

    getAgreement Result

    The following output properties are available:

    AccessRole string
    Specifies the access role for the agreement.
    AgreementId string
    A unique identifier for the agreement.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    BaseDirectory string
    Specifies the base directory for the agreement.
    CustomDirectories Pulumi.AwsNative.Transfer.Outputs.CustomDirectoriesProperties
    Specifies a separate directory for each type of file to store for an AS2 message.
    Description string
    A textual description for the agreement.
    EnforceMessageSigning Pulumi.AwsNative.Transfer.AgreementEnforceMessageSigning
    Specifies whether to enforce an AS2 message is signed for this agreement.
    LocalProfileId string
    A unique identifier for the local profile.
    PartnerProfileId string
    A unique identifier for the partner profile.
    PreserveFilename Pulumi.AwsNative.Transfer.AgreementPreserveFilename
    Specifies whether to preserve the filename received for this agreement.
    Status Pulumi.AwsNative.Transfer.AgreementStatus
    Specifies the status of the agreement.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
    AccessRole string
    Specifies the access role for the agreement.
    AgreementId string
    A unique identifier for the agreement.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    BaseDirectory string
    Specifies the base directory for the agreement.
    CustomDirectories CustomDirectoriesProperties
    Specifies a separate directory for each type of file to store for an AS2 message.
    Description string
    A textual description for the agreement.
    EnforceMessageSigning AgreementEnforceMessageSigning
    Specifies whether to enforce an AS2 message is signed for this agreement.
    LocalProfileId string
    A unique identifier for the local profile.
    PartnerProfileId string
    A unique identifier for the partner profile.
    PreserveFilename AgreementPreserveFilename
    Specifies whether to preserve the filename received for this agreement.
    Status AgreementStatus
    Specifies the status of the agreement.
    Tags Tag
    Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
    accessRole String
    Specifies the access role for the agreement.
    agreementId String
    A unique identifier for the agreement.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    baseDirectory String
    Specifies the base directory for the agreement.
    customDirectories CustomDirectoriesProperties
    Specifies a separate directory for each type of file to store for an AS2 message.
    description String
    A textual description for the agreement.
    enforceMessageSigning AgreementEnforceMessageSigning
    Specifies whether to enforce an AS2 message is signed for this agreement.
    localProfileId String
    A unique identifier for the local profile.
    partnerProfileId String
    A unique identifier for the partner profile.
    preserveFilename AgreementPreserveFilename
    Specifies whether to preserve the filename received for this agreement.
    status AgreementStatus
    Specifies the status of the agreement.
    tags List<Tag>
    Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
    accessRole string
    Specifies the access role for the agreement.
    agreementId string
    A unique identifier for the agreement.
    arn string
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    baseDirectory string
    Specifies the base directory for the agreement.
    customDirectories CustomDirectoriesProperties
    Specifies a separate directory for each type of file to store for an AS2 message.
    description string
    A textual description for the agreement.
    enforceMessageSigning AgreementEnforceMessageSigning
    Specifies whether to enforce an AS2 message is signed for this agreement.
    localProfileId string
    A unique identifier for the local profile.
    partnerProfileId string
    A unique identifier for the partner profile.
    preserveFilename AgreementPreserveFilename
    Specifies whether to preserve the filename received for this agreement.
    status AgreementStatus
    Specifies the status of the agreement.
    tags Tag[]
    Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
    access_role str
    Specifies the access role for the agreement.
    agreement_id str
    A unique identifier for the agreement.
    arn str
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    base_directory str
    Specifies the base directory for the agreement.
    custom_directories CustomDirectoriesProperties
    Specifies a separate directory for each type of file to store for an AS2 message.
    description str
    A textual description for the agreement.
    enforce_message_signing AgreementEnforceMessageSigning
    Specifies whether to enforce an AS2 message is signed for this agreement.
    local_profile_id str
    A unique identifier for the local profile.
    partner_profile_id str
    A unique identifier for the partner profile.
    preserve_filename AgreementPreserveFilename
    Specifies whether to preserve the filename received for this agreement.
    status AgreementStatus
    Specifies the status of the agreement.
    tags Sequence[root_Tag]
    Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
    accessRole String
    Specifies the access role for the agreement.
    agreementId String
    A unique identifier for the agreement.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    baseDirectory String
    Specifies the base directory for the agreement.
    customDirectories Property Map
    Specifies a separate directory for each type of file to store for an AS2 message.
    description String
    A textual description for the agreement.
    enforceMessageSigning "ENABLED" | "DISABLED"
    Specifies whether to enforce an AS2 message is signed for this agreement.
    localProfileId String
    A unique identifier for the local profile.
    partnerProfileId String
    A unique identifier for the partner profile.
    preserveFilename "ENABLED" | "DISABLED"
    Specifies whether to preserve the filename received for this agreement.
    status "ACTIVE" | "INACTIVE"
    Specifies the status of the agreement.
    tags List<Property Map>
    Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.

    Supporting Types

    AgreementEnforceMessageSigning

    AgreementPreserveFilename

    AgreementStatus

    CustomDirectoriesProperties

    FailedFilesDirectory string
    Specifies a location to store the failed files for an AS2 message.
    MdnFilesDirectory string
    Specifies a location to store the MDN file for an AS2 message.
    PayloadFilesDirectory string
    Specifies a location to store the payload file for an AS2 message.
    StatusFilesDirectory string
    Specifies a location to store the status file for an AS2 message.
    TemporaryFilesDirectory string
    Specifies a location to store the temporary processing file for an AS2 message.
    FailedFilesDirectory string
    Specifies a location to store the failed files for an AS2 message.
    MdnFilesDirectory string
    Specifies a location to store the MDN file for an AS2 message.
    PayloadFilesDirectory string
    Specifies a location to store the payload file for an AS2 message.
    StatusFilesDirectory string
    Specifies a location to store the status file for an AS2 message.
    TemporaryFilesDirectory string
    Specifies a location to store the temporary processing file for an AS2 message.
    failedFilesDirectory String
    Specifies a location to store the failed files for an AS2 message.
    mdnFilesDirectory String
    Specifies a location to store the MDN file for an AS2 message.
    payloadFilesDirectory String
    Specifies a location to store the payload file for an AS2 message.
    statusFilesDirectory String
    Specifies a location to store the status file for an AS2 message.
    temporaryFilesDirectory String
    Specifies a location to store the temporary processing file for an AS2 message.
    failedFilesDirectory string
    Specifies a location to store the failed files for an AS2 message.
    mdnFilesDirectory string
    Specifies a location to store the MDN file for an AS2 message.
    payloadFilesDirectory string
    Specifies a location to store the payload file for an AS2 message.
    statusFilesDirectory string
    Specifies a location to store the status file for an AS2 message.
    temporaryFilesDirectory string
    Specifies a location to store the temporary processing file for an AS2 message.
    failed_files_directory str
    Specifies a location to store the failed files for an AS2 message.
    mdn_files_directory str
    Specifies a location to store the MDN file for an AS2 message.
    payload_files_directory str
    Specifies a location to store the payload file for an AS2 message.
    status_files_directory str
    Specifies a location to store the status file for an AS2 message.
    temporary_files_directory str
    Specifies a location to store the temporary processing file for an AS2 message.
    failedFilesDirectory String
    Specifies a location to store the failed files for an AS2 message.
    mdnFilesDirectory String
    Specifies a location to store the MDN file for an AS2 message.
    payloadFilesDirectory String
    Specifies a location to store the payload file for an AS2 message.
    statusFilesDirectory String
    Specifies a location to store the status file for an AS2 message.
    temporaryFilesDirectory String
    Specifies a location to store the temporary processing file for an AS2 message.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate