amazonka-groundstation-2.0: Amazon Ground Station SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GroundStation.ListContacts

Description

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.

This operation returns paginated results.

Synopsis

Creating a Request

data ListContacts Source #

See: newListContacts smart constructor.

Constructors

ListContacts' 

Fields

Instances

Instances details
ToJSON ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

ToHeaders ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

ToPath ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

ToQuery ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

AWSPager ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

AWSRequest ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

Associated Types

type AWSResponse ListContacts #

Generic ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

Associated Types

type Rep ListContacts :: Type -> Type #

Read ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

Show ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

NFData ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

Methods

rnf :: ListContacts -> () #

Eq ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

Hashable ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

type AWSResponse ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

type Rep ListContacts Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

newListContacts Source #

Create a value of ListContacts 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:

ListContacts, listContacts_groundStation - Name of a ground station.

$sel:maxResults:ListContacts', listContacts_maxResults - Maximum number of contacts returned.

ListContacts, listContacts_missionProfileArn - ARN of a mission profile.

ListContacts, listContacts_nextToken - Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

ListContacts, listContacts_satelliteArn - ARN of a satellite.

ListContacts, listContacts_endTime - End time of a contact in UTC.

ListContacts, listContacts_startTime - Start time of a contact in UTC.

$sel:statusList:ListContacts', listContacts_statusList - Status of a contact reservation.

Request Lenses

listContacts_maxResults :: Lens' ListContacts (Maybe Natural) Source #

Maximum number of contacts returned.

listContacts_nextToken :: Lens' ListContacts (Maybe Text) Source #

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

listContacts_endTime :: Lens' ListContacts UTCTime Source #

End time of a contact in UTC.

listContacts_startTime :: Lens' ListContacts UTCTime Source #

Start time of a contact in UTC.

listContacts_statusList :: Lens' ListContacts [ContactStatus] Source #

Status of a contact reservation.

Destructuring the Response

data ListContactsResponse Source #

See: newListContactsResponse smart constructor.

Constructors

ListContactsResponse' 

Fields

Instances

Instances details
Generic ListContactsResponse Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

Associated Types

type Rep ListContactsResponse :: Type -> Type #

Read ListContactsResponse Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

Show ListContactsResponse Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

NFData ListContactsResponse Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

Methods

rnf :: ListContactsResponse -> () #

Eq ListContactsResponse Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

type Rep ListContactsResponse Source # 
Instance details

Defined in Amazonka.GroundStation.ListContacts

type Rep ListContactsResponse = D1 ('MetaData "ListContactsResponse" "Amazonka.GroundStation.ListContacts" "amazonka-groundstation-2.0-CCmZVFTDcPRGN6Gwr7o4th" 'False) (C1 ('MetaCons "ListContactsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contactList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContactData])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListContactsResponse Source #

Create a value of ListContactsResponse 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:contactList:ListContactsResponse', listContactsResponse_contactList - List of contacts.

ListContacts, listContactsResponse_nextToken - Next token returned in the response of a previous ListContacts call. Used to get the next page of results.

$sel:httpStatus:ListContactsResponse', listContactsResponse_httpStatus - The response's http status code.

Response Lenses

listContactsResponse_nextToken :: Lens' ListContactsResponse (Maybe Text) Source #

Next token returned in the response of a previous ListContacts call. Used to get the next page of results.