Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoT.ListSecurityProfiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.

Requires permission to access the ListSecurityProfiles action.

dimensionName and metricName cannot be used in the same request.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSecurityProfiles Source #

See: newListSecurityProfiles smart constructor.

Constructors

ListSecurityProfiles'
Fields dimensionName :: Maybe Text A filter to limit results to the security profiles that use the defined dimension. Cannot be used with `metricName` maxResults :: Maybe Natural The maximum number of results to return at one time. metricName :: Maybe Text The name of the custom metric. Cannot be used with `dimensionName`. nextToken :: Maybe Text The token for the next set of results.

Instances

Instances details

ToHeaders ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods toHeaders :: ListSecurityProfiles -> [Header] #
ToPath ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods toPath :: ListSecurityProfiles -> ByteString #
ToQuery ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods toQuery :: ListSecurityProfiles -> QueryString #
AWSPager ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods page :: ListSecurityProfiles -> AWSResponse ListSecurityProfiles -> Maybe ListSecurityProfiles #
AWSRequest ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Associated Types type AWSResponse ListSecurityProfiles # Methods request :: (Service -> Service) -> ListSecurityProfiles -> Request ListSecurityProfiles # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSecurityProfiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSecurityProfiles))) #
Generic ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Associated Types type Rep ListSecurityProfiles :: Type -> Type # Methods from :: ListSecurityProfiles -> Rep ListSecurityProfiles x # to :: Rep ListSecurityProfiles x -> ListSecurityProfiles #
Read ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods readsPrec :: Int -> ReadS ListSecurityProfiles # readList :: ReadS [ListSecurityProfiles] # readPrec :: ReadPrec ListSecurityProfiles # readListPrec :: ReadPrec [ListSecurityProfiles] #
Show ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods showsPrec :: Int -> ListSecurityProfiles -> ShowS # show :: ListSecurityProfiles -> String # showList :: [ListSecurityProfiles] -> ShowS #
NFData ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods rnf :: ListSecurityProfiles -> () #
Eq ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods (==) :: ListSecurityProfiles -> ListSecurityProfiles -> Bool # (/=) :: ListSecurityProfiles -> ListSecurityProfiles -> Bool #
Hashable ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods hashWithSalt :: Int -> ListSecurityProfiles -> Int # hash :: ListSecurityProfiles -> Int #
type AWSResponse ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles type AWSResponse ListSecurityProfiles = ListSecurityProfilesResponse
type Rep ListSecurityProfiles Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles type Rep ListSecurityProfiles = D1 ('MetaData "ListSecurityProfiles" "Amazonka.IoT.ListSecurityProfiles" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListSecurityProfiles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dimensionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListSecurityProfiles :: ListSecurityProfiles Source #

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

ListSecurityProfiles, listSecurityProfiles_dimensionName - A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName

$sel:maxResults:ListSecurityProfiles', listSecurityProfiles_maxResults - The maximum number of results to return at one time.

ListSecurityProfiles, listSecurityProfiles_metricName - The name of the custom metric. Cannot be used with dimensionName.

ListSecurityProfiles, listSecurityProfiles_nextToken - The token for the next set of results.

Request Lenses

listSecurityProfiles_dimensionName :: Lens' ListSecurityProfiles (Maybe Text) Source #

A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName

listSecurityProfiles_maxResults :: Lens' ListSecurityProfiles (Maybe Natural) Source #

The maximum number of results to return at one time.

listSecurityProfiles_metricName :: Lens' ListSecurityProfiles (Maybe Text) Source #

The name of the custom metric. Cannot be used with dimensionName.

listSecurityProfiles_nextToken :: Lens' ListSecurityProfiles (Maybe Text) Source #

The token for the next set of results.

Destructuring the Response

data ListSecurityProfilesResponse Source #

See: newListSecurityProfilesResponse smart constructor.

Constructors

ListSecurityProfilesResponse'
Fields nextToken :: Maybe Text A token that can be used to retrieve the next set of results, or `null` if there are no additional results. securityProfileIdentifiers :: Maybe [SecurityProfileIdentifier] A list of security profile identifiers (names and ARNs). httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListSecurityProfilesResponse Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Associated Types type Rep ListSecurityProfilesResponse :: Type -> Type # Methods from :: ListSecurityProfilesResponse -> Rep ListSecurityProfilesResponse x # to :: Rep ListSecurityProfilesResponse x -> ListSecurityProfilesResponse #
Read ListSecurityProfilesResponse Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods readsPrec :: Int -> ReadS ListSecurityProfilesResponse # readList :: ReadS [ListSecurityProfilesResponse] # readPrec :: ReadPrec ListSecurityProfilesResponse # readListPrec :: ReadPrec [ListSecurityProfilesResponse] #
Show ListSecurityProfilesResponse Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods showsPrec :: Int -> ListSecurityProfilesResponse -> ShowS # show :: ListSecurityProfilesResponse -> String # showList :: [ListSecurityProfilesResponse] -> ShowS #
NFData ListSecurityProfilesResponse Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods rnf :: ListSecurityProfilesResponse -> () #
Eq ListSecurityProfilesResponse Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles Methods (==) :: ListSecurityProfilesResponse -> ListSecurityProfilesResponse -> Bool # (/=) :: ListSecurityProfilesResponse -> ListSecurityProfilesResponse -> Bool #
type Rep ListSecurityProfilesResponse Source #
Instance details Defined in Amazonka.IoT.ListSecurityProfiles type Rep ListSecurityProfilesResponse = D1 ('MetaData "ListSecurityProfilesResponse" "Amazonka.IoT.ListSecurityProfiles" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListSecurityProfilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityProfileIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SecurityProfileIdentifier])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSecurityProfilesResponse Source #

Arguments

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

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

ListSecurityProfiles, listSecurityProfilesResponse_nextToken - A token that can be used to retrieve the next set of results, or null if there are no additional results.

$sel:securityProfileIdentifiers:ListSecurityProfilesResponse', listSecurityProfilesResponse_securityProfileIdentifiers - A list of security profile identifiers (names and ARNs).

$sel:httpStatus:ListSecurityProfilesResponse', listSecurityProfilesResponse_httpStatus - The response's http status code.

Response Lenses

listSecurityProfilesResponse_nextToken :: Lens' ListSecurityProfilesResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listSecurityProfilesResponse_securityProfileIdentifiers :: Lens' ListSecurityProfilesResponse (Maybe [SecurityProfileIdentifier]) Source #

A list of security profile identifiers (names and ARNs).

listSecurityProfilesResponse_httpStatus :: Lens' ListSecurityProfilesResponse Int Source #

The response's http status code.