Amazonka.Transfer.ListAgreements

Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.

This operation returns paginated results.

Creating a Request

data ListAgreements

See: newListAgreements smart constructor.

Constructors

ListAgreements'

Fields

• maxResults :: Maybe Natural

  The maximum number of agreements to return.

• nextToken :: Maybe Text

  When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

• serverId :: Text

  The identifier of the server for which you want a list of agreements.

Instances

ToJSON ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

toJSON :: ListAgreements -> Value

toEncoding :: ListAgreements -> Encoding

toJSONList :: [ListAgreements] -> Value

toEncodingList :: [ListAgreements] -> Encoding

ToHeaders ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

toHeaders :: ListAgreements -> [Header]

ToPath ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

toPath :: ListAgreements -> ByteString

ToQuery ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

toQuery :: ListAgreements -> QueryString

AWSPager ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

page :: ListAgreements -> AWSResponse ListAgreements -> Maybe ListAgreements

AWSRequest ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Associated Types

type AWSResponse ListAgreements

Methods

request :: (Service -> Service) -> ListAgreements -> Request ListAgreements

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAgreements -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAgreements)))

Generic ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Associated Types

type Rep ListAgreements :: Type -> Type

Methods

from :: ListAgreements -> Rep ListAgreements x

to :: Rep ListAgreements x -> ListAgreements

Read ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

readsPrec :: Int -> ReadS ListAgreements

readList :: ReadS [ListAgreements]

readPrec :: ReadPrec ListAgreements

readListPrec :: ReadPrec [ListAgreements]

Show ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

showsPrec :: Int -> ListAgreements -> ShowS

show :: ListAgreements -> String

showList :: [ListAgreements] -> ShowS

NFData ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

rnf :: ListAgreements -> ()

Eq ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

(==) :: ListAgreements -> ListAgreements -> Bool

(/=) :: ListAgreements -> ListAgreements -> Bool

Hashable ListAgreements

Defined in Amazonka.Transfer.ListAgreements

Methods

hashWithSalt :: Int -> ListAgreements -> Int

hash :: ListAgreements -> Int

type AWSResponse ListAgreements

Defined in Amazonka.Transfer.ListAgreements

type AWSResponse ListAgreements = ListAgreementsResponse

type Rep ListAgreements

Defined in Amazonka.Transfer.ListAgreements

type Rep ListAgreements = D1 ('MetaData "ListAgreements" "Amazonka.Transfer.ListAgreements" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListAgreements'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListAgreements

Arguments

:: Text

ListAgreements

-> ListAgreements

Create a value of ListAgreements with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListAgreements', listAgreements_maxResults - The maximum number of agreements to return.

ListAgreements, listAgreements_nextToken - When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

ListAgreements, listAgreements_serverId - The identifier of the server for which you want a list of agreements.

Request Lenses

listAgreements_maxResults :: Lens' ListAgreements (Maybe Natural)

The maximum number of agreements to return.

listAgreements_nextToken :: Lens' ListAgreements (Maybe Text)

When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

listAgreements_serverId :: Lens' ListAgreements Text

The identifier of the server for which you want a list of agreements.

Destructuring the Response

data ListAgreementsResponse

See: newListAgreementsResponse smart constructor.

Constructors

ListAgreementsResponse'

Fields

• nextToken :: Maybe Text

  Returns a token that you can use to call ListAgreements again and receive additional results, if there are any.

• httpStatus :: Int

  The response's http status code.

• agreements :: [ListedAgreement]

  Returns an array, where each item contains the details of an agreement.

Instances

Generic ListAgreementsResponse

Defined in Amazonka.Transfer.ListAgreements

Associated Types

type Rep ListAgreementsResponse :: Type -> Type

Methods

from :: ListAgreementsResponse -> Rep ListAgreementsResponse x

to :: Rep ListAgreementsResponse x -> ListAgreementsResponse

Read ListAgreementsResponse

Defined in Amazonka.Transfer.ListAgreements

Methods

readsPrec :: Int -> ReadS ListAgreementsResponse

readList :: ReadS [ListAgreementsResponse]

readPrec :: ReadPrec ListAgreementsResponse

readListPrec :: ReadPrec [ListAgreementsResponse]

Show ListAgreementsResponse

Defined in Amazonka.Transfer.ListAgreements

Methods

showsPrec :: Int -> ListAgreementsResponse -> ShowS

show :: ListAgreementsResponse -> String

showList :: [ListAgreementsResponse] -> ShowS

NFData ListAgreementsResponse

Defined in Amazonka.Transfer.ListAgreements

Methods

rnf :: ListAgreementsResponse -> ()

Eq ListAgreementsResponse

Defined in Amazonka.Transfer.ListAgreements

Methods

(==) :: ListAgreementsResponse -> ListAgreementsResponse -> Bool

(/=) :: ListAgreementsResponse -> ListAgreementsResponse -> Bool

type Rep ListAgreementsResponse

Defined in Amazonka.Transfer.ListAgreements

type Rep ListAgreementsResponse = D1 ('MetaData "ListAgreementsResponse" "Amazonka.Transfer.ListAgreements" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListAgreementsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "agreements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedAgreement]))))

newListAgreementsResponse

Arguments

:: Int

$sel:httpStatus:ListAgreementsResponse'

-> ListAgreementsResponse

Create a value of ListAgreementsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListAgreements, listAgreementsResponse_nextToken - Returns a token that you can use to call ListAgreements again and receive additional results, if there are any.

$sel:httpStatus:ListAgreementsResponse', listAgreementsResponse_httpStatus - The response's http status code.

$sel:agreements:ListAgreementsResponse', listAgreementsResponse_agreements - Returns an array, where each item contains the details of an agreement.

Response Lenses

listAgreementsResponse_nextToken :: Lens' ListAgreementsResponse (Maybe Text)

Returns a token that you can use to call ListAgreements again and receive additional results, if there are any.

listAgreementsResponse_httpStatus :: Lens' ListAgreementsResponse Int

The response's http status code.

listAgreementsResponse_agreements :: Lens' ListAgreementsResponse [ListedAgreement]

Returns an array, where each item contains the details of an agreement.