transfer:DescribeAgreement

Read

transfer:DescribeAgreement is a Read access-level action in the transfer service. Grants permission to describe an agreement assigned to a server

Resource types

ARNs that transfer:DescribeAgreement can be scoped to in an IAM policy.

arn:${Partition}:transfer:${Region}:${Account}:agreement/${ServerId}/${AgreementId}

agreement

Condition keys

Keys you can use in the Condition block of a policy that grants transfer:DescribeAgreement.

aws:ResourceTag/${TagKey} String

Filters access by the tags associated with the resource

Example IAM policy

A minimal policy that allows transfer:DescribeAgreement. Replace "Resource": "*" with a specific ARN to follow least privilege.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowTransferDescribeAgreement",
      "Effect": "Allow",
      "Action": "transfer:DescribeAgreement",
      "Resource": "*"
    }
  ]
}

Related actions in transfer

transfer:CreateAccess Write transfer:CreateAgreement Write transfer:CreateConnector Write transfer:CreateProfile Write transfer:CreateServer Write transfer:CreateUser Write transfer:CreateWebApp Write transfer:CreateWorkflow Write transfer:DeleteAccess Write transfer:DeleteAgreement Write transfer:DeleteCertificate Write transfer:DeleteConnector Write

View all transfer actions →