Amazonka.SSOAdmin.ListInstances

Lists the IAM Identity Center instances that the caller has access to.

This operation returns paginated results.

Creating a Request

data ListInstances

See: newListInstances smart constructor.

Constructors

ListInstances'

Fields

• maxResults :: Maybe Natural

  The maximum number of results to display for the instance.

• nextToken :: Maybe Text

  The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Instances

ToJSON ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

toJSON :: ListInstances -> Value

toEncoding :: ListInstances -> Encoding

toJSONList :: [ListInstances] -> Value

toEncodingList :: [ListInstances] -> Encoding

ToHeaders ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

toHeaders :: ListInstances -> [Header]

ToPath ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

toPath :: ListInstances -> ByteString

ToQuery ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

toQuery :: ListInstances -> QueryString

AWSPager ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

page :: ListInstances -> AWSResponse ListInstances -> Maybe ListInstances

AWSRequest ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Associated Types

type AWSResponse ListInstances

Methods

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

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

Generic ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Associated Types

type Rep ListInstances :: Type -> Type

Methods

from :: ListInstances -> Rep ListInstances x

to :: Rep ListInstances x -> ListInstances

Read ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

readsPrec :: Int -> ReadS ListInstances

readList :: ReadS [ListInstances]

readPrec :: ReadPrec ListInstances

readListPrec :: ReadPrec [ListInstances]

Show ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

showsPrec :: Int -> ListInstances -> ShowS

show :: ListInstances -> String

showList :: [ListInstances] -> ShowS

NFData ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

rnf :: ListInstances -> ()

Eq ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

(==) :: ListInstances -> ListInstances -> Bool

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

Hashable ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

Methods

hashWithSalt :: Int -> ListInstances -> Int

hash :: ListInstances -> Int

type AWSResponse ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

type AWSResponse ListInstances = ListInstancesResponse

type Rep ListInstances

Defined in Amazonka.SSOAdmin.ListInstances

type Rep ListInstances = D1 ('MetaData "ListInstances" "Amazonka.SSOAdmin.ListInstances" "amazonka-sso-admin-2.0-HhKPJAnDdA18B4mnMjNqZF" 'False) (C1 ('MetaCons "ListInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListInstances :: ListInstances

Create a value of ListInstances 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:ListInstances', listInstances_maxResults - The maximum number of results to display for the instance.

ListInstances, listInstances_nextToken - The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Request Lenses

listInstances_maxResults :: Lens' ListInstances (Maybe Natural)

The maximum number of results to display for the instance.

listInstances_nextToken :: Lens' ListInstances (Maybe Text)

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Destructuring the Response

data ListInstancesResponse

See: newListInstancesResponse smart constructor.

Constructors

ListInstancesResponse'

Fields

• instances :: Maybe [InstanceMetadata]

  Lists the IAM Identity Center instances that the caller has access to.

• nextToken :: Maybe Text

  The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListInstancesResponse

Defined in Amazonka.SSOAdmin.ListInstances

Associated Types

type Rep ListInstancesResponse :: Type -> Type

Methods

from :: ListInstancesResponse -> Rep ListInstancesResponse x

to :: Rep ListInstancesResponse x -> ListInstancesResponse

Read ListInstancesResponse

Defined in Amazonka.SSOAdmin.ListInstances

Methods

readsPrec :: Int -> ReadS ListInstancesResponse

readList :: ReadS [ListInstancesResponse]

readPrec :: ReadPrec ListInstancesResponse

readListPrec :: ReadPrec [ListInstancesResponse]

Show ListInstancesResponse

Defined in Amazonka.SSOAdmin.ListInstances

Methods

showsPrec :: Int -> ListInstancesResponse -> ShowS

show :: ListInstancesResponse -> String

showList :: [ListInstancesResponse] -> ShowS

NFData ListInstancesResponse

Defined in Amazonka.SSOAdmin.ListInstances

Methods

rnf :: ListInstancesResponse -> ()

Eq ListInstancesResponse

Defined in Amazonka.SSOAdmin.ListInstances

Methods

(==) :: ListInstancesResponse -> ListInstancesResponse -> Bool

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

type Rep ListInstancesResponse

Defined in Amazonka.SSOAdmin.ListInstances

type Rep ListInstancesResponse = D1 ('MetaData "ListInstancesResponse" "Amazonka.SSOAdmin.ListInstances" "amazonka-sso-admin-2.0-HhKPJAnDdA18B4mnMjNqZF" 'False) (C1 ('MetaCons "ListInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceMetadata])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListInstancesResponse

Arguments

:: Int

$sel:httpStatus:ListInstancesResponse'

-> ListInstancesResponse

Create a value of ListInstancesResponse 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:instances:ListInstancesResponse', listInstancesResponse_instances - Lists the IAM Identity Center instances that the caller has access to.

ListInstances, listInstancesResponse_nextToken - The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

$sel:httpStatus:ListInstancesResponse', listInstancesResponse_httpStatus - The response's http status code.

Response Lenses

listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [InstanceMetadata])

Lists the IAM Identity Center instances that the caller has access to.

listInstancesResponse_nextToken :: Lens' ListInstancesResponse (Maybe Text)

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int

The response's http status code.