Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GroundStation.ListContacts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of contacts.

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

This operation returns paginated results.

Synopsis

data ListContacts = ListContacts' {
- missionProfileArn :: Maybe Text
- satelliteArn :: Maybe Text
- nextToken :: Maybe Text
- groundStation :: Maybe Text
- maxResults :: Maybe Int
- endTime :: POSIX
- startTime :: POSIX
- statusList :: [ContactStatus]
}
newListContacts :: UTCTime -> UTCTime -> ListContacts
listContacts_missionProfileArn :: Lens' ListContacts (Maybe Text)
listContacts_satelliteArn :: Lens' ListContacts (Maybe Text)
listContacts_nextToken :: Lens' ListContacts (Maybe Text)
listContacts_groundStation :: Lens' ListContacts (Maybe Text)
listContacts_maxResults :: Lens' ListContacts (Maybe Int)
listContacts_endTime :: Lens' ListContacts UTCTime
listContacts_startTime :: Lens' ListContacts UTCTime
listContacts_statusList :: Lens' ListContacts [ContactStatus]
data ListContactsResponse = ListContactsResponse' {
- contactList :: Maybe [ContactData]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListContactsResponse :: Int -> ListContactsResponse
listContactsResponse_contactList :: Lens' ListContactsResponse (Maybe [ContactData])
listContactsResponse_nextToken :: Lens' ListContactsResponse (Maybe Text)
listContactsResponse_httpStatus :: Lens' ListContactsResponse Int

Creating a Request

data ListContacts Source #

See: newListContacts smart constructor.

Constructors

ListContacts'

Fields

missionProfileArn :: Maybe Text
ARN of a mission profile.
satelliteArn :: Maybe Text
ARN of a satellite.
nextToken :: Maybe Text
Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
groundStation :: Maybe Text
Name of a ground station.
maxResults :: Maybe Int
Maximum number of contacts returned.
endTime :: POSIX
End time of a contact.
startTime :: POSIX
Start time of a contact.
statusList :: [ContactStatus]
Status of a contact reservation.

Instances

Instances details

Eq ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods (==) :: ListContacts -> ListContacts -> Bool # (/=) :: ListContacts -> ListContacts -> Bool #
Read ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods readsPrec :: Int -> ReadS ListContacts # readList :: ReadS [ListContacts] # readPrec :: ReadPrec ListContacts # readListPrec :: ReadPrec [ListContacts] #
Show ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods showsPrec :: Int -> ListContacts -> ShowS # show :: ListContacts -> String # showList :: [ListContacts] -> ShowS #
Generic ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Associated Types type Rep ListContacts :: Type -> Type # Methods from :: ListContacts -> Rep ListContacts x # to :: Rep ListContacts x -> ListContacts #
NFData ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods rnf :: ListContacts -> () #
Hashable ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods hashWithSalt :: Int -> ListContacts -> Int # hash :: ListContacts -> Int #
ToJSON ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods toJSON :: ListContacts -> Value # toEncoding :: ListContacts -> Encoding # toJSONList :: [ListContacts] -> Value # toEncodingList :: [ListContacts] -> Encoding #
AWSPager ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods page :: ListContacts -> AWSResponse ListContacts -> Maybe ListContacts #
AWSRequest ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Associated Types type AWSResponse ListContacts # Methods request :: ListContacts -> Request ListContacts # response :: MonadResource m => Logger -> Service -> Proxy ListContacts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListContacts))) #
ToHeaders ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods toHeaders :: ListContacts -> [Header] #
ToPath ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods toPath :: ListContacts -> ByteString #
ToQuery ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods toQuery :: ListContacts -> QueryString #
type Rep ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts type Rep ListContacts = D1 ('MetaData "ListContacts" "Amazonka.GroundStation.ListContacts" "libZSservicesZSamazonka-groundstationZSamazonka-groundstation" 'False) (C1 ('MetaCons "ListContacts'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "missionProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "satelliteArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "groundStation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "statusList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ContactStatus])))))
type AWSResponse ListContacts Source #
Instance details Defined in Amazonka.GroundStation.ListContacts type AWSResponse ListContacts = ListContactsResponse

newListContacts Source #

Arguments

:: UTCTime	`$sel:endTime:ListContacts'`
-> UTCTime	`$sel:startTime:ListContacts'`
-> ListContacts

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:

$sel:missionProfileArn:ListContacts', listContacts_missionProfileArn - ARN of a mission profile.

$sel:satelliteArn:ListContacts', listContacts_satelliteArn - ARN of a satellite.

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

$sel:groundStation:ListContacts', listContacts_groundStation - Name of a ground station.

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

$sel:endTime:ListContacts', listContacts_endTime - End time of a contact.

$sel:startTime:ListContacts', listContacts_startTime - Start time of a contact.

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

Request Lenses

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

ARN of a mission profile.

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

ARN of a satellite.

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_groundStation :: Lens' ListContacts (Maybe Text) Source #

Name of a ground station.

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

Maximum number of contacts returned.

listContacts_endTime :: Lens' ListContacts UTCTime Source #

End time of a contact.

listContacts_startTime :: Lens' ListContacts UTCTime Source #

Start time of a contact.

listContacts_statusList :: Lens' ListContacts [ContactStatus] Source #

Status of a contact reservation.

Destructuring the Response

data ListContactsResponse Source #

See: newListContactsResponse smart constructor.

Constructors

ListContactsResponse'
Fields contactList :: Maybe [ContactData] List of contacts. nextToken :: Maybe Text Next token returned in the response of a previous `ListContacts` call. Used to get the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListContactsResponse Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods (==) :: ListContactsResponse -> ListContactsResponse -> Bool # (/=) :: ListContactsResponse -> ListContactsResponse -> Bool #
Read ListContactsResponse Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods readsPrec :: Int -> ReadS ListContactsResponse # readList :: ReadS [ListContactsResponse] # readPrec :: ReadPrec ListContactsResponse # readListPrec :: ReadPrec [ListContactsResponse] #
Show ListContactsResponse Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods showsPrec :: Int -> ListContactsResponse -> ShowS # show :: ListContactsResponse -> String # showList :: [ListContactsResponse] -> ShowS #
Generic ListContactsResponse Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Associated Types type Rep ListContactsResponse :: Type -> Type # Methods from :: ListContactsResponse -> Rep ListContactsResponse x # to :: Rep ListContactsResponse x -> ListContactsResponse #
NFData ListContactsResponse Source #
Instance details Defined in Amazonka.GroundStation.ListContacts Methods rnf :: ListContactsResponse -> () #
type Rep ListContactsResponse Source #
Instance details Defined in Amazonka.GroundStation.ListContacts type Rep ListContactsResponse = D1 ('MetaData "ListContactsResponse" "Amazonka.GroundStation.ListContacts" "libZSservicesZSamazonka-groundstationZSamazonka-groundstation" '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 #

Arguments

:: Int	`$sel:httpStatus:ListContactsResponse'`
-> ListContactsResponse

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.

$sel:nextToken: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_contactList :: Lens' ListContactsResponse (Maybe [ContactData]) Source #

List of contacts.

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.

listContactsResponse_httpStatus :: Lens' ListContactsResponse Int Source #

The response's http status code.