Amazonka.GroundStation.ListContacts

Returns a list of contacts.

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

This operation returns paginated results.

Creating a Request

data ListContacts

See: newListContacts smart constructor.

Constructors

ListContacts'

Fields

• groundStation :: Maybe Text

  Name of a ground station.

• maxResults :: Maybe Natural

  Maximum number of contacts returned.

• missionProfileArn :: Maybe Text

  ARN of a mission profile.

• nextToken :: Maybe Text

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

• satelliteArn :: Maybe Text

  ARN of a satellite.

• endTime :: POSIX

  End time of a contact in UTC.

• startTime :: POSIX

  Start time of a contact in UTC.

• statusList :: [ContactStatus]

  Status of a contact reservation.

Instances

ToJSON ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

toJSON :: ListContacts -> Value

toEncoding :: ListContacts -> Encoding

toJSONList :: [ListContacts] -> Value

toEncodingList :: [ListContacts] -> Encoding

ToHeaders ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

toHeaders :: ListContacts -> [Header]

ToPath ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

toPath :: ListContacts -> ByteString

ToQuery ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

toQuery :: ListContacts -> QueryString

AWSPager ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

page :: ListContacts -> AWSResponse ListContacts -> Maybe ListContacts

AWSRequest ListContacts

Defined in Amazonka.GroundStation.ListContacts

Associated Types

type AWSResponse ListContacts

Methods

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

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

Generic ListContacts

Defined in Amazonka.GroundStation.ListContacts

Associated Types

type Rep ListContacts :: Type -> Type

Methods

from :: ListContacts -> Rep ListContacts x

to :: Rep ListContacts x -> ListContacts

Read ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

readsPrec :: Int -> ReadS ListContacts

readList :: ReadS [ListContacts]

readPrec :: ReadPrec ListContacts

readListPrec :: ReadPrec [ListContacts]

Show ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

showsPrec :: Int -> ListContacts -> ShowS

show :: ListContacts -> String

showList :: [ListContacts] -> ShowS

NFData ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

rnf :: ListContacts -> ()

Eq ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

(==) :: ListContacts -> ListContacts -> Bool

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

Hashable ListContacts

Defined in Amazonka.GroundStation.ListContacts

Methods

hashWithSalt :: Int -> ListContacts -> Int

hash :: ListContacts -> Int

type AWSResponse ListContacts

Defined in Amazonka.GroundStation.ListContacts

type AWSResponse ListContacts = ListContactsResponse

type Rep ListContacts

Defined in Amazonka.GroundStation.ListContacts

type Rep ListContacts = D1 ('MetaData "ListContacts" "Amazonka.GroundStation.ListContacts" "amazonka-groundstation-2.0-CCmZVFTDcPRGN6Gwr7o4th" 'False) (C1 ('MetaCons "ListContacts'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "groundStation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "missionProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "satelliteArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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])))))

newListContacts

Arguments

:: UTCTime

ListContacts

-> UTCTime

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:

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

Name of a ground station.

listContacts_maxResults :: Lens' ListContacts (Maybe Natural)

Maximum number of contacts returned.

listContacts_missionProfileArn :: Lens' ListContacts (Maybe Text)

ARN of a mission profile.

listContacts_nextToken :: Lens' ListContacts (Maybe Text)

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

listContacts_satelliteArn :: Lens' ListContacts (Maybe Text)

ARN of a satellite.

listContacts_endTime :: Lens' ListContacts UTCTime

End time of a contact in UTC.

listContacts_startTime :: Lens' ListContacts UTCTime

Start time of a contact in UTC.

listContacts_statusList :: Lens' ListContacts [ContactStatus]

Status of a contact reservation.

Destructuring the Response

data ListContactsResponse

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

Generic ListContactsResponse

Defined in Amazonka.GroundStation.ListContacts

Associated Types

type Rep ListContactsResponse :: Type -> Type

Methods

from :: ListContactsResponse -> Rep ListContactsResponse x

to :: Rep ListContactsResponse x -> ListContactsResponse

Read ListContactsResponse

Defined in Amazonka.GroundStation.ListContacts

Methods

readsPrec :: Int -> ReadS ListContactsResponse

readList :: ReadS [ListContactsResponse]

readPrec :: ReadPrec ListContactsResponse

readListPrec :: ReadPrec [ListContactsResponse]

Show ListContactsResponse

Defined in Amazonka.GroundStation.ListContacts

Methods

showsPrec :: Int -> ListContactsResponse -> ShowS

show :: ListContactsResponse -> String

showList :: [ListContactsResponse] -> ShowS

NFData ListContactsResponse

Defined in Amazonka.GroundStation.ListContacts

Methods

rnf :: ListContactsResponse -> ()

Eq ListContactsResponse

Defined in Amazonka.GroundStation.ListContacts

Methods

(==) :: ListContactsResponse -> ListContactsResponse -> Bool

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

type Rep ListContactsResponse

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

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.

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])

List of contacts.

listContactsResponse_nextToken :: Lens' ListContactsResponse (Maybe Text)

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

listContactsResponse_httpStatus :: Lens' ListContactsResponse Int

The response's http status code.