Amazonka.RAM.ListResourceTypes

Lists the resource types that can be shared by RAM.

Creating a Request

data ListResourceTypes

See: newListResourceTypes smart constructor.

Constructors

ListResourceTypes'

Fields

• maxResults :: Maybe Natural

  Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

• nextToken :: Maybe Text

  Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

• resourceRegionScope :: Maybe ResourceRegionScopeFilter

  Specifies that you want the results to include only resources that have the specified scope.

  • ALL – the results include both global and regional resources or resource types.
  • GLOBAL – the results include only global resources or resource types.
  • REGIONAL – the results include only regional resources or resource types.

  The default value is ALL.

Instances

ToJSON ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Methods

toJSON :: ListResourceTypes -> Value

toEncoding :: ListResourceTypes -> Encoding

toJSONList :: [ListResourceTypes] -> Value

toEncodingList :: [ListResourceTypes] -> Encoding

ToHeaders ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Methods

toHeaders :: ListResourceTypes -> [Header]

ToPath ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Methods

toPath :: ListResourceTypes -> ByteString

ToQuery ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Methods

toQuery :: ListResourceTypes -> QueryString

AWSRequest ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Associated Types

type AWSResponse ListResourceTypes

Methods

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

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

Generic ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Associated Types

type Rep ListResourceTypes :: Type -> Type

Methods

from :: ListResourceTypes -> Rep ListResourceTypes x

to :: Rep ListResourceTypes x -> ListResourceTypes

Read ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Methods

readsPrec :: Int -> ReadS ListResourceTypes

readList :: ReadS [ListResourceTypes]

readPrec :: ReadPrec ListResourceTypes

readListPrec :: ReadPrec [ListResourceTypes]

Show ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Methods

showsPrec :: Int -> ListResourceTypes -> ShowS

show :: ListResourceTypes -> String

showList :: [ListResourceTypes] -> ShowS

NFData ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Methods

rnf :: ListResourceTypes -> ()

Eq ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Methods

(==) :: ListResourceTypes -> ListResourceTypes -> Bool

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

Hashable ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

Methods

hashWithSalt :: Int -> ListResourceTypes -> Int

hash :: ListResourceTypes -> Int

type AWSResponse ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

type AWSResponse ListResourceTypes = ListResourceTypesResponse

type Rep ListResourceTypes

Defined in Amazonka.RAM.ListResourceTypes

type Rep ListResourceTypes = D1 ('MetaData "ListResourceTypes" "Amazonka.RAM.ListResourceTypes" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "ListResourceTypes'" '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 "resourceRegionScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceRegionScopeFilter)))))

newListResourceTypes :: ListResourceTypes

Create a value of ListResourceTypes 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:ListResourceTypes', listResourceTypes_maxResults - Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

ListResourceTypes, listResourceTypes_nextToken - Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

ListResourceTypes, listResourceTypes_resourceRegionScope - Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.
• GLOBAL – the results include only global resources or resource types.
• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

Request Lenses

listResourceTypes_maxResults :: Lens' ListResourceTypes (Maybe Natural)

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listResourceTypes_nextToken :: Lens' ListResourceTypes (Maybe Text)

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

listResourceTypes_resourceRegionScope :: Lens' ListResourceTypes (Maybe ResourceRegionScopeFilter)

Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.
• GLOBAL – the results include only global resources or resource types.
• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

Destructuring the Response

data ListResourceTypesResponse

See: newListResourceTypesResponse smart constructor.

Constructors

ListResourceTypesResponse'

Fields

• nextToken :: Maybe Text

  If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

• resourceTypes :: Maybe [ServiceNameAndResourceType]

  An array of objects that contain information about the resource types that can be shared using RAM.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListResourceTypesResponse

Defined in Amazonka.RAM.ListResourceTypes

Associated Types

type Rep ListResourceTypesResponse :: Type -> Type

Methods

from :: ListResourceTypesResponse -> Rep ListResourceTypesResponse x

to :: Rep ListResourceTypesResponse x -> ListResourceTypesResponse

Read ListResourceTypesResponse

Defined in Amazonka.RAM.ListResourceTypes

Methods

readsPrec :: Int -> ReadS ListResourceTypesResponse

readList :: ReadS [ListResourceTypesResponse]

readPrec :: ReadPrec ListResourceTypesResponse

readListPrec :: ReadPrec [ListResourceTypesResponse]

Show ListResourceTypesResponse

Defined in Amazonka.RAM.ListResourceTypes

Methods

showsPrec :: Int -> ListResourceTypesResponse -> ShowS

show :: ListResourceTypesResponse -> String

showList :: [ListResourceTypesResponse] -> ShowS

NFData ListResourceTypesResponse

Defined in Amazonka.RAM.ListResourceTypes

Methods

rnf :: ListResourceTypesResponse -> ()

Eq ListResourceTypesResponse

Defined in Amazonka.RAM.ListResourceTypes

Methods

(==) :: ListResourceTypesResponse -> ListResourceTypesResponse -> Bool

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

type Rep ListResourceTypesResponse

Defined in Amazonka.RAM.ListResourceTypes

type Rep ListResourceTypesResponse = D1 ('MetaData "ListResourceTypesResponse" "Amazonka.RAM.ListResourceTypes" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "ListResourceTypesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceNameAndResourceType])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListResourceTypesResponse

Arguments

:: Int

$sel:httpStatus:ListResourceTypesResponse'

-> ListResourceTypesResponse

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

ListResourceTypes, listResourceTypesResponse_nextToken - If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

$sel:resourceTypes:ListResourceTypesResponse', listResourceTypesResponse_resourceTypes - An array of objects that contain information about the resource types that can be shared using RAM.

$sel:httpStatus:ListResourceTypesResponse', listResourceTypesResponse_httpStatus - The response's http status code.

Response Lenses

listResourceTypesResponse_nextToken :: Lens' ListResourceTypesResponse (Maybe Text)

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

listResourceTypesResponse_resourceTypes :: Lens' ListResourceTypesResponse (Maybe [ServiceNameAndResourceType])

An array of objects that contain information about the resource types that can be shared using RAM.

listResourceTypesResponse_httpStatus :: Lens' ListResourceTypesResponse Int

The response's http status code.